dellemc.openmanage.idrac_lifecycle_controller_jobs 模块 – 删除生命周期控制器作业

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

如果您正在使用 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定：dellemc.openmanage.idrac_lifecycle_controller_jobs。

dellemc.openmanage 2.1.0 中的新增功能

摘要

  • 使用其作业 ID 删除生命周期控制器作业或删除所有作业。

要求

执行此模块的主机需要以下要求。

  • omsdk >= 1.2.488

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。

idrac_ip

字符串 / 必需

iDRAC IP 地址。

idrac_password

别名：idrac_pwd

字符串 / 必需

iDRAC 用户密码。

如果未提供密码，则使用环境变量 IDRAC_PASSWORD。

示例：export IDRAC_PASSWORD=password

idrac_port

整数

iDRAC 端口。

默认值： 443

idrac_user

字符串 / 必需

iDRAC 用户名。

如果未提供用户名，则使用环境变量 IDRAC_USERNAME。

示例：export IDRAC_USERNAME=username

job_id

字符串

要删除的特定作业的作业 ID。

如果未指定此选项，则会删除作业队列中的所有作业。

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

以秒为单位的套接字级别超时。

默认值： 30

validate_certs

布尔值

在 dellemc.openmanage 5.0.0 中添加

如果为 false，则不会验证 SSL 证书。

仅在使用自签名证书的个人控制站点上配置 false。

在集合版本 5.0.0 之前，validate_certs 默认值为 false。

选项

  • false

  • true ← (默认)

注释

注意

  • 从此模块可以直接访问 Dell iDRAC 的系统运行此模块。

  • 此模块支持 idrac_ip 的 IPv4 和 IPv6 地址。

  • 此模块不支持 check_mode。

示例

---
- name: Delete Lifecycle Controller job queue
  dellemc.openmanage.idrac_lifecycle_controller_jobs:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"

- name: Delete Lifecycle Controller job using a job ID
  dellemc.openmanage.idrac_lifecycle_controller_jobs:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       job_id: "JID_801841929470"

返回值

常用的返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

error_info

字典

HTTP 错误的详细信息。

返回：HTTP 错误时

示例： {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

字符串

删除操作的状态。

返回：始终

示例： "Successfully deleted the job."

status

字典

删除操作的详细信息。

返回：成功

示例： {"Message": "指定的作业已删除", "MessageID": "SUP020", "ReturnValue": "0"}

作者

  • Felix Stephen (@felixs88)

  • Anooja Vardhineni (@anooja-vardhineni)