White Papers

OpenManage Essentials-Specific Resource Model
17 REST API Guide–OpenManage Essentials
Devices
The URI for accessing devices in OpenManage Essentials could be either based on the parent group resource
or by directly accessing the devices. For example:
Devices by group (immediate child devices): <BASE_URI>/DeviceGroups/<ID>/ChildDevices
Devices by group (all devices): <BASE_URI>/DeviceGroups/<ID>/Devices
Devices by direct access: <BASE_URI>/Devices
Any of the URIs specified earlier will be referenced as the <DEVICE_BASE_URI> in the subsequent sections
of this document.
Devices (sorted): <BASE_URI>/Devices/$sort(column=<attribute name(s)>;direction=<sort direction(s)>)
Operations supported: GET
Attributes (filtering): Id, Type, Name, DNSName, and GlobalStatus
Attributes (sorting): Name Asc (by default), Id, and GlobalStatus
The attributes associated with each device are described in the following table:
Attribute Name
Description
Id
The unique identifier for the device.
Type
The type enumeration for the device.
Name
The name of the device.
DNSName
The DNS name of the device.
iDRACName
The name of the iDRAC on the device.
SystemId
The system identifier of the device.
GlobalStatus
The global HW status of the device.
PowerStatus
The power status of the device.
ServiceTag
The Service Tag of the device.
NodeId
The specific node identifier rather than the Service Tag that is used to
identify a device such as the PowerEdge FM120x4 sled.
LaunchURL
The URL for the portal page for the iDRAC, if the device is a server.
AssetTag
The asset tag of the device.
SystemModel
The model of the device.
ExpressServiceCode
The service code associated with the device.
DiscoveryTime
The time when the device was last discovered.
InventoryTime
The time when the device was last inventoried.
StatusTime
The time when the device was last statused.
OSName
The name of the installed operating system.
OSRevision
The version of the operating system.
NICS
A collection of NIC elements identifying all the NICs associated with
the particular device.
IsIdrac
True or false indicating whether the device instance is representing an
iDRAC device.
The type enumeration for the device (Type) is defined in the following table:
Enum Value
Description
2
Unclassified
4
Server