Users Guide

Table 25. ome_device_info (continued)
Parameter Required Default Choices Comments
port No 443 NA Target device HTTPS port
fact_subset No
basic_inventor
y
● basic_inventory
● detailed_inventory
● subsystem_health
● C(basic_inventory)
returns the list of the
devices.
● C(detailed_inventory)
returns the inventory
details of specified
devices.
● C(subsystem_health)
returns the health
status of specified
devices.
system_query_options No NA
● device_id: A list of unique identifier is
applicable for C(detailed_inventory) and
C(subsystem_health).
● device_service_tag: A list of
service tags is applicable
for C(detailed_inventory) and
C(subsystem_health).
● inventory_type: For
C(detailed_inventory), it returns details
of the specified inventory type.
● filter: For C(basic_inventory), it filters
the collection of devices. I(filter) query
format should be aligned with OData
standards.
● I(system_query_optio
ns) is applicable for
the choices of the
fact_subset.
● Either I(device_id) or
I(device_service_tag)
is mandatory for
C(detailed_inventory)
and
C(subsystem_health).
● I(device_id) or
I(device_service_tag)
can be used
individually or
together.
Return Values
msg:
type: str
description: Overall device information status.
returned: on error
sample: "Failed to fetch the device information"
device_info:
type: dict
description: Returns the information collected from the device.
returned: success
sample: {
"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,
Modules for OpenManage Enterprise (OME)
59