dellemc.openmanage.ome_device_info – Retrieves the information of devices inventoried by OpenManage Enterprise
dellemc.openmanage.ome_device_info – Retrieves the information of devices inventoried by OpenManage Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.0.0).
To install it use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.ome_device_info
.
New in version 2.0.0: of dellemc.openmanage
Synopsis
- This module retrieves the list of devices in the inventory of OpenManage Enterprise along with the details of each device.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7.5
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
fact_subset string |
|
| |
hostname string / required |
Target IP address or hostname. | ||
password string / required |
Target user password. | ||
port integer |
Default: 443 |
Target HTTPS port. | |
system_query_options dictionary |
system_query_options applicable for the choices of the fact_subset. Either device_id or device_service_tag is mandatory for | ||
device_id list / elements=integer |
A list of unique identifier is applicable for | ||
device_service_tag list / elements=string |
A list of service tags are applicable for | ||
filter string |
For | ||
inventory_type string |
For | ||
username string / required |
Target username. |
Notes
Note
- Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
- This module supports
check_mode
.
Examples
---
- name: Retrieve basic inventory of all devices
dellemc.openmanage.ome_device_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
- 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"
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"
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"
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"
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"
fact_subset: "subsystem_health"
system_query_options:
device_service_tag:
- MXL1234
- MXL4567
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
device_info dictionary |
success |
Returns the information collected from the Device.
Sample: {'value': [{'Actions': None, 'AssetTag': None, 'ChassisServiceTag': None, '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': None, '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 string |
on error |
Over all device information status.
Sample: Failed to fetch the device information |
Authors
- Sajna Shetty(@Sajna-Shetty)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_device_info_module.html