dellemc.openmanage.ome_device_info 模块 – 获取 OpenManage Enterprise 盘点设备的信息

注意

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

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

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

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

dellemc.openmanage 2.0.0 中的新增功能

概要

• 此模块检索 OpenManage Enterprise 清单中的设备列表以及每个设备的详细信息。

要求

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

• python >= 3.9.6

参数

参数	注释
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
fact_subset 字符串	basic_inventory 返回设备列表。 detailed_inventory 返回指定设备的清单详细信息。 subsystem_health 返回指定设备的健康状态。 选项 "basic_inventory" ← (默认) "detailed_inventory" "subsystem_health"
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。 默认值： 443
system_query_options 字典	适用于 fact_subset 选项的 system_query_options。对于 detailed_inventory 和 subsystem_health，device_id 或 device_service_tag 是必需的，或者两者都可以适用。
device_id 列表 / 元素=整数	唯一标识符列表，适用于 detailed_inventory 和 subsystem_health。
device_service_tag 列表 / 元素=字符串	服务标签列表，适用于 detailed_inventory 和 subsystem_health。
filter 字符串	对于 basic_inventory，它过滤设备集合。filter 查询格式应符合 OData 标准。
inventory_type 字符串	对于 detailed_inventory，它返回指定清单类型的详细信息。
timeout 整数 dellemc.openmanage 5.0.0 中新增	以秒为单位的套接字级别超时。 默认值： 30
username 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。 如果未提供用户名，则使用环境变量 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

注释

注意

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

• 此模块支持check_mode。

示例

---
- name: Retrieve basic inventory of all devices
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve basic inventory for devices identified by IDs 33333 or 11111 using filtering
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fact_subset: "basic_inventory"
    system_query_options:
      filter: "Id eq 33333 or Id eq 11111"

- name: Retrieve inventory details of specified devices identified by IDs 11111 and 22222
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fact_subset: "detailed_inventory"
    system_query_options:
      device_id:
        - 11111
        - 22222

- name: Retrieve inventory details of specified devices identified by service tags MXL1234 and MXL4567
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fact_subset: "detailed_inventory"
    system_query_options:
      device_service_tag:
        - MXL1234
        - MXL4567

- name: Retrieve details of specified inventory type of specified devices identified by ID and service tags
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fact_subset: "detailed_inventory"
    system_query_options:
      device_id:
        - 11111
      device_service_tag:
        - MXL1234
        - MXL4567
      inventory_type: "serverDeviceCards"

- name: Retrieve subsystem health of specified devices identified by service tags
  dellemc.openmanage.ome_device_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fact_subset: "subsystem_health"
    system_query_options:
      device_service_tag:
        - MXL1234
        - MXL4567

返回值

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

键	描述
device_info 字典	返回从设备收集的信息。 返回值：成功 示例： {"value": [{"Actions": null, "AssetTag": null, "ChassisServiceTag": null, "ConnectionState": true, "DeviceManagement": [{"DnsName": "dnsname.host.com", "InstrumentationName": "MX-12345", "MacAddress": "11:10:11:10:11:10", "ManagementId": 12345, "ManagementProfile": [{"HasCreds": 0, "ManagementId": 12345, "ManagementProfileId": 12345, "ManagementURL": "https://192.168.0.1:443", "Status": 1000, "StatusDateTime": "2019-01-21 06:30:08.501"}], "ManagementType": 2, "NetworkAddress": "192.168.0.1"}], "DeviceName": "MX-0003I", "DeviceServiceTag": "MXL1234", "DeviceSubscription": null, "LastInventoryTime": "2019-01-21 06:30:08.501", "LastStatusTime": "2019-01-21 06:30:02.492", "ManagedState": 3000, "Model": "PowerEdge MX7000", "PowerState": 17, "SlotConfiguration": {}, "Status": 4000, "SystemId": 2031, "Type": 2000}]}
msg 字符串	设备整体信息状态。 返回值：发生错误时 示例： "Failed to fetch the device information"

作者

• Sajna Shetty (@Sajna-Shetty)

• Felix Stephen (@felixs88)

资源链接

• 问题追踪器
• 主页
• 代码仓库