GET /api/v1/data/devices/{id}
Use this method to return information about a specific managed device.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}
where {id} is the UUID or ID of the device. To obtain the device UUID and IDs, use GET /api/v1/data/devices.
Query parameters
None
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
408 | Request Timeout | The orchestrator server did not receive a required request in a specific amount of time. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
Attributes | Type | Description | |||||
---|---|---|---|---|---|---|---|
id | String | Device ID Tip The device ID is made up of the UUID of the device and the UUID of the resource manager that manages the device, separated by a dash. | |||||
accessState | String | Access state of the device (translated). This can be one of the following values.
| |||||
accessStateKey | String | Access state of the server key. This can be one of the following values.
| |||||
accessStateRecords | Array of objects | Information about access state records | |||||
health | String | ||||||
ipAddress | String | ||||||
messageBundle | String | ||||||
messageDisplay | String | ||||||
messageID | String | ||||||
messageParameter | String | ||||||
protocol | String | ||||||
username | String | ||||||
timestamp | Long | ||||||
trusted | Boolean | ||||||
accountLockoutPeriod | Integer | ||||||
accurateHealth | Boolean | Indicates whether the health status is accurate. This can be one of the following values.
| |||||
activationKeys | Array of objects | List of installed Feature On Demand (FoD) keys | |||||
description | String | FoD key description | |||||
keyExpirationDate | String | Date when the FoD key expires | |||||
keyFeatureType | Integer | FoD feature type | |||||
keyIdentiferList | Array of objects | FoD associative identifier list | |||||
keyIdentifier | String | Identifier key value | |||||
keyIdentifierType | String | Identifier key type. This can be one of the following values.
| |||||
keyStatus | String | Status of the FoD key. This can be one of the following values.
| |||||
keyUseCount | Integer | Key usage count | |||||
keyUseLimit | Integer | Key usage limit | |||||
uuid | String | Unique identifier for the FoD key | |||||
addinCards | Array of objects | Information about add-in cards Note Multiple instances of the same adapter card with different data (such as the pciFunctionNumber) might be returned in this response. In the UI, only one instance of each adapter card (only the first function number) is listed. | |||||
class | String | Class | |||||
firmware | Array of objects | Information about add-in card firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | ||||||
name | String | Firmware name | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | Firmware ID | ||||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
fodUniqueID | String | FoD unique ID | |||||
FRU | String | Add-in card FRU part number | |||||
fruSerialNumber | String | ||||||
isAddOnCard | Boolean | Identifies whether the device is an add-in card. This can be one of the following values.
| |||||
isAgentless | Boolean | Identifies whether the device is agentless. This can be one of the following values.
Note If | |||||
isPLDMUpdateSupported | Boolean | Identifies whether the Platform Level Data Model updates are supported. This can be one of the following values.
| |||||
manufacturer | String | Add-in card manufacturer | |||||
name | String | Add-in card description | |||||
partNumber | String | Add-in card part number | |||||
pciBusNumber | String | PCI bus number | |||||
pciDeviceNumber | String | PCI device number | |||||
pciFunctionNumber | String | PCI function number | |||||
pciRevision | String | PCI revision number | |||||
pciSubID | String | PCI subsystem ID | |||||
pciSubVendorID | String | PCI sub-vendor ID | |||||
portInfo | Object | Information about the port | |||||
physicalPorts | Array of objects | Information about the physical port | |||||
logicalPorts | Array of objects | List of associated logical ports | |||||
addresses | Array of Strings | Assigned addresses | |||||
logicalPortIndex | Integer | Number of logical ports | |||||
portType | String | Logical port type. This can be one of the following values.
| |||||
portNumber | Integer | Number of the logical port | |||||
vnicMode | Boolean | Identifies whether this is a vNIC port. This can be one of the following values.
| |||||
peerBay | Integer | Peer I/O Module bay | |||||
physicalPortIndex | Integer | Number of physical ports | |||||
portNumber | Integer | Number of the physical port | |||||
portType | String | Physical port type. This can be one of the following values.
| |||||
speed | String | ||||||
status | String | ||||||
posID | String | Device ID | |||||
productName | String | Product name | |||||
slotName | String | Name for add-in card slot | |||||
slotNumber | String | Number for add-in card slot | |||||
slotSupportsHotPlug | Boolean | Indicates whether the add-in card supports hot plug. This can be one of the following values.
| |||||
vpdID | String | VPD ID | |||||
addinCardSlots | Integer | Slot number for the add-in card | |||||
agentVersion | String | (ThinkEdge Client devices only) Version of the UDC agent that is running on the device If set to null, the UDC agent agent is not installed. | |||||
arch | String | Architecture. This can be one of the following values.
| |||||
assetTag | String | (ThinkSystem rack servers only) Name or Tag that represents the server or other physical enclosure | |||||
attachedNodes | Array of objects | (Switches only) | |||||
bladeState | Integer | State of the server. This can be one of the following values.
| |||||
bmuParamObject | String | ||||||
canisters | Array of objects | (Storage devices only) Information about each canister in the device | |||||
id | String | Canister ID | |||||
cmmDisplayName | String | (Chassis only) Chassis name | |||||
cmmHealthState | String | (Chassis only) Health state (translated). This can be one of the following values.
| |||||
cmms | Array of objects | (Chassis only) Information about each CMM | |||||
accessState | String | Access state (translated) of the chassis. This can be one of the following values.
| |||||
accessStateKey | String | Access state key of the chassis. This can be one of the following values.
| |||||
accurateHealth | Boolean | Indicates whether the health status is accurate. This can be one of the following values.
| |||||
backedBy | String | Indicates whether the data is from a real or demo server. This can be one of the following values.
| |||||
cmmDisplayName | String | Display name provided by the CMM | |||||
cmmHealthState | String | Health summary that corresponds to the highest event severity of all the devices. This can be one of the following values.
| |||||
dataHandle | Long | Time stamp of the last status update | |||||
description | String | Description that was provided by the CMM | |||||
deviceTypeKey | String | ||||||
domainName | String | User-defined domain name | |||||
dnsHostnames | Array of strings | ||||||
errorFields | Array of objects | Error code. This can be one of the following values.
| |||||
excludedHealthState | String | Highest severity alert with exclusions. This can be one of the following values.
| |||||
firmware | Array of objects | Information about CMM firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
name | String | Firmware name | |||||
deviceTypeKey | String | ||||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | StrinBooleang | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
FRU | String | CMM FRU part number | |||||
fruSerialNumber | String | CMM FRU serial number | |||||
hostConfig | Array of objects | Information about host configuration | |||||
DDNSenabled | Boolean | Identifies whether dynamic DNS enabled. This can be one of the following values.
| |||||
DNSenabled | Boolean | Identifies whether DNS enabled. This can be one of the following values.
| |||||
IPversionPriority | String | IP version priority. This can be one of the following values
| |||||
priIPv4userDNSserver | String | Primary user assigned IPv4 DNS server | |||||
priIPv6userDNSserver | String | Primary user assigned IPv6 DNS server | |||||
secIPv4userDNSserver | String | Secondary user assigned IPv4 DNS server | |||||
secIPv6userDNSserver | String | Secondary user assigned IPv6 DNS server | |||||
terIPv4userDNSserver | String | Tertiary user assigned IPv4 DNS server | |||||
terIPv6userDNSserver | String | Ternary user assigned IPv6 DNS server | |||||
hostname | String | User-defined hostname | |||||
ipInterfaces | Array of objects | Information about each IP interface | |||||
IPv4assignments | Array of objects | Information about each IPv4 assignment | |||||
id | Integer | IPv4 assignment ID | |||||
address | String | IPv4 address | |||||
deviceTypeKey | String | ||||||
gateway | String | IPv4 gateway | |||||
subnet | String | IPv4 subnet mask | |||||
type | String | Type of the IPv4 assignment. This can be one of the following values.
| |||||
IPv4DHCPmode | String | IP address assignment method. This can be one of the following values.
| |||||
IPv4enabled | Boolean | Identifies whether IPv4 is enabled. This can be one of the following values.
| |||||
IPv6assignments | Array of objects | Information about each IPv6 assignment | |||||
id | Integer | IPv6 assignment ID | |||||
address | String | IPv6 address | |||||
gateway | String | IPv6 gateway | |||||
prefix | Integer | IPv6 prefix | |||||
scope | String | Scope of the IPv6 assignment. This can be one of the following values.
| |||||
source | String | Source of the IPv6 assignment. This can be one of the following values.
| |||||
type | String | Type of the IPv6 assignment. This can be one of the following values.
| |||||
IPv6DHCPenabled | Boolean | Identifies whether IPv6 DHCP is enabled. This can be one of the following values.
| |||||
IPv6enabled | Boolean | Identifies whether IPv6 is enabled. This can be one of the following values.
| |||||
IPv6statelessEnabled | Boolean | Identifies whether IPv6 stateless is enabled. This can be one of the following values.
| |||||
IPv6staticEnabled | Boolean | Identifies whether IPv6 static is enabled. This can be one of the following values.
| |||||
label | String | Label | |||||
name | String | Name | |||||
ipv4Addresses | Array of strings | List of IPv4 addresses | |||||
ipv6Addresses | Array of strings | List of IPV6 addresses | |||||
leds | Array of objects | Information about server LEDs | |||||
color | String | LED color. This can be one of the following values.
| |||||
location | String | LED location. This can be one of the following values.
| |||||
name | String | LED name | |||||
state | String | LED state. This can be one of the following values.
| |||||
macAddresses | Array of strings | List of MAC addresses | |||||
machineType | String | Server machine type | |||||
manufacturer | String | Manufacturer | |||||
manufacturerId | String | Manufacturer ID | |||||
mgmtProcIPaddress | String | IP address used by XClarity Orchestrator to manage this resource | |||||
model | String | CMM model | |||||
name | String | Name that is displayed in the user interface for this device | |||||
overallHealthState | String | Highest severity of all alerts. This can be one of the following values.
| |||||
overallHealthStateKey | String | Highest severity key. This can be one of the following values.
| |||||
parent | Object | Information about the parent device | |||||
uri | String | Parent URI | |||||
uuid | String | Parent UUID | |||||
partNumber | String | CMM part number | |||||
powerAllocation | Object | ||||||
maximumAllocatedPower | Long | Maximum power that is allocated | |||||
minimumAllocatedPower | Long | Minimum power that is allocated | |||||
powerStatus | String | ||||||
powerStatusKey | String | ||||||
productId | String | CMM product ID | |||||
role | String | Role of the CMM. This can be one of the following values.
| |||||
serialNumber | String | CMM serial number | |||||
slots | Array of integers | CMM primary slot | |||||
type | String | Resource type. This value is always CMM. | |||||
userDefinedName | String | User-defined name for the device | |||||
userDescription | String | Description that was defined by the user | |||||
uri | String | CMM URI | |||||
uuid | String | CMM UUID | |||||
configCompliance | Array of objects | Information about the server-configuration compliance | |||||
addressPresent | Boolean | Identifies whether address pools are used. This can be one of the following values.
| |||||
complianceStatus | String | Compliance status. This can be one of the following values.
| |||||
managementPatternPresent | Boolean | Identifies whether a management-interface pattern is used. This can be one of the following values.
| |||||
profileName | String | Name of the server profile | |||||
profileStatus | String | Current status of the profile. This can be one of the following values.
| |||||
templateId | String | ID of the server pattern that was used to create the profile | |||||
type | String | Internal use only | |||||
contact | String | Contact (assigned in Lenovo XClarity Administrator) | |||||
contacts | Object | Information about support contacts for this device (assigned in XClarity Orchestrator) | |||||
primary | Object | Information about the primary contact | |||||
id | String | Contact ID | |||||
fullName | String | Contact name | |||||
companyName | String | Company name | |||||
contactEmail | String | Email address | |||||
contactPhone | String | Phone number | |||||
streetAddress | String | Street address | |||||
city | String | City | |||||
stateProvince | String | State or province | |||||
postalCode | String | Country or region | |||||
country | String | Postal code | |||||
preferredContactMethod | String | Preferred contact method. This can be one of the following values.
| |||||
uri | String | Contact URI | |||||
secondary | Array of strings | Information about each secondary contact | |||||
id | String | Contact ID | |||||
fullName | String | Contact name | |||||
companyName | String | Company name | |||||
contactEmail | String | Email address | |||||
contactPhone | String | Phone number | |||||
streetAddress | String | Street address | |||||
city | String | City | |||||
stateProvince | String | State or province | |||||
postalCode | String | Country or region | |||||
country | String | Postal code | |||||
preferredContactMethod | String | Preferred contact method. This can be one of the following values.
| |||||
uri | String | Contact URI | |||||
dataHandle | Long | Time stamp of the last status update | |||||
description | String | ||||||
deviceDrivers | Array of objects | Information about the device drivers | |||||
displayName | String | Display name | |||||
driverClass | String | Class | |||||
driverClassId | String | Class ID | |||||
driverFiles | Array of objects | Information about the device-driver files | |||||
path | String | File path | |||||
version | String | File version | |||||
installDate | String | Installation date | |||||
instID | String | Installation ID | |||||
localInfName | String | Local INF file name | |||||
name | String | Name | |||||
releaseDate | String | Release date | |||||
version | String | Version | |||||
deviceInfo | Object | Information about the device | |||||
domainName | String | Domain name | |||||
entitleSerialNumber | String | Entitled serial number | |||||
groupNames | Array of strings | List of names for groups that include this device | |||||
healthStatus | String | Highest severity of all alerts (translated). This can be one of the following values.
| |||||
healthStatusKey | String | Severity key of highest severity of all alerts. This can be one of the following values.
| |||||
hostname | String | Hostname | |||||
ipv4Addresses | Array of strings | List of IPv4 addresses | |||||
ipv6Addresses | Array of strings | List of IPV6 addresses | |||||
location | Object | Information about the location of the server or Flex System storage device | |||||
location | String | Location | |||||
lowestRackUnit | Integer | Lowest rack unit | |||||
rack | String | Rack | |||||
room | String | Room | |||||
machineType | String | Machine type | |||||
manager | Object | Information about the resource manager that manages this device | |||||
id | String | Resource manager ID | |||||
domainName | String | Domain name | |||||
fqdn | String | Fully qualified domain name | |||||
hostname | String | Host name | |||||
inContextHref | String | In context URI | |||||
ipv4Addresses | Array of strings | IPv4 addresses | |||||
ipv6Addresses | Array of strings | IPv6 addresses | |||||
model | String | Device model | |||||
powerStatus | String | Power status (translated). This can be one of the following values.
| |||||
powerStatusKey | String | Power status key. This can be one of the following values.
| |||||
productName | String | Product name | |||||
serialNumber | String | Device serial number | |||||
userDefinedName | String | User-defined name for the device | |||||
uuid | String | Device UUID | |||||
deviceName | String | Device name | |||||
deviceType | String | Device type (translated). This can be one of the following values.
| |||||
deviceTypeKey | String | Device type key. This can be one of the following values.
| |||||
discoveryTimestamp | String | Timestamp when the device was discovered This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
diskDriveSensorInfo | Array of strings | List of hard-driver sensor names | |||||
dnsHostnames | Array of string | ||||||
domainName | String | Domain name | |||||
driveBays | Integer | Number of drive bays | |||||
drives | Array of objects | Drive details | |||||
bay | Integer | Drive bay | |||||
blockSize | Integer | Block size | |||||
capacity | Long | Drive capacity | |||||
description | String | Description | |||||
diskState | String | Disk-drive state | |||||
encryptionStatus | String | Indicates whether the disk drive is encrypted. This can be one of the following values.
| |||||
firmware | Array of objects | Information about add-in card firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | Device type key | |||||
name | String | Firmware name | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
FRU | String | FRU | |||||
healthState | String | Health state (translated) that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values.
| |||||
healthStateKey | String | Health state key that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values.
| |||||
hotSpareType | String | Type of hot spare drive. This can be one of the following values.
| |||||
interfaceType | String | (ThinkServer servers only) Drive interface type | |||||
largestAvailableSize | Integer | ||||||
m2Location | String | (M.2 drives only) Location of M.2 drive and bay | |||||
manufacturer | String | Manufacturer | |||||
mediaType | String | Media type | |||||
model | String | Model | |||||
name | String | Drive name | |||||
numberOfBlocks | Integer | Number of blocks | |||||
partNumber | String | Part number | |||||
remainingLife | Integer | Indicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values.
| |||||
serialNumber | String | Serial number | |||||
temperature | String | Device temperature | |||||
uuid | String | Storage device UUID | |||||
drivesInstalled | Integer | (Storage devices only) Number of installed drives | |||||
encapsulation | Object | Information about encapsulation | |||||
encapsulationMode | String | Encapsulation (firewall settings) mode. This can be one of the following values.
| |||||
excludedHealthState | String | Highest severity alert with exclusions. This can be one of the following values.
| |||||
expansionCards | Array of objects | Information about expansion cards | |||||
fodUniqueID | String | Feature on demand (FoD) unique ID | |||||
isAddOnCard | Boolean | Identifies whether the device is an add-on card. This can be one of the following values.
| |||||
isAgentless | Boolean | Identifies whether the device is agentless. This can be one of the following values.
| |||||
name | String | Description | |||||
pciBusNumber | String | PCI bus number | |||||
pciDeviceNumber | String | PCI device number | |||||
pciFunctionNumber | String | PCI function number | |||||
pciSubID | String | PCI subsystem ID | |||||
pciSubVendorID | String | PCI sub-vendor ID | |||||
portInfo | Object | Information about the ports | |||||
physicalPorts | Array of objects | Information about the physical ports | |||||
logicalPorts | Array of objects | List of associated logical ports | |||||
addresses | Array of Strings | Assigned addresses | |||||
logicalPortIndex | Integer | Number of logical ports | |||||
portNumber | Integer | Number of the logical port | |||||
portType | String | Logical port type. This can be one of the following values.
| |||||
vnicMode | Boolean | Identifies whether this is a vNIC port. This can be one of the following values.
| |||||
physicalPortIndex | Integer | Number of physical ports | |||||
portType | String | Physical port type. This can be one of the following values.
| |||||
portNumber | Integer | Number of the physical port | |||||
peerBay | Integer | Peer I/O module bay | |||||
posID | String | Device ID | |||||
vpdID | String | VPD ID | |||||
expansionCardSlots | Integer | Expansion card slots | |||||
expansionProducts | Array of strings | (Servers with blade expanders installed only) List of expansion hardware. This can be one or more of the following values.
| |||||
expansionProductType | String | Expansion product type. This can be one of the following values.
| |||||
fans | Array of objects | Information about each fan in the device | |||||
description | String | Fan description | |||||
healthState | String | Fan health state (translated). This can be one of the following values.
| |||||
healthStateKey | String | Fan health state key. This can be one of the following values.
| |||||
name | String | Fan name | |||||
slot | Integer | Fan slot | |||||
slots | Integer | Fan slot | |||||
speed | Integer | Fan speed | |||||
status | String | Fan status | |||||
featuresOnDemand | Array of objects | Information about features on demand (FOD) | |||||
features | Array of string | List of active features on demand | |||||
tierLevel | Integer | (ThinkSystem only) Tier level of the Lenovo XClarity Controller feature key that is installed. This can be one of the following values.
| |||||
firmware | Array of objects | Information about each firmware | |||||
build | String | Firmware build | |||||
classifications | Array | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | ||||||
firmwareActivationStatus | String | ||||||
firmwareActivationStatusKey | String | ||||||
name | String | Firmware name | |||||
revision | String | ||||||
role | String | Firmware role. This can be one of the following values.
| |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
firmwareCompliance | Object | Information about the firmware compliance | |||||
status | String | Compliance status. This can be one of the following values.
| |||||
flashStorage | Array of objects | Information about flash storage | |||||
defaultBlockSize | Long | Flash storage device block size | |||||
description | String | Flash storage description | |||||
serialNumber | String | Flash storage serial number | |||||
firmware | Array of objects | Flash storage firmware properties | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
name | String | Firmware name | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware identifier | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
manufacturer | String | Flash storage manufacturer | |||||
maxMediaSize | Long | Flash storage device media size | |||||
name | String | Flash storage description | |||||
partNumber | String | Flash storage part number | |||||
slotNumber | Integer | Flash storage slot number | |||||
uuid | String | Flash storage UUID | |||||
FQDN | String | Fully qualified domain name | |||||
FRU | String | ||||||
fruSerialNumber | String | ||||||
groups | Array of objects | Information about each group in which this device is a member | |||||
id | String | Group ID | |||||
name | String | Group name | |||||
type | String | Group type. This value is always “DeviceGroup.” | |||||
uri | String | Group URI | |||||
hasOS | String | Identifies whether an operating system is installed. This can be one of the following values.
| |||||
height | Integer | (Rack Server only) Height of the server | |||||
hostname | String | Hostname | |||||
inProcessing | String | ||||||
ipInterfaces | Array of objects | Information about each IP interface | |||||
IPv4assignments | Array of objects | Information about each IPv4 assignment | |||||
id | Integer | IPv4 assignment ID | |||||
address | String | IPv4 address | |||||
deviceTypeKey | String | ||||||
gateway | String | IPv4 gateway | |||||
subnet | String | IPv4 subnet mask | |||||
type | String | Type of the IPv4 assignment. This can be one of the following values.
| |||||
IPv4DHCPmode | String | IP address assignment method. This can be one of the following values.
| |||||
IPv4enabled | Boolean | Identifies whether IPv4 is enabled. This can be one of the following values.
| |||||
IPv6assignments | Array of objects | Information about each IPv6 assignment | |||||
id | Integer | IPv6 assignment ID | |||||
address | String | IPv6 address | |||||
deviceTypeKey | String | ||||||
gateway | String | IPv6 gateway | |||||
prefix | Integer | IPv6 prefix | |||||
scope | String | Scope of the IPv6 assignment. This can be one of the following values.
| |||||
source | String | Source of the IPv6 assignment. This can be one of the following values.
| |||||
type | String | Type of the IPv6 assignment. This can be one of the following values.
| |||||
IPv6DHCPenabled | Boolean | Identifies whether IPv6 DHCP is enabled. This can be one of the following values.
| |||||
IPv6enabled | Boolean | Identifies whether IPv6 is enabled. This can be one of the following values.
| |||||
IPv6statelessEnabled | Boolean | Identifies whether IPv6 stateless is enabled. This can be one of the following values.
| |||||
IPv6staticEnabled | Boolean | Identifies whether IPv6 static is enabled. This can be one of the following values.
| |||||
label | String | Label | |||||
name | String | Name | |||||
ipv4Addresses | Array of strings | List of IPv4 addresses | |||||
ipv6Addresses | Array of strings | List of IPV6 addresses | |||||
isEmbedded | Boolean | ||||||
isITME | Boolean | Indicates whether the server is a Flex System compute node. This can be one of the following values.
| |||||
isRemotePresenceEnabled | Boolean | Indicates whether remote presence is enabled. This can be one of the following values.
| |||||
isScalable | Boolean | Indicates whether this is a scalable device. This can be one of the following values.
| |||||
isITME | Boolean | Indicates whether this device is a compute node in a chassis.This can be one of the following values.
| |||||
lanOverUsb | String | Identifies whether LAN over USB is enabled. This can be one of the following values.
| |||||
lanOverUsbPortForwardingModes | Array of objects | Ethernet-over-USB port forwarding mode | |||||
deviceTypeKey | String | ||||||
externalIPAddress | String | IP address of the port | |||||
state | String | Identifies whether the Ethernet over USB port forwarding mode is enabled or disabled. This can be one of the following values
| |||||
type | String | Type of LAN over USB port. This can be one of the following values.
| |||||
lastSyncTimestamp | String | Timestamp when this data was last refreshed from the resource manager This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
lastUpdateTimestamp | String | Timestamp when this data was last updates from the resource manager This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
leds | Array of objects | Information about server LEDs | |||||
color | String | LED color. This can be one of the following values.
| |||||
location | String | LED location. This can be one of the following values.
| |||||
name | String | LED name | |||||
state | String | LED state. This can be one of the following values.
| |||||
location | Object | Information about the location of the server or Flex System storage device | |||||
location | String | Location | |||||
lowestRackUnit | Integer | Lowest rack unit | |||||
rack | String | Rack | |||||
room | String | Room | |||||
lxcaOverallHealthState | String | Resource manager health state. This can be one of the following values.
| |||||
lxcaUUID | String | Resource manager UUID | |||||
m2Presence | Boolean | Indicates whether the device contains M.2 storage. This can be one of the following values.
| |||||
macAddresses | Array of strings | List of MAC addresses | |||||
machineType | String | Server machine type | |||||
manager | Object | Information about the resource manager that manages this device | |||||
id | String | Resource manager ID | |||||
domainName | String | Domain name | |||||
fqdn | String | Fully qualified domain name | |||||
groups | Array of objects | Information about groups in which the manager is a member | |||||
id | String | Group ID | |||||
name | String | Group name | |||||
type | String | Group type. This value is always ManagerGroup. | |||||
uri | String | Group URI | |||||
hostname | String | Host name | |||||
inContextHref | String | In context URI | |||||
ipv4Addresses | Array of strings | IPv4 addresses | |||||
ipv6Addresses | Array of strings | IPv6 addresses | |||||
uri | Array of strings | Resource manager URI | |||||
manufacturer | String | Manufacturer | |||||
manufacturerID | String | Manufacturer ID | |||||
memoryModules | Array of objects | Information about memory modules | |||||
capacity | Long | Capacity | |||||
deviceTypeKey | String | Device type key | |||||
displayName | String | Display name | |||||
fruPartNumber | String | FRU part number | |||||
healthState | String | Health state (translated). This can be one of the following values.
| |||||
healthStateKey | String | Health state key. This can be one of the following values.
| |||||
manufacturer | String | Manufacturer | |||||
metrics | Object | Information about memory metric data | |||||
alarmTrips | Object | Information about alarm trips | |||||
model | String | Model | |||||
operatingMemoryMode | Array of strings | ||||||
partNumber | String | Part number | |||||
present | Boolean | ||||||
serialNumber | String | Serial number | |||||
slot | Integer | Slot | |||||
speed | Long | Number of data-transfer operations that occur in each second, in MT/s (megatransfers per second) | |||||
speedMBs | Long | Amount of data that is transferred in each second, in MB/s (megabytes per second) | |||||
type | String | Type | |||||
mgmtProcIPaddress | String | IP address used by XClarity Orchestrator to manage this resource | |||||
mgmtProcType | String | Type of management controller. This can be one of the following values.
| |||||
model | String | Server model | |||||
mtm | String | Machine type and model, separate by a forward slash (for example, 8387/AC1) | |||||
name | String | Name that is displayed in the user interface for this device | |||||
onboardPciDevices | Array of objects | Information about onboard PCI device | |||||
class | String | Class | |||||
firmware | Array of objects | Information about add-in card firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | ||||||
name | String | Firmware name | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type | |||||
version | String | Firmware version | |||||
fodUniqueID | String | FoD unique ID | |||||
isAddOnCard | Boolean | Identifies whether the device is an add-in card. This can be one of the following values.
| |||||
isAgentless | Boolean | Identifies whether the device is agentless. This can be one of the following values.
Note If | |||||
isPLDMUpdateSupported | Boolean | Identifies whether the Platform Level Data Model updates are supported. This can be one of the following values.
| |||||
name | String | Add-in card description | |||||
pciBusNumber | String | PCI bus number | |||||
pciDeviceNumber | String | PCI device number | |||||
pciFunctionNumber | String | PCI function number | |||||
pciRevision | String | PCI revision number | |||||
pciSegmentNumber | String | PCI segment number | |||||
pciSubID | String | PCI subsystem ID | |||||
pciSubVendorID | String | PCI subsystem ID | |||||
portInfo | Object | Information about the port | |||||
physicalPorts | Array of objects | Information about the physical port | |||||
portType | String | Physical port type. This can be one of the following values.
| |||||
portNumber | Integer | Number of the physical port | |||||
logicalPorts | Array of objects | List of associated logical ports | |||||
logicalPortIndex | Integer | Number of logical ports | |||||
portType | String | Logical port type. This can be one of the following values.
| |||||
portNumber | Integer | Number of the logical port | |||||
addresses | Array of strings | Assigned addresses | |||||
vnicMode | Boolean | Identifies whether this is a vNIC port. This can be one of the following values.
| |||||
peerBay | Integer | Peer I/O module bay | |||||
physicalPortIndex | Integer | Number of physical ports | |||||
posID | String | Device ID | |||||
vpdID | String | VPD ID | |||||
osInfo | Object | Information about the operating system that is installed on the device | |||||
description | String | Operating system name and version | |||||
hostname | String | Hostname or IP address of the operating system | |||||
os_country | String | (ThinkEdge Client devices only) Country where the operating system is installed | |||||
os_language | String | (ThinkEdge Client devices only) Operating system language | |||||
os_name | String | (ThinkEdge Client devices only) Operating system name | |||||
os_version | String | (ThinkEdge Client devices only) Operating system version | |||||
storedCredential | String | URI of the stored-credential account that is used to access the operating system (for example, storedCredentials/2653) | |||||
osProfiles | Object | Information about the operating-system profile for the server | |||||
applicableStatus | String | Profile status (translated). This can be one of the following values.
| |||||
applicableStatusKey | String | Profile status key. This can be one of the following values.
| |||||
assigned | Object | Information about the assigned profile | |||||
id | String | Profile ID | |||||
name | String | Profile name | |||||
uri | String | Profile URI | |||||
deployStatus | String | OS profile deployment status (translated). This can be one of the following values. | |||||
deployStatusKey | String | OS profile deployment status key. This can be one of the following values. | |||||
overallHealthState | String | Highest severity of all events (translated). This can be one of the following values.
| |||||
overallHealthStateKey | String | Highest severity key. This can be one of the following values.
| |||||
parent | Object | Information about the parent of the server or Flex System storage device, if applicable | |||||
uri | String | Parent URI | |||||
uuid | String | Parent UUID | |||||
partNumber | String | Part number | |||||
patterns | Object | Information about the sever-configuration pattern that is assigned to this device | |||||
assigned | Object | Information about the assigned pattern | |||||
id | String | Pattern ID | |||||
name | String | Pattern name | |||||
complianceStatus | String | Compliance status (translated). This can be one of the following values.
| |||||
complianceStatusKey | String | Compliance status key. This can be one of the following values.
| |||||
pciDevices | Array of objects | Information about PCI devices | |||||
class | String | Class (basic function) of the PCI device. This can be one of the following values.
| |||||
firmware | Array of objects | Flash storage firmware properties | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | Device type key | |||||
name | String | Firmware name | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
fodUniqueID | String | FoD unique ID | |||||
FRU | String | Add-in card FRU part number | |||||
fruSerialNumber | String | Add-in card FRU serial number | |||||
isAddOnCard | Boolean | Identifies whether the device is an add-on card. This can be one of the following values.
| |||||
isAgentless | Boolean | Identifies whether the device is agentless. This can be one of the following values.
| |||||
isPLDMUpdateSupported | Boolean | Identifies whether the Platform Level Data Model updates are supported. This can be one of the following values.
| |||||
manufacturer | String | Manufacturer | |||||
name | String | Description | |||||
partNumber | String | Part number | |||||
pciBusNumber | String | PCI bus number | |||||
pciDeviceNumber | String | PCI device number | |||||
pciFunctionNumber | String | PCI function number | |||||
pciRevision | String | PCI revision | |||||
pciSegmentNumber | String | PCI segment number | |||||
pciSubID | String | PCI subsystem ID | |||||
pciSubVendorID | String | PCI sub-vendor ID | |||||
portInfo | Object | Information about the ports | |||||
physicalPorts | Array of objects | Information about the physical ports | |||||
logicalPorts | Array of objects | List of associated logical ports | |||||
addresses | Array of Strings | Assigned addresses | |||||
logicalPortIndex | Integer | Number of logical ports | |||||
portNumber | Integer | Number of the logical port | |||||
portType | String | Logical port type. This can be one of the following values.
| |||||
vnicMode | Boolean | Identifies whether this is a vNIC port. This can be one of the following values.
| |||||
peerBay | Integer | Peer Flex switch bay | |||||
physicalPortIndex | Integer | Number of physical ports | |||||
portNumber | Integer | Number of the physical port | |||||
portType | String | Physical port type. This can be one of the following values.
| |||||
speed | Long | Link speed, in Gbps (for example, 2.5) | |||||
status | String | Link status. This can be one of the following values.
| |||||
posID | String | Device ID | |||||
productName | String | Product name | |||||
slotName | String | Slot name | |||||
slotNumber | String | Slot number | |||||
slotSupportsHotPlug | String | Indicates whether the slot is hot pluggable. This can be one of the following values.
| |||||
vpdID | String | VPD ID | |||||
ports | Array of objects | Port information | |||||
ioModuleBay | Integer | Attached IO module bay number | |||||
portNumber | Integer | Port number | |||||
posID | String | Device ID | |||||
powerAllocation | Object | Information about power allocation | |||||
maximumAllocatedPower | Long | Maximum power allocated to the server | |||||
minimumAllocatedPower | Long | Minimum power allocated to the server | |||||
powerCappingPolicy | Object | (Rack Server only) | |||||
cappingACorDCMode | String | Capping AC or DC mode. This can be one of the following values.
| |||||
cappingPolicy | String | Capping policy. This can be one of the following values.
| |||||
currentPowerCap | Long | Current power cap | |||||
maximumPowerCappingHotPlugLevel | Long | Maximum power capping hot plug level | |||||
maxPowerCap | Long | Maximum power capping level | |||||
minimumHardCapLevel | Long | Minimum hard capping level | |||||
minimumPowerCappingHotPlugLevel | Long | Minimum power capping hot plug level | |||||
minPowerCap | Long | Minimum power capping level | |||||
powerCappingAllocUnit | String | Power capping allocation unit | |||||
powerStatus | String | Power status (translated). This can be one of the following values.
| |||||
powerStatusKey | String | Power status key. This can be one of the following values.
| |||||
powerSupplies | Array of objects | (Rack servers only) Information about power supplies | |||||
cmmDisplayName | String | Assigned component name | |||||
cmmHealthState | String | Health state (translated). This can be one of the following values.
| |||||
dataHandle | Long | Time stamp of the last status update | |||||
description | String | Assigned component description | |||||
deviceTypeKey | String | Device type key | |||||
excludedHealthState | String | Highest severity alert with exclusions. This can be one of the following values.
| |||||
firmware | Array of objects | Information about firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
deviceTypeKey | String | Device type key | |||||
name | String | Firmware name | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA. | |||||
version | String | Firmware version | |||||
FRU | String | FRU part number | |||||
fruSerialNumber | String | FRU serial number | |||||
hardwareRevision | String | Hardware revision | |||||
healthState | String | Health state (translated). This can be one of the following values.
| |||||
healthStateKey | String | Health state key. This can be one of the following values.
| |||||
inputVoltageIsAC | Boolean | Identifies whether the input voltage is ac or dc. This can be one of the following values. The value is valid only if inputVoltageMin and inputVoltageMax are valid.
| |||||
inputVoltageMax | Integer | Maximum input voltage A value of -1 mean it has not been set yet. | |||||
inputVoltageMin | Integer | Minimum input voltage A value of -1 means it has not been set yet. | |||||
leds | Array of objects | Information about power-supply LEDs. | |||||
color | String | LED color. This can be one of the following values.
| |||||
location | String | LED location. This can be one of the following values.
| |||||
name | String | LED name | |||||
state | String | LED state. This can be one of the following values.
| |||||
machineType | String | Machine type | |||||
manufactureDate | String | Manufacture date | |||||
manufacturer | String | Manufacturer name | |||||
manufacturerId | String | Manufacturer ID | |||||
model | String | Power-supply model | |||||
name | String | User-defined name, if available. Otherwise, this is one of the following values.
| |||||
overallHealthState | Highest severity of all power supplies(translated). This can be one of the following values.
| ||||||
overallHealthStateKey | Highest severity key. This can be one of the following values.
| ||||||
parent | Object | Information about the parent device, if applicable | |||||
uri | String | Parent URI | |||||
uuid | String | Parent UUID | |||||
partNumber | String | Part number | |||||
posID | String | Position ID | |||||
powerAllocation | Object | Information about the power allocation | |||||
totalInputPower | Long | Total input power | |||||
totalOutputPower | Long | Total output power | |||||
powerState | String | Current power state of the power supply. This can be one of the following values.
| |||||
powerStatus | String | Power status (translated). This can be one of the following values.
| |||||
powerStatusKey | String | Power status key. This can be one of the following values.
| |||||
productId | String | Product ID | |||||
productName | String | Product name | |||||
serialNumber | String | Serial number | |||||
slots | Array | Power-supply primary slot | |||||
type | String | Resource type. This value is always PowerSupply | |||||
uri | String | URI | |||||
userDescription | String | User description | |||||
uuid | String | UUID | |||||
vpdID | String | VPD ID | |||||
primary | Boolean | ||||||
processorIntelSpeedSelect | Object | Information about the Intel processor speed setting | |||||
currentValue | String | Current setting from the baseboard management controller | |||||
possibleValues | Array of strings | List of possible values | |||||
processors | Information about processors | ||||||
cores | Integer | Number of cores | |||||
displayName | String | Display name | |||||
family | String | Family | |||||
healthState | String | Health state (translated) | |||||
healthStateKey | String | Health state key | |||||
manufacturer | String | Manufacturer | |||||
maxSpeedMHZ | Integer | Maximum processor speed | |||||
partNumber | String | Part number | |||||
present | Boolean | ||||||
productVersion | String | Product version | |||||
serialNumber | String | Serial number | |||||
slot | Integer | Slot | |||||
socket | String | Socket information. For servers, this is the socket number (for example, “Socket 1”). For scalable complexes, this is the node and socket number (for example, “Node 1 Socket 1”). | |||||
speed | Double (float) | Speed | |||||
tdpWatts | Integer | ||||||
processorSlots | Integer | Number of processor slots | |||||
productId | String | Product ID | |||||
productName | String | Product name | |||||
protectedMode | String | ||||||
raidSettings | Array | Information about RAID devices | |||||
batteryData | Array | ||||||
description | String | RAID devices description | |||||
diskDrives | Array of objects | Information about disk drives | |||||
bay | Integer | Bay or slot number | |||||
blockSize | Long | Block size | |||||
capacity | Integer | (M.2 drives only) Storage capacity, in KB | |||||
description | String | Description | |||||
diskState | String | Disk-drive state | |||||
encryptionStatus | String | Indicates whether the disk drive is encrypted. This can be one of the following values.
| |||||
firmware | Array of objects | (M.2 and NVM3 drives only) Information about firmware | |||||
build | String | Firmware build. | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date. | |||||
deviceTypeKey | String | ||||||
name | String | Firmware name. | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version. | |||||
FRU | String | FRU | |||||
healthState | String | Health state (translated). This can be one of the following values.
| |||||
healthStateKey | String | Health state key. This can be one of the following values.
| |||||
hotSpareType | String | Type of hot spare drive. This can be one of the following values.
| |||||
interfaceType | String | Interface type | |||||
largestAvailableSize | Integer | Largest available size | |||||
m2Location | String | (M.2 drives only) Location of M.2 drive and bay | |||||
manufacturer | String | Manufacturer | |||||
mediaType | String | Media type | |||||
model | String | Model | |||||
name | String | Drive name | |||||
numberOfBlocks | Long | Number of blocks | |||||
partNumber | String | Part number | |||||
remainingLife | Integer | Indicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values.
| |||||
serialNumber | String | Serial number | |||||
temperature | Integer | Device temperature | |||||
uuid | String | UUID | |||||
firmware | Array of objects | Information about firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
name | String | Firmware name | |||||
revision | Firmware revision | ||||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | Firmware ID | ||||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
isAddOnCard | Boolean | Identifies whether the RAID adapter is an add-on card. This can be one of the following values.
| |||||
model | String | Model | |||||
name | String | RAID devices name | |||||
pciFirmware | Array of objects | ||||||
slotNumber | String | RAID adapter slot number If the RAID adapter is an on-board adapter, this value is null. | |||||
storagePools | Array of objects | Information about each storage pool | |||||
arrayUid | String | Storage array ID | |||||
arrayStatus | String | Storage array status | |||||
combinedRaidLevel | String | Combined RAID level. This can be one of the following values.
Note RAID level 0, 1, or 5 are supported on all serves. RAID level 6, 10, 50, 60, and 00 are supported only on ThinkSystem servers with XCC version 2.1 and later. (ThinkSystem SR950 requires XCC version 1.4 or later). | |||||
diskDrives | Array of objects | Information about each disk drive in the storage pool | |||||
bay | Integer | Bay | |||||
blockSize | Integer | Block size | |||||
capacity | Long | Storage capacity | |||||
description | String | Drive description | |||||
diskState | String | Drive state | |||||
firmware | Array of objects | Information about disk-drive firmware | |||||
build | String | Firmware build | |||||
classifications | Array of integers | Firmware type codes | |||||
date | String | Firmware date | |||||
name | String | Firmware name | |||||
revision | String | Firmware revision | |||||
role | String | Firmware role. This can be one of the following values.
| |||||
softwareID | String | Firmware ID | |||||
status | String | Firmware status. This can be one of the following values.
| |||||
type | String | Firmware type, such as UEFI, MP, or DSA | |||||
version | String | Firmware version | |||||
FRU | String | Drive FRU | |||||
healthState | String | Drive health status. This can be one of the following values.
| |||||
interfaceType | String | Drive interface type | |||||
largestAvailableSize | Integer | Largest available size | |||||
m2Location | String | M.2 location | |||||
manufacturer | String | Drive manufacturer | |||||
mediaType | String | Media type | |||||
model | String | Drive model | |||||
name | String | Drive name | |||||
numberOfBlocks | Long | Number of blocks | |||||
remainingLife | Integer | Indicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values.
| |||||
partNumber | String | Drive part number | |||||
serialNumber | String | Drive serial number | |||||
uuid | String | Drive UUID | |||||
description | String | Storage description | |||||
name | String | Storage name | |||||
raidLevel | Integer | RAID level | |||||
remainingSpace | Integer | Remaining space | |||||
totalManagedSpace | Long | ||||||
storageVolumes | Array of objects | Information about each storage volume | |||||
accessPermission | String | ||||||
blockSize | Integer | ||||||
bootable | Boolean | ||||||
description | String | ||||||
driveIndex | Integer | ||||||
health | String | ||||||
isSDRAID | String | ||||||
LUN | Integer | ||||||
name | String | ||||||
numberOfBlocks | Long | ||||||
primaryPartition | Integer | ||||||
removable | Boolean | ||||||
stripeSize | Integer | ||||||
targetType | String | ||||||
volumeID | String | ||||||
volumeStatus | String | ||||||
volumeType | String | ||||||
volumeOwner | String | ||||||
volumeUID | String | ||||||
uuid | String | RAID device UUID | |||||
releaseName | String | Release name | |||||
securityDescriptor | Object | Information about the authentication enablement and support the associated stored credentials for a managed device | |||||
identityManagementSystemEnabled | Boolean | Indicates whether to use an identity-management system for authentication. This can be one of the following values.
| |||||
managedAuthEnabled | Boolean | Indicates whether the device uses managed authentication. This can be one of the following values.
| |||||
managedAuthSupported | Boolean | Indicates whether the device supports the ability to choose whether managed authentication is to be used. This can be one of the following values.
| |||||
publicAccess | Boolean | Indicates whether the device can be accessed by all role groups. This can be one of the following values.
| |||||
roleGroups | Array of strings | List of role groups that are permitted to view and manage this device | |||||
storedCredentials | object | Information about the stored credential that is associated with this device, if applicable | |||||
id | String | Description of the stored credential | |||||
description | String | ID of the stored credential | |||||
userName | String | Name of the stored credential | |||||
uri | String | URI of the device | |||||
securityMode | String | Security Mode. This can be one of the following values.
| |||||
selLog | Boolean | Indicates whether the SEL log is supported and present on this server. This can be one of the following values.
| |||||
serialNumber | String | Device serial number | |||||
slots | Array of integers | List of occupied slots | |||||
ssdWearThreshold | Integer | ||||||
ssoEnabled | Boolean | Indicates whether single sign-on is enabled. This can be one of the following values.
| |||||
subSlots | String | Information about management status | |||||
systemBoard | Object | Information about the system board | |||||
machineType | String | Device machine type | |||||
model | String | Device model | |||||
productName | String | Product name | |||||
serialNumber | String | Device serial number | |||||
uuid | String | Device UUID | |||||
techTipsCount | Integer | Number of tech tips that are associated with this device For information about each tech tip, use GET /api/v1/data/techTips. | |||||
thinkServerFru | Array of Strings | (ThinkServer servers only) | |||||
type | String | Resource type (translated). This can be one of the following values.
| |||||
typeKey | String | Resource type key. This can be one of the following values.
| |||||
updates | Object | (XClarity Administrator only) Information about the update history for the resource manager | |||||
identifier | String | Update ID | |||||
components | Array of objects | Information about each update component | |||||
componentID | String | Component ID | |||||
cveDetails | Object | Information about available CVEs for this component | |||||
availableFixes | Integer | Total number of CVEs available for this component | |||||
cveList | Array of strings | List of CVEs that are available for the component | |||||
id | String | ||||||
fixedVersion | Object | ||||||
identifier | String | ||||||
number | String | ||||||
releaseTimestamp | String | ||||||
name | String | CVE name | |||||
publishDate | String | Timestamp when the CVE was published | |||||
severity | String | Highest severity (translated) of all CVEs for the component. This can be one of the following values.
| |||||
_link | Object | CVE link (see Links) | |||||
fixedVersion | Object | ||||||
identifier | String | ||||||
number | String | ||||||
releaseTimestamp | String | ||||||
severity | String | Highest severity (translated) of all CVEs for the component. This can be one of the following values.
| |||||
severityKey | String | Highest severity key of all CVEs for the component. This can be one of the following values.
| |||||
_severity | Object | Information about the severity weight | |||||
name | String | Highest severity key of all CVEs for the component. This can be one of the following values.
| |||||
weight | Integer | Weight of the severity | |||||
firmwareActivationStatus | String | ||||||
firmwareActivationStatusKey | String | ||||||
mainComponentName | String | Main component name | |||||
name | String | Component name | |||||
policyState | String | Policy state (translated). This can be one of the following values.
| |||||
policyStateKey | String | Policy state key. This can be one of the following values.
| |||||
targetVersion | Object | Information about the target update for the component based on the assigned policy If a policy is not assigned, this value is null. | |||||
identifier | String | Version ID | |||||
number | String | Version number | |||||
releaseTimestamp | String | Timestamp when the version was released This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
upgradeable | Boolean | Indicates whether the component can be updated. This can be one of the following values.
| |||||
version | Object | Information about the update that is currently installed for the component | |||||
identifier | String | Version ID | |||||
number | String | Version number | |||||
releaseTimestamp | String | Timestamp when the version was released This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
cveDetails | Object | Information about available CVEs for the update | |||||
availableFixes | Integer | Total number of CVEs available for the update | |||||
severity | String | Highest severity (translated) of all CVEs in the the update. This can be one of the following values.
| |||||
severityKey | String | Highest severity key of all CVEs in the the update. This can be one of the following values.
| |||||
policy | Object | Information about the update-compliance policy that is assigned to this device If a policy is not assigned, this value is null. | |||||
id | String | Policy ID | |||||
name | String | Policy name | |||||
policyState | String | Policy state (translated). This can be one of the following values.
| |||||
policyStateKey | String | Policy state key. This can be one of the following values.
| |||||
userDefinedName | String | User-defined name for the device | |||||
userDescription | String | User description | |||||
uuid | String | UUID | |||||
vnicMode | String | VNIC mode. This can be one of the following values.
| |||||
vpdID | String | VPD ID | |||||
warranty | Object | Information about the warranty for this device | |||||
endTimestamp | String | Warranty expiration date This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
number | String | Warranty number. This can be one of the following values.
| |||||
startTimestamp | String | Warranty start date This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||||
status | String | Warranty status key (translated). This can be one of the following values.
| |||||
statusKey | String | Warranty status key. This can be one of the following values.
| |||||
_links | Object | Device URI (see Links) | |||||
_rawType | String |
{
"id": "198B27F09DE84EFA808FD670B9D1F71F-B2950AF32CA74EF79A9D62DCBAAC6B01",
"accessState": "Online",
"accessStateKey": "Online",
"accurateHealth": true,
"activationKeys": [{
"description": "Lenovo XClarity Controller 2 Platinum Upgrade",
"keyExpirationDate": "",
"keyFeatureType": 74,
"keyIdentiferList": [{
"keyIdentifier": "7D9D1234567890",
"keyIdentifierType": "MT"
}],
"keyStatus": "VALID",
"keyUseCount": 0,
"keyUseLimit": 0,
"uuid": ""
}],
"addinCards": [{
"class": "Network controller",
"firmware": [ {
"build": "0",
"classifications": [ 13 ],
"date": "",
"deviceTypeKey": "software bundle",
"name": "Firmware Bundle",
"revision": "0",
"role": "",
"softwareID": "17AA4104",
"status": "Active",
"type": "Software Bundle",
"version": "227.0.3.1"
}],
"fodUniqueID": "",
"FRU": "01PE761",
"fruSerialNumber": "01PE761",
"isAddOnCard": true,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"manufacturer": "Broadcom Limited",
"name": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"partNumber": "SN37A28309",
"pciBusNumber": "65",
"pciDeviceNumber": "0",
"pciFunctionNumber": "0",
"pciRevision": "0x0001",
"pciSegmentNumber": "0",
"pciSubID": "0x4104",
"pciSubVendorID": "0x17aa",
"portInfo": {
"physicalPorts": [{
"logicalPorts": [{
"addresses": "e4:3d:1a:63:e6:ec",
"logicalPortIndex": 1,
"portNumber": 1,
"portType": "ETHERNET",
"vnicMode": false
}],
"peerBay": 0,
"physicalPortIndex": 1,
"portType": "ETHERNET",
"portNumber": 1,
"speed": "N/A",
"status": "Down"
}]
},
"posID": "0x1657",
"productName": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"slotName": "PCIe 6",
"slotNumber": "6",
"slotSupportsHotPlug": "false",
"vpdID": "0x14e4"
},
...,
{
"class": "Network controller",
"firmware": [{
"build": "0",
"classifications": [13],
"date": "",
"deviceTypeKey": "software bundle",
"name": "Firmware Bundle",
"revision": "0",
"role": "",
"softwareID": "17AA4104",
"status": "Active",
"type": "Software Bundle",
"version": "227.0.3.1"
}],
"fodUniqueID": "",
"FRU": "01PE761",
"fruSerialNumber": "01PE761",
"isAddOnCard": true,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"manufacturer": "Broadcom Limited",
"name": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"partNumber": "SN37A28309",
"pciBusNumber": "65",
"pciDeviceNumber": "0",
"pciFunctionNumber": "3",
"pciRevision": "0x0001",
"pciSegmentNumber": "0",
"pciSubID": "0x4104",
"pciSubVendorID": "0x17aa",
"portInfo": {
"physicalPorts": [{
"logicalPorts": [{
"addresses": "e4:3d:1a:63:e6:ef",
"logicalPortIndex": 1,
"portNumber": 1,
"portType": "ETHERNET",
"vnicMode": false
}],
"peerBay": 0,
"physicalPortIndex": 4,
"portType": "ETHERNET",
"portNumber": 4,
"speed": 1,
"status": "Up"
}]
},
"posID": "0x1657",
"productName": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"slotName": "PCIe 6",
"slotNumber": "6",
"slotSupportsHotPlug": "false",
"vpdID": "0x14e4"
}],
"assetTag": "",
"description": "This resource is used to represent a chassis or other physical
enclosure for a Redfish implementation.",
"deviceInfo": {
"domainName": null,
"entitleSerialNumber": null,
"groupNames": [],
"healthStatus": "Warning",
"healthStatusKey": "Warning",
"hostname": "XCC-MTM-SN",
"ipv4Addresses": [ "10.240.193.125" ],
"ipv6Addresses": [ "2002:97b:c2bb:830:922e:16ff:fe0a:1597", "fe80::922e:16ff:fe0a:1597",
"fe80::922e:16ff:fe0a:1598" ],
"location": {
"location": "",
"lowestRackUnit": 1,
"rack": "",
"room": ""
},
"machineType": "7D9D",
"manager": {
"id": "B2950AF32CA74EF79A9D62DCBAAC6B01",
"domainName": "",
"fqdn": null,
"hostname": "xc1h",
"inContextHref": "/ui/index.html#/compDetails/Rack-Tower Server/198B27F09DE84EFA808FD670B9D1F71F/",
"ipv4Addresses": [ "10.240.197.128" ],
"ipv6Addresses": []
},
"model": "MT110D",
"powerStatus": "On",
"powerStatusKey": "On",
"productName": "ThinkSystem SR645 V3 MB,Genoa,DDR5,Oahu,1U",
"serialNumber": "1234567890",
"userDefinedName": "Oahu",
"uuid": "198B27F09DE84EFA808FD670B9D1F71F",
},
"deviceName": "Oahu",
"deviceType": "Server",
"deviceTypeKey": "server",
"discoveryTimestamp": "2024-05-16T05:01:49.303Z",
"drives": [],
"encapsulation": {
"encapsulationMode": "normal"
},
"fans": [{
"description": "Fan Fan 1 Front Tach",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "Fan 1 Front Tach",
"slot": "1",
"slots": 1,
"speed": 7552,
"status": "OK"
},
...,
{
"description": "Fan Fan 8 Rear Tach",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "Fan 8 Rear Tach",
"slot": "8",
"slots": 8,
"speed": 6264,
"status": "OK"
}],
"featuresOnDemand": {
"features": [ "RDOC", "REMOTE CONTROL 6 USERS", "REMOTE MEDIA" ],
"tierLevel": 3
},
"firmware": [{
"build": "KAX319G",
"classifications": [ "10" ],
"date": "2023-11-02T00:00:00Z",
"deviceTypeKey": "xcc",
"firmwareActivationStatus": "Active",
"firmwareActivationStatusKey": "Active",
"name": "XClarity Controller",
"revision": "2.62",
"role": "Primary",
"status": "Active",
"type": "XCC",
"version": "2.62"
},
...,
{
"build": "Unknown",
"classifications": [],
"date": "",
"deviceTypeKey": "lxum",
"firmwareActivationStatus": "Inactive",
"firmwareActivationStatusKey": "Inactive",
"name": "Lenovo XClarity Update Manager",
"revision": "Unknown",
"role": "Primary",
"status": "Inactive",
"type": "LXUM",
"version": "Unknown"
}],
"groups": [],
"height": 1,
"hostname": "XCC-MTM-SN",
"ipInterfaces": [{
"IPv4assignments": [{
"id": 0,
"address": "10.240.193.125",
"deviceTypeKey": "inuse",
"gateway": "10.240.193.1",
"subnet": "255.255.255.0",
"type": "INUSE"
}],
"IPv4DHCPmode": "STATIC_ONLY",
"IPv4enabled": true,
"IPv6assignments": [{
"id": 0,
"address": "2002:97b:c2bb:830:922e:16ff:fe0a:1597",
"deviceTypeKey": "inuse",
"gateway": "0:0:0:0:0:0:0:0",
"prefix": 64,
"scope": "Global",
"source": "Stateless",
"type": "INUSE",
},
...,
{
"id": 0,
"address": "fe80:0:0:0:922e:16ff:fe0a:1598",
"deviceTypeKey": "inuse",
"gateway": "0:0:0:0:0:0:0:0",
"prefix": 64,
"scope": "LinkLocal",
"source": "Other",
"type": "INUSE"
}],
"IPv6DHCPenabled": false,
"IPv6enabled": true,
"IPv6statelessEnabled": true,
"IPv6staticEnabled": false,
"label": "unknown",
"name": "Manager Ethernet Interface"
}],
"ipv4Addresses": [ "10.240.193.125" ],
"ipv6Addresses": [ "2002:97b:c2bb:830:922e:16ff:fe0a:1597", "fe80::922e:16ff:fe0a:1597",
"fe80::922e:16ff:fe0a:1598" ],
"isEmbedded": false,
"lanOverUsb": "disabled",
"lanOverUsbPortForwardingModes": [{
"deviceTypeKey": "osdeploy",
"externalIPAddress": "",
"state": "disabled",
"type": "OSDeploy"
}],
"lastSyncTimestamp": "2024-05-17T06:47:31.428Z",
"lastUpdateTimestamp": "2024-05-17T06:47:31.365Z",
"leds": [{
"color": "Green",
"location": "Planar",
"name": "BMC Heartbeat",
"state": "Blinking"
},
...,
{
"color": "Amber",
"location": "Planar",
"name": "CPU2",
"state": "Off"
}],
"location": {
"location": "",
"lowestRackUnit": 1,
"rack": "",
"room": ""
},
"lxcaOverallHealthState": "Warning",
"lxcaUUID": "B2950AF32CA74EF79A9D62DCBAAC6B01",
"machineType": "7D9D",
"manager": {
"id": "B2950AF32CA74EF79A9D62DCBAAC6B01",
"domainName": "",
"fqdn": null,
"groups": [],
"hostname": "xc1h",
"inContextHref": "/ui/index.html#/compDetails/Rack-Tower Server/198B27F09DE84EFA808FD670B9D1F71F/",
"ipv4Addresses": [ "10.240.197.128" ],
"ipv6Addresses": [],
"uri": "/api/v1/connector/managers/B2950AF32CA74EF79A9D62DCBAAC6B01"
},
"manufacturer": "Lenovo",
"manufacturerId": "Lenovo",
"memoryModules": [{
"capacity": 16,
"deviceTypeKey": "ddr5",
"displayName": "DIMM 7",
"fruPartNumber": "",
"healthState": "NA",
"healthStateKey": "NA",
"manufacturer": "Samsung",
"metrics": {
"alarmTrips": {}
},
"model": "DDR5",
"operatingMemoryMode": [ "Volatile" ],
"partNumber": "M321R2GA3BB6-CQKMG",
"present": false,
"serialNumber": "80CE012210029FBA98",
"slot": 7,
"speed": 4800,
"type": "DDR5",
}],
"mgmtProcIPaddress": "10.240.193.125",
"mgmtProcType": "XCC2",
"model": "MT110D",
"mtm": "7D9D/MT110D",
"name": "Oahu",
"onboardPciDevices": [{
"class": "Display controller",
"firmware": [],
"fodUniqueID": "",
"isAddOnCard": false,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"name": "Onboard VGA",
"pciBusNumber": "197",
"pciDeviceNumber": "0",
"pciFunctionNumber": "0",
"pciRevision": "0x0052",
"pciSegmentNumber": "0",
"pciSubID": "0x2000",
"pciSubVendorID": "0x1a03",
"portInfo": {},
"posID": "0x2000",
"vpdID": "0x1a03"
},
...,
{
"class": "Mass storage controller",
"firmware": [],
"fodUniqueID": "",
"isAddOnCard": false,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"name": "Onboard SATA Controller",
"pciBusNumber": "199",
"pciDeviceNumber": "0",
"pciFunctionNumber": "1",
"pciRevision": "0x0091",
"pciSegmentNumber": "0",
"pciSubID": "0x7901",
"pciSubVendorID": "0x1022",
"portInfo": {},
"posID": "0x7901",
"vpdID": "0x1022"
}],
"osProfiles": {
"applicableStatus": "No Profile Assigned",
"applicableStatusKey": "NoProfileAssigned",
"assigned": {
"id": null,
"name": "No Assignment",
"uri": null
},
"deployStatus": "Ready",
"deployStatusKey": "ready"
},
"overallHealthState": "Warning",
"overallHealthStateKey": "Warning",
"patterns": {
"assigned": {
"id": null,
"name": "No Assignment"
},
"complianceStatus": "No Pattern Assigned",
"complianceStatusKey": "NoPatternAssigned"
},
"partNumber": "STA7B07502",
"pciDevices": [{
"class": "Display controller",
"firmware": [],
"fodUniqueID": "",
"isAddOnCard": false,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"name": "Onboard VGA",
"pciBusNumber": "197",
"pciDeviceNumber": "0",
"pciFunctionNumber": "0",
"pciRevision": "0x0052",
"pciSegmentNumber": "0",
"pciSubID": "0x2000",
"pciSubVendorID": "0x1a03",
"portInfo": {},
"posID": "0x2000",
"vpdID": "0x1a03"
},
...,
{
"class": "Network controller",
"firmware": [{
"build": "0",
"classifications": [ 13 ],
"date": "",
"deviceTypeKey": "software bundle",
"name": "Firmware Bundle",
"revision": "0",
"role": "",
"softwareID": "17AA4104"
"status": "Active",
"type": "Software Bundle",
"version": "227.0.3.1",
}],
"fodUniqueID": "",
"FRU": "01PE761",
"fruSerialNumber": "01PE761",
"isAddOnCard": true,
"isAgentless": false,
"isPLDMUpdateSupported": false,
"manufacturer": "Broadcom Limited",
"name": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"partNumber": "SN37A28309",
"pciBusNumber": "65",
"pciDeviceNumber": "0",
"pciFunctionNumber": "0",
"pciRevision": "0x0001",
"pciSegmentNumber": "0",
"pciSubID": "0x4104",
"pciSubVendorID": "0x17aa",
"portInfo": {
"physicalPorts": [{
"logicalPorts": [{
"addresses": "e4:3d:1a:63:e6:ec",
"logicalPortIndex": 1,
"portNumber": 1,
"portType": "ETHERNET",
"vnicMode": false
}],
"peerBay": 0,
"physicalPortIndex": 1,
"portType": "ETHERNET",
"portNumber": 1,
"speed": "N/A",
"status": "Down"
}]
},
"posID": "0x1657",
"productName": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
"slotName": "PCIe 6",
"slotNumber": "6",
"slotSupportsHotPlug": "false",
"vpdID": "0x14e4"
}],
"powerAllocation": {
"maximumAllocatedPower": 1800,
"minimumAllocatedPower": 0
},
"powerCappingPolicy": {
"cappingACorDCMode": "AC",
"cappingPolicy": "Unknown",
"currentPowerCap": 0,
"maximumPowerCappingHotPlugLevel": -1,
"maxPowerCap": 1800000,
"minimumHardCapLevel": 0,
"minimumPowerCappingHotPlugLevel": -1,
"minPowerCap": 0,
"powerCappingAllocUnit": "watts*10^-3"
},
"powerStatus": "On",
"powerStatusKey": "On",
"powerSupplies": [{
"cmmDisplayName": "Power Supply 1",
"cmmHealthState": "Unknown",
"dataHandle": 0,
"description": "Power Supply 1",
"deviceTypeKey": "powersupply"
"excludedHealthState": "Normal",
"firmware": [{
"build": null,
"classifications": [ 10 ],
"date": "",
"deviceTypeKey": "firmware",
"name": "PSU1",
"role": "OK",
"status": "OK",
"softwareID": "PSUARTE7100",
"type": "Firmware",
"version": "6.52"
}],
"FRU": "",
"fruSerialNumber": "",
"hardwareRevision": "",
"healthState": "Normal",
"healthStateKey": "Normal",
"inputVoltageIsAC": true,
"inputVoltageMax": -1,
"inputVoltageMin": -1,
"leds": [],
"machineType": "",
"manufactureDate": "",
"manufacturer": "ARTE",
"manufacturerId": "",
"model": "",
"name": "Power Supply 1",
"overallHealthState": "Normal",
"overallHealthStateKey": "Normal",
"parent": {
"uri": "chassis/",
"uuid": ""
},
"partNumber": "SP57A96595",
"posID": "",
"powerAllocation": {
"totalInputPower": 0,
"totalOutputPower": 1800
},
"powerState": "Unknown",
"productId": "",
"productName": "",
"serialNumber": "P2ZS26G0216",
"slots": [1],
"type": "PowerSupply",
"uri": "powerSupply/",
"userDescription": "",
"uuid": "",
"vpdID": ""
}],
"processors": [{
"cores": 96,
"displayName": "AMD Eng Sample: 100-000000894-04",
"family": "AMD_ZEN_PROCESSOR_FAMILY",
"healthState": "GOOD",
"healthStateKey": "GOOD",
"manufacturer": "Advanced Micro Devices, Inc.",
"maxSpeedMHZ": 3700,
"partNumber": "Unknown",
"present": false,
"productVersion": "AMD Eng Sample: 100-000000894-04",
"serialNumber": "0x02B60EB2C4ED0031",
"slot": 1,
"socket": "CPU 1",
"speed": 2.15,
"tdpWatts": 360
}],
"productId": "664A00",
"productName": "ThinkSystem SR645 V3 MB,Genoa,DDR5,Oahu,1U",
"raidSettings": [],
"securityMode": "Compatibility Security",
"serialNumber": "1234567890",
"ssdWearThreshold": 8,
"ssoEnabled": false,
"systemBoard": {
"machineType": "7D9D",
"model": "MT110D",
"productName": "ThinkSystem SR645 V3 MB,Genoa,DDR5,Oahu,1U",
"serialNumber": "1234567890",
"uuid": "198B27F09DE84EFA808FD670B9D1F71F"
},
"type": "server",
"updates": {
"identifier": "7D9D",
"components": [{
"componentID": "XCC",
"cveDetails": {
"availableFixes": 0,
"cveList": [],
"fixedVersion": null,
"severity": "Protected",
"severityKey": "protected",
"_severity": {
"name": "protected",
"weight": 0
}
},
"firmwareActivationStatus": "Active",
"firmwareActivationStatusKey": "Active",
"mainComponentName": "XClarity Controller",
"name": "XClarity Controller",
"policyState": "No Policy Assigned",
"policyStateKey": "NoPolicyAssigned",
"targetVersion": null,
"upgradeable": true,
"version": {
"identifier": "KAX319G",
"number": "2.62",
"releaseDate": "2023-11-02T00:00:00Z"
}
},
...,
{
"componentID": "UEFI",
"cveDetails": {
"severity": "Protected",
"severityKey": "protected",
"availableFixes": 0,
"fixedVersion": null,
"cveList": [],
"_severity": {
"name": "protected",
"weight": 0
}
},
"firmwareActivationStatus": "Active",
"firmwareActivationStatusKey": "Active",
"mainComponentName": "Unified Extensible Firmware Interface",
"name": "Unified Extensible Firmware Interface",
"policyState": "No Policy Assigned",
"policyStateKey": "NoPolicyAssigned",
"targetVersion": null,
"upgradeable": true,
"version": {
"identifier": "KAE119A",
"number": "4.20",
"releaseDate": "2024-04-10T00:00:00Z"
}
}]
"cveDetails": {
"availableFixes": 0,
"severity": "Protected",
"severityKey": "protected"
}
"policy": {
"name": "No Assignment",
"id": null
},
"policyState": "No Policy Assigned",
"policyStateKey": "NoPolicyAssigned"
},
"userDefinedName": "Oahu",
"uuid": "198B27F09DE84EFA808FD670B9D1F71F",
"warranty": {
"endTimestamp": "2019-12-10T00:00:00.000Z",
"number": "TC0",
"startTimestamp": "2019-10-30T00:00:00.000Z",
"status": "Expired",
"statusKey": "Expired"
},
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/198B27F09DE84EFA808FD670B9D1F71F-B2950AF32CA74EF79A9D62DCBAAC6B01"
},
"_rawType": "server"
}