GET /scalableComplex/{uuid}

Use this method to return properties for a specific scalable complex.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/scalableComplex/{uuid}

where {uuid} is the UUID of the scalable complex to be retrieved. To obtain the scalable complex UUID, use the GET /scalableComplex method.

Query parameters

Attributes Required / Optional Description
complexType={type} Optional Returns a JSON response that includes only compute nodes or rack servers. This can be one of the following values.
  • flex. Flex System compute nodes
  • rackserver. System x rack servers
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.

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.

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.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
complexID String Scalable complex ID
location Object  
  location String  
  lowestRackUnit String  
  rack String  
  room String  
nodeCount Integer Number of nodes in the scalable complex.
orphanNodes Array of node objects Information about orphan compute nodes and/or rack servers in the complex.

For a list of response attributes, see GET /nodes.

partition Array Information about partitions in the scalable complex.
  nodes Array of node objects Information about compute nodes and/or rack servers in the complex.

For a list of response attribute, see GET /nodes.

  partitionID Integer Partition ID
  uuid String UUID
partitionCount Integer Partition count in complex
uuid String UUID
The following example is returned if the request is successful.
{
   "complexID": "C29379AA380E11E39DF3000AF7256714",
   "location": {
      "location": "here",
      "lowestRackUnit": 35,
      "rack": "ZD123",
      "room": "here"
   },
   "nodeCount": 1,
   "orphanNodes": [],
  "partition": [{
     "nodes": [{
         "FRU": "None",
         "accessState": "Online",
         "activationKeys": [{
            "description": "IBM Integrated Management Module Advanced Upgrade",
            "keyExpirationDate": "",
            "keyFeatureType": 1,
            "keyIdentiferList": [{
               "keyIdentifier": "5463KVD0153",
               "keyIdentifierType": "MT"
            }],
            "keyStatus": "VALID",
            "keyUseCount": 0,
            "keyUseLimit": 0,
            "uuid": "8f0f1789295e78f9"
         }],
         "addinCardSlots": 0,
         "addinCards": [{
            "FRU": "N/A",
            "firmware": [{
               "build": "0",
               "classifications": [13],
               "date": "2015-04-06T00:00:00Z",
               "name": "LSI MegaRAID Adapter Firmware",
               "revision": "0",
               "role": "Primary",
               "softwareID": "10140454",
               "status": "Active",
               "type": "Software Bundle",
               "version": "24.7.0-0052"
            }],
            "fodUniqueID": "N/A",
            "fruSerialNumber": "SV42100396",
            "isAddOnCard": true,
            "isAgentless": true,
            "manufacturer": "IBM",
            "name": "ServeRAID M5210",
            "partNumber": "N/A",
            "pciBusNumber": "1",
            "pciDeviceNumber": "0",
            "pciFunctionNumber": "0",
            "pciRevision": "2",
            "pciSubID": "454",
            "pciSubVendorID": "1014",
            "portInfo": {,
            "posID": "5d",
            "productName": "ServeRAID M5210",
            "slotName": "SlotDesig4_Slot 4",
            "slotNumber": "4",
            "slotSupportsHotPlug": "false",
            "vpdID": "1000"
         }],
         "arch": "x86",
         "backedBy": "real",
         "bladeState": 0,
         "bootMode": {
            "currentValue": "UEFI Mode",
            "possibleValues": [
               "UEFI Mode",
               "Legacy Mode"
         ]},
         "bootOrder": {
            "bootOrderList": [{
               "bootType": "SingleUse",
               "currentBootOrderDevices": ["None"],
               "possibleBootOrderDevices": [
                  "None",
                  "PXE Network",
                  "Disk Drive 0",
                  "Diagnostics",
                  "CD/DVD Rom",
                  "Boot To F1",
                  "Hypervisor",
                  "Floppy Disk"
               ]
            },
            {
               "bootType": "Permanent",
               "currentBootOrderDevices": [
                  "CD/DVD Rom",
                  "Disk Drive 0",
                  "PXE Network"
               ],
               "possibleBootOrderDevices": [
                  "CD/DVD Rom",
                  "Disk Drive 0",
                  "PXE Network",
                  "Floppy Disk",
                  "Disk Drive 1",
                  "Disk Drive 2",
                  "Disk Drive 3",
                  "Disk Drive 4",
                  "USB Storage",
                  "Diagnostics",
                  "iSCSI",
                  "iSCSI Critical",
                  "Embedded Hypervisor",
                  "Legacy Only",
                  "IMM1",
                  "IMM2",
                  "USB1",
                  "USB2",
                  "USB3",
                  "USB4",
                  "USB5",
                  "USB6",
                  "SdRaid",
                  "USB8",
                  "Slot4",
                  "Slot1",
                  "Slot2",
                  "Slot2",
                  "Slot3",
                  "NIC1",
                  "NIC2",
                  "NIC3",
                  "NIC4",
                  "CD/DVD",
                  "SATA Port 0",
                  "SATA Port 1",
                  "SATA Port 2",
                  "SATA Port 3",
                  "sSATA Port 0",
                  "sSATA Port 1",
                  "sSATA Port 2",
                  "sSATA Port 3",
                  "DSA"
            ]},
            {
               "bootType": "WakeOnLAN",
               "currentBootOrderDevices": [
                  "PXE Network",
                  "CD/DVD Rom",
                  "Disk Drive 0"
               ],
               "possibleBootOrderDevices": [
                  "PXE Network",
                  "CD/DVD Rom",
                  "Disk Drive 0",
                  "Floppy Disk",
                  ...,
                  "sSATA Port 2",
                  "sSATA Port 3",
                  "DSA"
               ]
            }],
            "uri": "node/425AF828DF7D11D4B0F8E76767BBBBBB/bootOrder"
         },
         "cmmDisplayName": "Management Adapter UUID-425AF828DF7D11D4B0F8E76767BBBBBB",
         "cmmHealthState": "Normal",
         "complexID": -1,
         "contact": "",
         "dataHandle": 1440525606363,
         "description": "Chassis",
         "dnsHostnames": [
            "10.243.6.69",
            "fd55:faaf:e1ab:2021:42f2:e9ff:feb8:1585"
         ],
         "domainName": "",
         "driveBays": 0,
         "drives": [],
         "embeddedHypervisorPresence": false,
         "errorFields": [{
            "ChassisMounted": "NO_CONNECTOR"
         }],
         "excludedHealthState": "Normal",
         "expansionCardSlots": 0,
               "expansionCards": [],
         "expansionProductType": "",
         "expansionProducts": [],
         "firmware": [{
            "build": "TBE105KUS",
            "date": "2015-04-17T00:00:00Z",
            "name": "UEFI Firmware/BIOS",
            "role": "Primary",
            "status": "Active",
            "type": "UEFI",
            "version": "1.10"
         },
         ...,
         {
            "build": "TCOO09D",
            "date": "2015-04-17T00:00:00Z",
            "name": "IMM2 Backup Firmware",
            "role": "Backup",
            "status": "Inactive",
            "type": "IMM2-Backup",
            "version": "1.71"
         }],
         "flashStorage": [],
         "fruSerialNumber": "None",
         "hasOS": false,
         "height": 1,
         "hostMacAddresses": "40:F2:E9:B8:15:80,40:F2:E9:B8:15:81,40:F2:E9:B8:15:82,
                              40:F2:E9:B8:15:83",
         "hostname": "IMM2-40f2e9b81585",
         "ipInterfaces": [{
            "IPv4DHCPmode": "STATIC_ONLY",
            "IPv4assignments": [{
               "address": "10.243.6.69",
               "gateway": "0.0.0.0",
               "id": 0,
               "subnet": "255.255.240.0",
               "type": "INUSE"
            }],
            "IPv4enabled": true,
            "IPv6DHCPenabled": true,
            "IPv6assignments": [{
               "address": "fd55:faaf:e1ab:2021:42f2:e9ff:feb8:1585",
               "gateway": "0:0:0:0:0:0:0:0",
               "id": 0,
               "prefix": 64,
               "scope": "Global",
               "source": "Stateless",
               "type": "INUSE"
            },
            {
               "address": "fe80:0:0:0:42f2:e9ff:feb8:1585",
               "gateway": "0:0:0:0:0:0:0:0",
               "id": 0,
               "prefix": 64,
               "scope": "LinkLocal",
               "source": "Other",
               "type": "INUSE"
            }],
            "IPv6enabled": true,
            "IPv6statelessEnabled": true,
            "IPv6staticEnabled": false,
            "label": "unknown",
            "name": "eth0"
        }],
         "ipv4Addresses": [
            "10.243.6.69",
            "169.254.95.118"
         ],
         "ipv6Addresses": [
            "fd55:faaf:e1ab:2021:42f2:e9ff:feb8:1585",
            "fe80::42f2:e9ff:feb8:1585"
         ],
         "isConnectionTrusted": "true",
         "isITME": false,
         "isRemotePresenceEnabled": true,
         "isScalable": false,
         "lanOverUsb": "enabled",
        "leds": [{
            "color": "Yellow",
            "location": "Unknown",
            "name": "Fault",
            "state": "Off"
         },
		 ...,
         {
           "color": "Yellow",
            "location": "Planar",
            "name": "SDRAID Error",
            "state": "Off"
         }],
         "location": {
            "location": "",
            "lowestRackUnit": 0,
            "rack": "",
            "room": ""
         },
         "macAddress": "40:F2:E9:B8:15:85,40:F2:E9:B8:15:86",
         "machineType": "5463",
         "manufacturer": " IBM(WIST)",
         "manufacturerId": " IBM(WIST)",
         "memoryModules": [{
            "capacity": 4,
            "displayName": "DIMM 1",
            "manufacturer": "Unknown",
            "model": "DDR4",
            "partNumber": "HMA451R7MFR8N-TFTD ",
            "serialNumber": "103D4F44",
            "slot": 1,
            "speed": 2133,
            "type": "DDR4"
         }],
         "memorySlots": 0,
         "mgmtProcIPaddress": "10.243.6.69",
         "model": "45Z",
         "name": "DaAn5",
         "nist": {
            "currentValue": "Compatibility",
            "possibleValues": ["Compatibility",
            "Nist_800_131A_Strict"]
         },
         "onboardPciDevices": [{
            "firmware": [{
               "build": "0",
               "classifications": [0],
               "date": "",
               "name": "PCIFirmware",
               "revision": "0",
               "role": "Primary",
               "softwareID": "1014:405",
               "status": "Active",
               "type": "",
               "version": ""
            }],
            "fodUniqueID": "",
            "isAddOnCard": false,
            "isAgentless": false,
            "name": "",
            "pciBusNumber": "25",
            "pciDeviceNumber": "0",
            "pciFunctionNumber": "0",
            "pciRevision": "1",
            "pciSubID": "405",
            "pciSubVendorID": "1014",
            "portInfo": {},
            "posID": "534",
            "vpdID": "102b"
         },
         ...,
         {
            "firmware": [{
               "build": "0",
               "classifications": [33024],
               "date": "",
               "name": "17.0.4.4a",
               "revision": "0",
               "role": "Primary",
               "softwareID": "101404D1",
               "status": "Active",
               "type": "VPD-V0",
              "version": "17.0.4.4a"
            }],
            "fodUniqueID": "11SBCM957190123456789",
            "isAddOnCard": false,
            "isAgentless": true,
            "name": "Broadcom NetXtreme Gigabit Ethernet Adapter",
            "pciBusNumber": "27",
            "pciDeviceNumber": "0",
            "pciFunctionNumber": "3",
            "pciRevision": "1",
            "pciSubID": "4d1",
            "pciSubVendorID": "1014",
            "portInfo": {
               "logicalPorts": [{
                  "addresses": "40F2E9B81583",
                  "portNumber": 1,
                  "portType": "ETHERNET",
                  "vnicMode": false
               }],
               "peerBay": 0,
               "portNumber": 4,
               "portType": "ETHERNET"
            },
            "posID": "1657",
            "vpdID": "14e4"
         }],
         "overallHealthState": "Normal",
         "partNumber": "00KC903",
         "partitionID": -1,
         "pciCapabilities": ["Raid Link","OOB PCIe","Raid Link Config","Raid Link Alert",
                             "OOB PCIe Config"],
         "pciDevices": [{
            "FRU": "N/A",
            "firmware": [{
               "build": "0",
               "classifications": [13],
               "date": "2015-04-06T00:00:00Z",
               "name": "LSI MegaRAID Adapter Firmware",
               "revision": "0",
               "role": "Primary",
               "softwareID": "10140454",
               "status": "Active",
               "type": "Software Bundle",
               "version": "24.7.0-0052"
            }],
            "fodUniqueID": "N/A",
            "fruSerialNumber": "SV42100396",
            "isAddOnCard": true,
            "isAgentless": true,
            "manufacturer": "IBM",
            "name": "ServeRAID M5210",
            "partNumber": "N/A",
            "pciBusNumber": "1",
            "pciDeviceNumber": "0",
            "pciFunctionNumber": "0",
            "pciRevision": "2",
            "pciSubID": "454",
            "pciSubVendorID": "1014",
            "portInfo": {},
            "posID": "5d",
            "productName": "ServeRAID M5210",
            "slotName": "SlotDesig4_Slot 4",
            "slotNumber": "4",
            "slotSupportsHotPlug": "false",
            "vpdID": "1000"
         },
         ...,
         {
            "firmware": [{
               "build": "0",
               "classifications": [33024],
               "date": "",
               "name": "17.0.4.4a",
               "revision": "0",
               "role": "Primary",
               "softwareID": "101404D1",
               "status": "Active",
               "type": "VPD-V0",
               "version": "17.0.4.4a"
            }],
            "fodUniqueID": "11SBCM957190123456789",
            "isAddOnCard": false,
            "isAgentless": true,
            "name": "Broadcom NetXtreme Gigabit Ethernet Adapter",
            "pciBusNumber": "27",
            "pciDeviceNumber": "0",
            "pciFunctionNumber": "3",
            "pciRevision": "1",
            "pciSubID": "4d1",
            "pciSubVendorID": "1014",
            "portInfo": {
               "logicalPorts": [{
                  "addresses": "40F2E9B81583",
                  "portNumber": 1,
                 "portType": "ETHERNET",
                  "vnicMode": false
               }],
               "peerBay": 0,
               "portNumber": 4,
               "portType": "ETHERNET"
            },
            "posID": "1657",
            "vpdID": "14e4"
         }],
        "ports": [{
            "ioModuleBay": 0,
            "portNumber": 1
         },
        ...,
         {
            "ioModuleBay": 0,
            "portNumber": 4
         }],
         "posID": "",
         "powerAllocation": {
            "maximumAllocatedPower": 660,
            "minimumAllocatedPower": 26
         },
         "powerCappingPolicy": {
            "cappingACorDCMode": "DC",
            "cappingPolicy": "OFF",
            "currentPowerCap": 0,
            "maxPowerCap": 319000,
            "maximumPowerCappingHotPlugLevel": 367000,
            "minPowerCap": 85300,
            "minimumHardCapLevel": 246200,
            "minimumPowerCappingHotPlugLevel": 268000,
            "powerCappingAllocUnit": "watts*10^-3"
         },
         "powerStatus": 5,
         "powerSupplies": [{
            "FRU": "",
            "cmmDisplayName": "Power Supply 1",
            "dataHandle": 0,
            "description": "",
            "firmware": [],
            "fruSerialNumber": "",
            "hardwareRevision": "",
            "healthState": "CRITICAL",
            "inputVoltageIsAC": true,
            "inputVoltageMax": -1,
            "inputVoltageMin": -1,
            "leds": [],
            "machineType": "",
            "manufactureDate": "",
            "manufacturer": "EMER",
            "manufacturerId": "",
            "model": "",
            "name": "Power Supply 1",
            "partNumber": "94Y8136",
            "posID": "",
            "powerAllocation": {
               "totalInputPower": 0,
               "totalOutputPower": 550000
            },
            "powerState": "Unknown",
            "productId": "",
            "productName": "",
            "serialNumber": "K118146600A",
            "slots": [1],
           "type": "PowerSupply",
            "uri": "powerSupply/",
            "userDescription": "",
            "uuid": "",
            "vpdID": ""
         },
         {
            "FRU": "",
            "cmmDisplayName": "Power Supply 2",
           "dataHandle": 0,
            "description": "",
            "firmware": [],
            "fruSerialNumber": "",
            "hardwareRevision": "",
            "healthState": "CRITICAL",
            "inputVoltageIsAC": true,
            "inputVoltageMax": -1,
            "inputVoltageMin": -1,
            "leds": [],
            "machineType": "",
            "manufactureDate": "",
            "manufacturer": "EMER",
            "manufacturerId": "",
            "model": "",
            "name": "Power Supply 2",
            "partNumber": "94Y8136",
            "posID": "",
            "powerAllocation": {
               "totalInputPower": 0,
               "totalOutputPower": 550000
            },
            "powerState": "Unknown",
            "productId": "",
            "productName": "",
            "serialNumber": "K1181466087",
            "slots": [2],
            "type": "PowerSupply",
            "uri": "powerSupply/",
            "userDescription": "",
            "uuid": "",
            "vpdID": ""
         }],
         "processorSlots": 0,
         "processors": [{
            "cores": 10,
            "displayName": "Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz",
           "family": "INTEL_R_XEON_TM",
            "manufacturer": "Intel(R) Corporation",
            "productVersion": "Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz",
            "slot": 1,
            "speed": 2.2999999999999998
         }],
         "productId": "4D4F00",
         "productName": "Lenovo System x3550 M5",
         "raidSettings": [{
            "description": "ServeRAID M5210",
            "diskDrives": [{
               "FRU": "42D0631",
               "bay": 0,
               "blockSize": 512,
               "description": "AL13SEB300",
               "diskState": "System",
               "healthState": "Normal",
               "interfaceType": "SAS",
               "manufacturer": "IBM-ESXS",
               "mediaType": "Rotational",
               "model": "AL13SEB300",
               "name": "Disk 0_0",
               "numberOfBlocks": 585937500,
               "partNumber": "42D0628",
               "serialNumber": "44P012H5",
               "uuid": ""
            },
            ...,
            {
               "FRU": "81Y3810",
               "bay": 1,
               "blockSize": 512,
               "description": "ST9300653SS",
               "diskState": "System",
               "healthState": "Normal",
               "interfaceType": "SAS",
               "manufacturer": "IBM-ESXS",
               "mediaType": "Rotational",
               "model": "ST9300653SS",
               "name": "Disk 2_2",
               "numberOfBlocks": 585937500,
               "partNumber": "81Y9667",
               "serialNumber": "6XN3J9M9",
               "uuid": ""
            }],
           "firmware": [{
               "build": "0",
               "classifications": [],
               "date": "2015-04-06T00:00:00Z",
               "name": "LSI MegaRAID Adapter Firmware",
               "revision": "0",
               "role": "Primary",
               "softwareID": "10140454",
               "status": "Active",
               "type": "",
               "version": "24.7.0-0052"
            }],
            "name": "ServeRAID M5210",
           "uuid": "0000000000000000500605B008E48280"
         }],
         "secureBootMode": {
            "currentValue": "Disabled",
           "possibleValues": ["Disabled",
            "Enabled"]
         },
         "serialNumber": "KVD0153",
         "slots": [1],
         "status": {
            "message": "managed",
            "name": "MANAGED"
         },
         "subSlots": [],
         "subType": "",
         "tlsVersion": {
            "currentValue": "TLS_10",
           "possibleValues": ["TLS_10",
            "TLS_11",
            "TLS_12"]
         },
         "type": "Rack-Tower Server",
         "uri": "node/425AF828DF7D11D4B0F8E76767BBBBBB",
         "userDescription": "",
         "uuid": "425AF828DF7D11D4B0F8E76767BBBBBB",
         "vnicMode": "disabled",
         "vpdID": ""
      }],
      "partitionID": 1,
      "uuid": "C29379AA380E11E39DF3000AF7256714"
   }],
   "partitionCount": 1,
   "uuid": "C29379AA380E11E39DF3000AF7256714"
}