dellemc.openmanage.ome_devices 模块 – 在目标设备上执行特定于设备的操作

注意

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

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：dellemc.openmanage.ome_devices。

dellemc.openmanage 6.1.0 中的新增功能

概要

• 执行特定于设备的操作，例如刷新清单、清除 iDRAC 作业队列以及从 OpenManage Enterprise 重置 iDRAC。

要求

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

• python >= 3.9.6

参数

参数	注释
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
device_action 字符串	refresh_inventory 刷新目标设备上的清单。 reset_idrac 触发目标 iDRAC 上的重置。 clear_idrac_job_queue 清除目标 iDRAC 上的作业队列。 为每个操作触发一个作业。 选项 "refresh_inventory" ← (默认) "reset_idrac" "clear_idrac_job_queue"
device_ids 列表 / 元素=整数	目标设备的 ID。 这与 device_service_tags 互斥。
device_service_tags 列表 / 元素=字符串	目标设备的服务标签。 这与 device_ids 互斥。
hostname 字符串 / 必需	OpenManage Enterprise IP 地址或主机名。
job_description 字符串	作业的可选描述。
job_name 字符串	作业的可选名称。
job_schedule 字符串	提供 cron 字符串来安排作业。 默认值： "startnow"
job_wait 布尔值	提供等待作业完成的选项。 当 state 为 present 时，此选项适用。 当 job_schedule 为 startnow 时，此选项适用。 选项 false true ← (默认)
job_wait_timeout 整数	job_wait 的最大等待时间（以秒为单位）。仅在此持续时间内跟踪作业。 当 job_wait 为 true 时，此选项适用。 默认值： 1200
password 字符串	OpenManage Enterprise 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise HTTPS 端口。 默认值： 443
state 字符串	present 允许在目标设备上执行 device_action。 absent 从 OpenManage Enterprise 中删除设备。不触发作业。job_wait、job_schedule、job_name 和 job_description 不适用于此操作。 选项 "present" ← (默认) "absent"
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（以秒为单位）。 默认值： 30
username 字符串	OpenManage Enterprise 用户名。 如果未提供用户名，则使用环境变量 OME_USERNAME。 示例：export OME_USERNAME=username
validate_certs 布尔值 在 dellemc.openmanage 5.0.0 中添加	如果 false，则不会验证 SSL 证书。 仅在个人控制的站点上配置 false，其中使用自签名证书。 在集合版本 5.0.0 之前，validate_certs 默认为 false。 选项 false true ← (默认)
x_auth_token 字符串 在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。 如果未提供 x_auth_token，则使用环境变量 OME_X_AUTH_TOKEN。 示例：export OME_X_AUTH_TOKEN=x_auth_token

说明

注意

• 对于 idrac_reset，作业仅触发 iDRAC 重置操作，而不跟踪完整的重置周期。

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

• 此模块支持 check_mode。

示例

---
- name: Refresh Inventory
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: refresh_inventory
    device_service_tags:
      - SVCTAG1

- name: Clear iDRAC job queue
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: clear_idrac_job_queue
    device_service_tags:
      - SVCTAG1

- name: Reset iDRAC using the service tag
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_action: reset_idrac
    device_service_tags:
      - SVCTAG1

- name: Remove devices using servicetags
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    device_service_tags:
      - SVCTAG1
      - SVCTAF2

- name: Remove devices using IDs
  dellemc.openmanage.ome_devices:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    device_ids:
      - 10235

返回值

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

键	描述
error_info 字典	HTTP错误的详细信息。 返回： HTTP错误时 示例： {"error": {"@Message.ExtendedInfo": [{"Message": "无法完成操作，因为请求的URI无效。", "MessageArgs": [], "MessageId": "CGEN1002", "RelatedProperties": [], "Resolution": "输入有效的URI，然后重试操作。", "Severity": "严重"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关更多信息，请参阅ExtendedInfo。"}}
job 字典	设备操作的作业详细信息。 返回： 成功 示例： {"Builtin": false, "CreatedBy": "admin", "Editable": true, "[email protected]": "/api/JobService/Jobs(14874)/ExecutionHistories", "Id": 14874, "JobDescription": "从OpenManage Ansible模块为ID为'13216'的设备启动的刷新清单任务。", "JobName": "刷新清单", "JobStatus": {"@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "已计划"}, "JobType": {"@odata.type": "#JobService.JobType", "Id": 8, "Internal": false, "Name": "Inventory_Task"}, "LastExecutionDetail": {"@odata.id": "/api/JobService/Jobs(14874)/LastExecutionDetail"}, "LastRunStatus": {"@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "已完成"}, "Params": [{"JobId": 14874, "Key": "action", "Value": "CONFIG_INVENTORY"}, {"JobId": 14874, "Key": "isCollectDriverInventory", "Value": "true"}], "Schedule": "startnow", "State": "Enabled", "Targets": [{"Data": "", "Id": 13216, "JobId": 14874, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "UserGenerated": true, "Visible": true}
msg 字符串	设备操作的总体状态。 返回： 总是 示例： "成功移除了设备。"

作者

• Jagadeesh N V(@jagadeeshnv)

• ShivamSh3(@ShivamSh3)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）