GET /nodes

Use this GET method to retrieve properties for all servers, Flex System storage devices, and Flex System storage controllers (canisters).

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/nodes

Query parameters

Parameters Required / Optional Description
excludeAttributes=<attributes> Optional Returns a response that excludes the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • When the includeAttributes query parameter is specified, the excludeAttributes query parameter is ignored.

  • The response is filtered based on attribute name, not the attribute value.

  • Base attributes cannot be excluded.

formatType=<type> Optional Returns information in the specified format. This can be one of the following values.
  • json (default)
  • csv

If the format type is not specified, JSON format is returned.

includeAttributes=<attributes> Optional Returns a response that includes the base attributes and the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • The response is filtered based on attribute name, not the attribute value.

  • If this attribute is not specified, all attributes are returned by default.

status=<string> Optional Status. This can be one of the following values.
  • unmanaged. Returns unmanaged nodes only
  • managed. Returns managed nodes only
The following example returns a CSV file that contains information about all managed servers and storage devices.
GET https://192.0.2.0/nodes?status=managed&formatType=csv

Request body

None

Response codes

Code Description
200 OK.
400 Bad request. The lock request could not be processed based on the request body.
401 Unauthorized
403 Forbidden. The server could not authenticate this session.
409 Conflict. A lock required for one device was already held by at least one other job.
500 Internal server error. An internal error occurred.

Response body

Note: In XClarity Administrator v1.4.x and earlier, GET /nodes returns the canister attribute as a child under the enclosure attribute. For XClarity Administrator v2.0.0 and later, GET /nodes returns the canister attribute as a child under the enclosure attribute and also as a peer to the enclosure attribute (in duplication).

For GET /nodes/<UUID_list>, the canister attribute is only returned as a child under the enclosure attribute.

Attributes Type Description
nodeList Array List of all servers and storage devices
  See GET /nodes/<UUID_list> Object Detailed information about the individual server or storage device

Response example

The following example response lists information about a System x server in JSON format.

{ "nodeList": [{
   "accessState": "Online",
   "activationKeys": [],
   "addinCards": [],
   "addinCardSlots": 1,
   "arch": "x86",
   "backedBy": "real",
   "bladeState": 1,
   "bladeState_health": "GOOD",
   "bladeState_string": "Ventura 2.48",
   "bootMode": {
      "currentValue": "UEFI Mode",
      "possibleValues": ["UEFI Mode", "Legacy Mode"]
   },
   "bootOrder": {
      "bootOrderList": [{
         "bootType": "BootOrder",
         "currentBootOrderDevices": [],
         "possibleBootOrderDevices": [
            "Red Hat Enterprise Linux", 
            "CD/DVD Rom",
            "Hard Disk",
            "Network",
            "USB Storage"
         ]
      },
      ...,
      {
         "bootType": "NetworkBootOrder",
         "currentBootOrderDevices": [],
         "possibleBootOrderDevices": [
            "UEFI:   PXE IP4 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/0",
            "UEFI:   PXE IP6 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/0",
            "UEFI:   PXE IP4 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/1",
            "UEFI:   PXE IP6 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/1",
            "UEFI:   PXE IP4 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/2",
            "UEFI:   PXE IP6 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/2",
            "UEFI:   PXE IP4 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/3",
            "UEFI:   PXE IP6 Intel(R) Ethernet Connection X722 for 10GbE backplane OnBoard:B/0/3"
         ]
      }],
      "uri": "nodes/28E72489F2DD11E6AA97BEE0E71B9FB0/bootOrder"
   },
   "cmmDisplayName": "Node 10",
   "cmmHealthState": "Normal",
   "complexID": -1,
   "contact": "contact",
   "dataHandle": 1519318053889,
   "description": "ThinkSystem SN550",
   "dnsHostnames": ["xhmc135.labs.lenovo.com", "fd55:faaf:e1ab:2021:7ed3:aff:fece:3bfd"],
   "domainName": "labs.lenovo.com",
   "driveBays": 4,
   "drives": [{
      "bay": 1,
      "capacity": -1
   },
   ...,
   {
      "bay": 4,
      "capacity": -1
   }],
   "embeddedHypervisorPresence": false,
   "encapsulation": {
      "encapsulationMode": "normal"
   },
   "errorFields": [],
   "excludedHealthState": "Normal",
   "expansionCards": [],
   "expansionCardSlots": 2,
   "expansionProducts": [],
   "expansionProductType": "",
   "faceplateIDs": [{
      "deviceId": 151,
      "entityId": 15,
      "name": "drive backplane 5",
      "posID": 22,
      "productId": 1134,
      "vpdID": 114
   },
   ...,
   {
      "deviceId": 0,
      "entityId": 0,
      "name": "system board 1",
      "posID": 0,
      "productId": 0,
      "vpdID": 0
   }],
   "FeaturesOnDemand": {
      "features": ["RDOC", "REMOTE MEDIA", "REMOTE CONTROL 6 USERS"],
      "tierLevel": 3
   },
   "firmware": [{
      "build": "PDL303R",
      "date": "2017-07-23T00:00:00Z",
      "name": "LXPM Windows Drivers",
      "role": "Primary",
      "type": "DRVWN",
      "status": "Active",
      "version": "1.00"
   },
   ...,
   {
      "build": "TEI321E",
      "date": "2017-11-23T00:00:00Z",
      "name": "XCC Backup Firmware",
      "role": "Backup",
      "status": "Inactive",
      "type": "XCC-Backup",
      "version": "1.60"
   }],
   "flashStorage": [],
   "FQDN": "xhmc135.labs.lenovo.com",
   "FRU": "00YD096",
   "fruSerialNumber": "R5SH72E001L",
   "hasOS": false,
   "hostMacAddresses": "7C:D3:0A:CE:38:F8,7C:D3:0A:CE:3B:F9,7C:D3:0A:CE:3B:FA,7C:D3:0A:CE:3B:FB",
   "hostname": "XCC-7X16-1234567890",
    "ipInterfaces": [{
           "IPv4assignments": [{
               "id": 0,
               "subnet": "255.255.224.0",
               "gateway": "0.0.0.0",
               "address": "10.243.6.71",
               "type": "INUSE"
           }],
           "IPv6DHCPenabled": true,
           "IPv4enabled": true,
           "IPv6assignments": [{
               "id": 0,
               "scope": "LinkLocal",
               "gateway": "0:0:0:0:0:0:0:0",
               "source": "Other",
               "address": "fe80:0:0:0:42f2:e9ff:feaf:ffd",
               "prefix": 64,
               "type": "INUSE"
           },
           {
               "id": 0,
               "scope": "Global",
               "gateway": "0:0:0:0:0:0:0:0",
               "source": "Stateless",
               "address": "fd55:faaf:e1ab:2021:42f2:e9ff:feaf:ffd",
               "prefix": 64,
               "type": "INUSE"
           }],
           "IPv4DHCPmode": "STATIC_ONLY",
           "IPv6enabled": true,
           "IPv6statelessEnabled": true,
           "IPv6staticEnabled": false
           "label": "unknown",
           "name": "eth0",
       },
       {
           "IPv4assignments": [{
               "id": 0,
               "subnet": "255.255.0.0",
               "gateway": "0.0.0.0",
               "address": "169.254.95.118",
               "type": "CONFIGURED"
           }],
           "IPv4DHCPmode": "STATIC_ONLY",
           "IPv4enabled": true,
           "IPv6assignments": [],
           "IPv6DHCPenabled": false,
           "IPv6enabled": false,
           "IPv6statelessEnabled": false,
           "IPv6staticEnabled": false
           "label": "unknown",
           "name": "ethernet-over-usb",
       }],
   "ipv4Addresses": ["10.243.2.48", "169.254.95.118"],
   "ipv6Addresses": [
      "fd55:faaf:e1ab:2021:7ed3:aff:fece:3bfd", 
      "fe80:0:0:0:7ed3:aff:fece:3bfd", 
      "fe80:0:0:0:7ed3:aff:fece:3bfe"
   ],
   "isConnectionTrusted": "true",
   "isITME": false,
   "isRemotePresenceEnabled": true,
   "isScalable": false,
   "lanOverUsb": "enabled",
   "leds": [{
      "color": "Yellow",
      "location": "Planar",
      "name": "DIMM 13",
      "state": "Off"
   },
   ...,
   {
      "color": "Yellow",
      "location": "Planar",
      "name": "DIMM 10",
      "state": "Off"
   }],
   "location": {
      "location": "location",
      "rack": "",
      "lowestRackUnit": 0,
      "room": ""
   },
   "logicalID": -1,
   "m2Presence": true,
   "macAddress": "7C:D3:0A:CE:3B:FD,7C:D3:0A:CE:3B:FE",
   "machineType": "7X16",
   "manufacturer": "Lenovo",
   "manufacturerId": "19046",
   "memoryModules": [{
   "memorySlots": 24,
   "mgmtProcIPaddress": "10.243.2.48",
   "mgmtProcType": "IMM3v1",
   "model": "CTO0WW",
   "name": "Ventura 2.48",
   "nist": {
      "currentValue": "Unknown",
      "possibleValues": ["Nist_800_131A_Strict", "unsupported", "Compatibility"]
   },
   "osInfo": {
      "description": "Windows Server 2016",
      "hostname": "192.0.2.0",
      "storedCredentia": "storedCredentials/2651"
   }
   "onboardPciDevices": [{
      "class": "Mass storage controller",
      "firmware": [{
         "build": "0",
         "classifications": [0],
         "date": "",
         "name": "PCIFirmware",
         "revision": "0",
         "role": "Primary",
         "softwareID": "17aa:7805",
         "status": "Active",
         "type": "",
         "version": ""
      }],
      "fodUniqueID": "",
      "isAddOnCard": false,
      "isAgentless": false,
      "name": "",
      "pciBusNumber": "0",
      "pciDeviceNumber": "17",
      "pciFunctionNumber": "5",
      "pciRevision": "8",
      "pciSubID": "7805",
      "pciSubVendorID": "17aa",
      "portInfo": {},
      "posID": "a1d2",
      "vpdID": "8086"
   },
   ...,
   {
      "class": "Network controller",
      "firmware": [{
         "build": "0",
         "classifications": [32773],
         "date": "",
         "name": "Combined Option ROM Image",
         "revision": "0",
         "role": "Primary",
         "softwareID": "17AA4023",
         "status": "Active",
         "type": "Boot ROM",
         "version": "1.1638.0"
      },
      {
         "build": "0",
         "classifications": [10],
         "date": "",
         "name": "Etrack ID",
         "revision": "0",
         "role": "Primary",
         "softwareID": "17AA4023",
         "status": "Active",
         "type": "Firmware",
         "version": "80000C70"
      }],
      "fodUniqueID": "N/A",
      "isAddOnCard": false,
      "isAgentless": true,
      "name": "Intel X722 LOM",
      "pciBusNumber": "11",
      "pciDeviceNumber": "0",
      "pciFunctionNumber": "3",
      "pciRevision": "8",
      "pciSubID": "4023",
      "pciSubVendorID": "17aa",
      "portInfo": {
         "physicalPorts": [{
            "logicalPorts": [{
               "portType": "ETHERNET",
               "addresses": "7CD30ACE3BFB",
               "vnicMode": false,
               "logicalPortIndex": 1,
               "portNumber": 1
            }],
            "peerBay": 2,
            "portNumber": 4,
            "portType": "ETHERNET",
            "physicalPortIndex": 4
         }]
      },
      "posID": "37ce",
      "vpdID": "8086",
   }],
   "overallHealthState": "Normal",
   "parent": {
      "uri": "chassis/C8C3C41A21584C3284977D8D8AABD1D0",
      "uuid": "C8C3C41A21584C3284977D8D8AABD1D0"
   },
   "partitionID": -1,
   "partNumber": "SB27A11996",
   "pciCapabilities": [
      "Raid Link", 
      "OOB PCIe", 
      "Raid Link Config", 
      "Raid Link Alert", 
      "OOB PCIe Config", 
      "OOB PCIe Alert", 
      "OOB Option Firmware Update"
   ],
   "pciDevices": [{
      "class": "Network controller",
      "firmware": [{
         "build": "0",
         "classifications": [32773],
         "date": "",
         "name": "Combined Option ROM Image",
         "revision": "0",
         "role": "Primary",
         "softwareID": "8086000A",
         "status": "Active",
         "type": "Boot ROM",
         "version": "1.1638.0"
      },
      {
         "build": "0",
         "classifications": [10],
         "date": "",
         "name": "Etrack ID",
         "revision": "0",
         "role": "Primary",
         "softwareID": "8086000A",
         "status": "Active",
         "type": "Firmware",
         "version": "80002E91",
      }],
      "fodUniqueID": "N/A",
      "FRU": "01DA902",
      "fruSerialNumber": "30L21975T1MY",
      "isAddOnCard": true,
      "isAgentless": true,
      "isPLDMUpdateSupported": false
      "manufacturer": "Intel",
      "name": "Intel X710 2x10GbE SFP+ Adapter",
      "partNumber": "SN30L21975",
      "pciBusNumber": "91",
      "pciDeviceNumber": "0",
      "pciFunctionNumber": "1",
      "pciRevision": "1",
      "pciSubID": "0",
      "pciSubVendorID": "8086",
      "portInfo": {
         "physicalPorts": [{
            "logicalPorts": [{
               "addresses": "6805CA7F5AE3",
               "logicalPortIndex": 1,
               "portType": "ETHERNET",
               "portNumber": 1,
               "vnicMode": false
            }],
            "peerBay": 0,
            "physicalPortIndex": 2,
            "portType": "ETHERNET",
            "portNumber": 74,
            "speed": 0,
            "status": ""
         }]
      },
      "posID": "1572",
      "productName": "Intel X710 2x10GbE SFP+ Adapter",
      "slotName": "SlotDesig11_Slot 10",
      "slotNumber": "10",
      "slotSupportsHotPlug": "false",
      "uuid": "9DF5AEA65CEC4FE89C071A61F196F141",
      "vpdID": "8086"
   },
   ...,
   {
      "class": "Network controller",
      "firmware": [{
         "build": "0",
         "classifications": [32773],
         "date": "",
         "name": "Combined Option ROM Image",
         "revision": "0",
         "role": "Primary",
         "softwareID": "17AA4023",
         "status": "Active",
         "type": "Boot ROM",
         "version": "1.1638.0",
      },
      {
         "build": "0",
         "classifications": [10],
         "date": "",
         "name": "Etrack ID",
         "revision": "0",
         "role": "Primary",
         "softwareID": "17AA4023",
         "status": "Active",
         "type": "Firmware",
         "version": "80000C70",
      }],
      "fodUniqueID": "N/A",
      "isAddOnCard": false,
      "isAgentless": true,
     "isPLDMUpdateSupported": false
      "name": "Intel X722 LOM",
      "pciBusNumber": "11",
      "pciDeviceNumber": "0",
      "pciFunctionNumber": "3",
      "pciRevision": "8",
      "pciSubID": "4023",
      "pciSubVendorID": "17aa",
      "portInfo": {
         "physicalPorts": [{
            "logicalPorts": [{
               "addresses": "7CD30ACE3BFB",
               "logicalPortIndex": 1,
               "portNumber": 1
               "portType": "ETHERNET",
               "vnicMode": false
            }],
            "peerBay": 2,
            "physicalPortIndex": 4,
            "portNumber": 4,
            "portType": "ETHERNET"
            speed: 0,
            status: null
         }]
      },
      "posID": "37ce",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "vpdID": "8086"
   }],
   "ports": [{
      "ioModuleBay": 1,
      "portNumber": 1
   },
   ...,
   {
      "ioModuleBay": 2,
      "portNumber": 4
   }],
   "posID": "43",
   "powerAllocation": {
      "maximumAllocatedPower": 259,
      "minimumAllocatedPower": 183
   },
   "powerSupplies": [],
   "powerStatus": 8,
   "primary": false,
   "processors": [{
      "cores": 18,
      "displayName": "Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz",
      "family": "INTEL_R_XEON_TM",
      "manufacturer": "Intel(R) Corporation",
      "productVersion": "Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz",
      "slot": 1,
      "socket": "Socket 1",
      "speed": 2.3
   }],
   "processorSlots": 2,
   "productId": "1095",
   "productName": "ThinkSystem SN550",
   "raidSettings": [{
      "batteryData": [],
      "description": "ThinkSystem RAID 930-4i 2GB Flash Flex",
      "diskDrives": [{
         "bay": 1,
         "blockSize": 512,
         "capacity": 300000000000,
         "description": "AL14SEB030N",
         "diskState": "Online",
         "firmware": [{
            "build": "0",
            "classifications": [10],
            "date": "",
            "name": "Drive",
            "revision": "0",
            "role": "Primary",
            "softwareID": "AL14SEB030N",
            "status": "Active",
            "type": "Firmware",
            "version": "TB45"
         }],
         "FRU": "00YK013",
         "healthState": "Normal",
         "interfaceType": "SAS",
         "largestAvailableSize": 512,
         "m2Location": "",
         "manufacturer": "LENOVO",
         "mediaType": "Rotational",
         "model": "AL14SEB030N",
         "name": "Disk 1_9",
         "numberOfBlocks": 585937500,
         "partNumber": "D7A01862",
         "remainingLife": -3,
         "serialNumber": "SVN3PJN2",
         "uuid": "",
      },
      ...],
      "firmware": [{
         "build": "0",
         "classifications": [10],
         "date": "2017-06-15T00:00:00Z",
         "name": "MegaRAID Controller Firmware",
         "revision": "0",
         "role": "Primary",
         "softwareID": "1D490605",
         "status": "Active",
         "type": "Firmware",
         "version": "50.0.1-0374"
      }],
      "isAddOnCard": true,
      "name": "ThinkSystem RAID 930-4i 2GB Flash Flex",
      "slotNumber": "2",
      "storagePools": [{
         "arrayStatus": "Offline",
         "arrayUid": "0",
         "combinedRaidLevel": "1",
         "description": "0000000000000000500A0D1000B4A40C_Storage 
                         Pool_SAS3504_0000000000000000500A0D1000B4A40C_5:Pool:0",
         "diskDrives": [{
            "bay": 1,
            "blockSize": 512,
            "capacity": 300000000000,
            "description": "AL14SEB030N",
            "diskState": "Online",
            "firmware": [{
               "build": "0",
               "classifications": [10],
               "date": "",
               "name": "Drive",
               "revision": "0",
               "role": "Primary",
               "softwareID": "AL14SEB030N",
               "status": "Active",
               "type": "Firmware",
               "version": "TB45"
            }],
            "FRU": "00YK013",
            "healthState": "Normal",
            "interfaceType": "SAS",
            "largestAvailableSize": 512,
            "m2Location": "",
            "manufacturer": "LENOVO",
            "mediaType": "Rotational",
            "model": "AL14SEB030N",
            "name": "Disk 1_9",
            "numberOfBlocks": 585937500,
            "remainingLife": -3,
            "partNumber": "D7A01862",
            "serialNumber": "SVN3PJN2",
            "uuid": "",
         },
         ...],
         "name": "Pool_0",
         "raidLevel": 1,
         "remainingSpace": 0,
         "storageVolumes": [{
            "accessPermission": null,
            "blockSize": 512,
            "bootable": true,
            "description": "Volume 0 0000000000000000500A0D1000B4A40C_0",
            "driveIndex": 0,
            "health": "Unknown",
            "isSDRAID": null,
            "LUN": -1,
            "name": "Volume1",
            "numberOfBlocks": 583983104,
            "primaryPartition": 0,
            "removable": false,
            "stripeSize": 65536,
            "targetType": null,
            "volumeID": "2",
            "volumeStatus": "Dynamic Reconfig",
            "volumeType": null,
            "volumeOwner": null,
            "volumeUID": "0",
         }],
         "totalManagedSpace": 298999349248
      }],
      "uuid": "0000000000000000500A0D1000B4A40C"
   },
   ...],
   "secureBootMode": {
      "currentValue": "",
      "possibleValues": []
   },
   "securityDescriptor": {
      "managedAuthEnabled": true,
      "managedAuthSupported": false,
      "publicAccess": false,
      "roleGroups": [],
      "uri": "nodes/28e72489f2dd11e6aa97bee0e71b9fb0"
   },
   "serialNumber": "1234567890",
   "slots": [10],
   "status": {
      "message": "managed",
      "name": "MANAGED"
   },
   "subSlots": [],
   "subType": null,
   "tlsVersion": {
      "currentValue": "Unknown",
      "possibleValues": ["unsupported", "TLS_12", "TLS_11", "TLS_10"]
   },
   "type": "ITE",
   "uri": "nodes/28E72489F2DD11E6AA97BEE0E71B9FB0",
   "userDefinedName": "Ventura 2.48",
   "userDescription": "",
   "uuid": "28E72489F2DD11E6AA97BEE0E71B9FB0",
   "vnicMode": "disabled",
   "vpdID": "256",
}]}