GET /canisters/{uuid}
Use this method to return properties for a specific Flex System storage controller (canister).
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/canisters/{uuid}
where {uuid} is the UUID of the storage controller to be retrieved. To obtain the storage-controller UUID, use the GET /canisters method.
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
|
| 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 following example returns ipv4Addresses and ipv6Addresses properties in addition to the base properties.
GET https://192.0.2.0/canisters/6ED2CB368C594C66C2BB066D5A306138?includeAttributes=ipv4Addresses,ipv6Addresses
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. |
| 409 | Conflict | There is a conflict with the current state of the resource. 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 | ||
|---|---|---|---|---|
| activationKeys | Array | List of installed Feature On Demand (FOD) keys | ||
| backedBy | String | This can be one of the following values.
| ||
| bladeState | Integer | The blade state. 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:
| ||
| contact | String | Contact name | ||
| dataHandle | Long | Time stamp of the last status update | ||
| description | String | Description provided by the CMM | ||
| domainName | String | Domain name | ||
| driveBays | Integer | Total number of drive bays | ||
| drives | Array | Information about the drives | ||
| bay | Integer | Drive bay location | ||
| capacity | Integer | Drive capacity, in GB | ||
| errorFields | Array of objects where each object has <string, errorCode} | Error codes. This can be one of the following values.
| ||
| firmware | Array | Information about the firmware | ||
| build | String | Firmware build | ||
| date | String | Firmware date | ||
| name | String | Firmware name | ||
| role | String | Firmware role | ||
| status | String | Firmware status | ||
| type | String | Firmware type | ||
| version | String | Firmware version | ||
| FRU | String | FRU part number | ||
| fruSerialNumber | String | FRU serial number | ||
| hostname | String | Hostname | ||
| ipInterfaces | Array | Information about the storage-controller IP addresses | ||
| IPv4assignments | Array | Information about IPv4 assignments | ||
| address | String | IPv4 address | ||
| gateway | String | IPv4 gateway | ||
| id | Integer | IPv4 assignment ID | ||
| subnet | String | IPv4 subnet mask | ||
| type | String | The type of the IPv4 assignment. This can be one of the following values.
| ||
| IPv4DHCPmode | String | IPv4 address DHCP mode. 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 | Information about IPv6 assignments | ||
| address | String | IPv6 address | ||
| gateway | String | IPv6 gateway | ||
| id | Integer | IPv6 assignment ID | ||
| 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.
| ||
| IPv6enabled | Boolean | Identifies whether IPv6 is enabled. This can be one of the following values.
| ||
| IPv6DHCPenabled | Boolean | Identifies whether IPv6 DHCP 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.
| ||
| name | String | Interface name (such as eth0) | ||
| label | String | Label | ||
| ipv4Addresses | Array of strings | The list of IPv4 addresses | ||
| ipv4ServiceAddress | String | IPv4 service address | ||
| ipv6Addresses | Array of strings | List of IPV6 addresses | ||
| ipv6ServiceAddress | String | IPv6 service address | ||
| lanOverUsb | String | Identifies whether the LAN over USB is enabled or disabled. This can be one of the following values.
| ||
| leds | Array | Information about storage-controller 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 | Array | Storage-controller location details | ||
| location | String | Location description | ||
| lowestRackUnit | Integer | Lowest rack unit | ||
| rack | String | Rack | ||
| room | String | Room | ||
| macAddress | String | MAC address | ||
| machineType | String | Machine type | ||
| manufacturer | String | Manufacturer | ||
| uri | String | Parent URI | ||
| uuid | String | Parent UUID | ||
| manufacturerID | String | Manufacturer ID | ||
| memoryModules | Array | Information about the memory modules | ||
| capacity | Long | Capacity | ||
| displayName | String | Display name | ||
| manufacturer | String | Manufacturer | ||
| model | String | Model | ||
| partNumber | String | Part number | ||
| serialNumber | String | Serial number | ||
| slot | Integer | Slot | ||
| speed | Long | Speed | ||
| type | String | Type | ||
| model | String | Storage-controller model | ||
| memorySlots | Integer | Total number of memory slots | ||
| name | String | Name that is displayed in the user interface for this device The value of this attribute is determined by preferredDisplayName attribute in the GET /aicc method. For example, if the preferredDisplayName attribute is set to | ||
| parent | Array | Parent information for the target device | ||
| uri | String | Parent URI | ||
| uuid | String | Parent UUID | ||
| partNumber | String | Part number | ||
| powerStatus | Integer | Power status. This can be one of the following values.
| ||
| processors | Array | Processor details | ||
| posID | String | Position ID | ||
| cores | Integer | Processor cores | ||
| family | String | Processor family | ||
| manufacturer | String | Processor manufacturer | ||
| slot | Integer | Slot number | ||
| speed | Long | Processor speed (GHz) | ||
| processorSlots | Integer | Total number of processor slots | ||
| productId | String | Product ID | ||
| productName | String | Product name | ||
| serialNumber | String | Serial number | ||
| serviceHostName | String | Service hostname | ||
| slots | Array of integers | Slots occupied | ||
| subSlots | Array of integers | Sub-slots occupied | ||
| subType | String | Sub-type | ||
| type | String | Resource type. This value is always ITE. | ||
| uri | String | Storage-controller URI | ||
| userDefinedName | String | User-defined name for the device | ||
| userDescription | String | User-defined description | ||
| uuid | String | UUID | ||
| vnicMode | String | Indicates whether VNIC mode is enabled. This can be one of the following values.
| ||
| vpdID | String | VPD ID | ||
The following example is returned if the request is successful.
{
"cabinetName": "lxcm-test",
"chassisList": [],
"complexList": [],
"height": 52,
"location": "",
"nodeList": [{
"complexNodeCount": -1,
"itemInventory": {
"activationKeys": [],
"accessState": "Online",
"addinCardSlots": 0,
"arch": "x86_64",
"backedBy": "real",
"bladeState": 0,
"bootMode": {
"currentValue": "unspecified",
"possibleValues": ["uefi","bios"]
},
"bootOrder": {
"bootOrderList": [{
"bootType": "SingleUse",
"currentBootOrderDevices": ["default"],
"possibleBootOrderDevices": ["setup","network","hd","cd","default"]
}],
"uri": "nodes/5CF902D17961E511843E3C18A001C6A0/bootOrder"
},
"cmmDisplayName": "",
"cmmHealthState": "Critical",
"complexID": -1,
"contact": "",
"description": "chassis RD650",
"domainName": "labs.lenovo.com",
"driveBays": 2,
"drives": [{
"bay": 2,
"capacity": 250,
"interfaceType": "SATA",
"mediaType": "HDD",
"raidPresence": "Non-RAID drive",
"speed": "3.0 Gb/s",
"state": "active"
},
{
"bay": 1,
"capacity": 250,
"interfaceType": "SATA",
"mediaType": "HDD",
"raidPresence": "Non-RAID drive",
"speed": "3.0 Gb/s",
"state": "active"
}],
"embeddedHypervisorPresence": false,
"encapsulation": {},
"errorFields": [],
"excludedHealthState": "Critical",
"expansionCards": [],
"expansionCardSlots": 0,
"expansionProducts": [],
"expansionProductType": "",
"fans": [],
"firmware": [{
"build": "",
"date": "",
"name": "PSU 2",
"role": "",
"status": "ACTIVE",
"type": "PSU 2",
"version": "0.0.0"
},
...,
{
"build": "",
"date": "",
"name": "System Manager (BMC)",
"role": "",
"status": "ACTIVE",
"type": "System Manager (BMC)",
"version": "1.42.78800"
}],
"flashStorage": [],
"FRU": "",
"fruSerialNumber": "8SSB20A05917R2SH56G004J",
"FQDN": "",
"hasOS": false,
"height": 2,
"hostMacAddresses": "",
"hostname": "RD650",
"ipInterfaces": [],
"ipv4Addresses": ["10.243.2.201"],
"ipv6Addresses": [],
"isConnectionTrusted": "true",
"isITME": false,
"isRemotePresenceEnabled": true,
"isScalable": false,
"lanOverUsb": "disabled",
"leds": [{
"color": "Red",
"conditions": "Fault",
"location": "MotherBoard",
"name": "LED FAN FAULT 5",
"state": "Off"
},
...},
{
"color": "Red",
"conditions": "Fault",
"location": "MotherBoard",
"name": "LED FAN FAULT 6",
"state": "Off"
}],
"location": {
"lowestRackUnit": 51,
"location": "",
"rack": "lxcm-test",
"room": ""
},
"logicalID": -1,
"macAddress": "00:8C:FA:E7:FE:4A,00:8C:FA:E7:FE:4B",
"machineType": "70D0",
"manufacturerId": "",
"manufacturer": "LENOVO",
"memoryModules": [{
"capacity": 8,
"displayName": "DIMM 1",
"model": "",
"manufacturer": "Samsung",
"partNumber": "M393A1G40DB0-CPB",
"serialNumber": "411e26be",
"slot": 1,
"speed": 1600,
"speedMBs": 0,
"type": "RDIMM",
"voltage": "1.2V"
}],
"memorySlots": 0,
"mgmtProcIPaddress": "10.243.2.201",
"mgmtProcType": "UNKNOWN",
"model": "0026UX",
"name": "RD650",
"nist": {
"currentValue": "Nist_800_131A_Strict",
"possibleValues": ["Nist_800_131A_Strict","unsupported","Nist_800_131A_Custom",
"Compatibility"]
},
"overallHealthState": "Critical",
"partNumber": "",
"powerStatus": 8,
"productName": "RD650",
"parent": {
"uri": "cabinet/83094B8D-4709-4254-8E28-2C571816FE81",
"uuid": "83094B8D-4709-4254-8E28-2C571816FE81"
},
"partitionID": -1,
"pciCapabilities": [],
"pciDevices": [],
"ports": [],
"posID": "",
"powerAllocation": {
"maximumAllocatedPower": 0,
"minimumAllocatedPower": 0
},
"powerCappingPolicy": {
"cappingACorDCMode": "UNKNOWN",
"cappingPolicy": "UNKNOWN",
"currentPowerCap": 0,
"maxPowerCap": -1,
"maximumPowerCappingHotPlugLevel": -1,
"minimumHardCapLevel": -1,
"minPowerCap": -1,
"minimumPowerCappingHotPlugLevel": -1,
"powerCappingAllocUnit": "watts"
},
"powerSupplies": [{
"dataHandle": 0,
"description": "Power Supply 1",
"firmware": [],
"hardwareRevision": "01",
"healthState": "GOOD",
"inputVoltageIsAC": false,
"inputVoltageMax": 0
"inputVoltageMin": 0,
"leds": [{
"color": "Amber",
"location": "FRU",
"name": "FAULT",
"state": "Off"
},
...,
{
"color": "Green",
"location": "FRU",
"name": "OUT",
"state": "On"
}],
"manufactureDate": "2014-01-11",
"manufacturerId": "LITEON",
"model": "PS-2551-6L-LF",
"name": "005V",
"parent": {},
"powerAllocation": {
"totalInputPower": 0,
"totalOutputPower": 0
},
"serialNumber": "005V",
"slots": [0],
"type": "PowerSupply",
"uri": "powerSupply/null",
}],
"primary": false,
"processors": [{
"cores": 6,
"displayName": "",
"family": "Intel Nehalem Family",
"manufacturer": "GenuineIntel",
"productVersion": "Haswell Server Model",
"slot": 1,
"socket": "",
"speed": 1.6
}],
"processorSlots": 0,
"productId": "",
"raidSettings": [],
"secureBootMode": {
"currentValue": "",
"possibleValues": []
},
"securityDescriptor": {
"managedAuthEnabled": false,
"managedAuthSupported": false,
"publicAccess": false,
"roleGroups": [],
"storedCredentials": {
"description": "",
"id": "557",
"userName": "lenovo"
},
"uri": "nodes/5cf902d17961e511843e3c18a001c6a0"
},
"serialNumber": "MJ03210K",
"slots": [1],
"status": {
"message": "managed",
"name": "MANAGED"
},
"subSlots": [],
"subType": "ThinkServer",
"tlsVersion": {
"possibleValues": ["unsupported",
"TLS_12",
"TLS_11",
"TLS_10"],
"currentValue": "Unknown"
},
"thinkServerFru": [{
"description": "BackPlane1 FRU",
"deviceName": "12GBP 12xL",
"manufatucturer": "LENOVO",
"manufatucturerDate": "Apr 28, 2015",
"partNumber": "SSF0A47713",
"serial": "8SSSF0A47713V1SH54W0077",
}],
"type": "Lenovo ThinkServer",
"userDefinedName": "RD650",
"userDescription": "",
"uri": "nodes/5CF902D17961E511843E3C18A001C6A0",
"uuid": "5CF902D17961E511843E3C18A001C6A0",
"vnicMode": "disabled",
"vpdID": ""
},
"itemHeight": 2,
"itemLocation": "",
"itemLocationRack": "lxcm-test",
"itemLocationRoom": "",
"itemLowerUnit": 51,
"itemName": "SERVER-5CF902D17961E511843E3C18A001C6A0",
"itemParentUUID": "83094B8D-4709-4254-8E28-2C571816FE81",
"itemSubType": "ThinkServer",
"itemType": "SERVER",
"itemUUID": "5CF902D17961E511843E3C18A001C6A0",
"nodeCount": -1,
"physicalID": -1
}],
"placeholderList": [],
"room": "",
"storageList": [{
"itemName": "S3200",
"itemUUID": "500C0FF0280E8B3C",
"itemParentUUID": "208000C0FF280E8B",
"itemLocationRoom": "",
"itemLocationRack": "lxcm-test",
"itemLocation": "",
"itemLowerUnit": 49,
"itemType": "STORAGE",
"itemHeight": 2,
"itemSubType": "Enclosure",
"itemInventory": {
"accessState": "Online",
"canisterSlots": 2,
"cmmHealthState": "Critical",
"contact": "Alan Hawkins5",
"description": "mineminemine",
"diskGroups": 3,
"driveBays": 12,
"enclosures": [{
"canisters": [{
"cmmDisplayName": "controller_b",
"controllerId": "B",
"controllerRedundancyMode": "Active-Active ULP",
"controllerRedundancyStatus": "Redundant",
"disks": 11,
"diskBusType": "SAS",
"diskChannels": 2,
"expansionPorts": [{
"healthReason": "No drive enclosure is connected to this expansion port. This is
normal if this is the last (or only) enclosure in the cabling
sequence of the system.",
"health": "N/A",
"healthRecommendation": "- No action is required.",
"name": "Out Port",
"status": "Disconnected"
}],
"energyMetrics": {
"diskControllerTemperature": [],
"inletAirTemperature": [],
"memoryTemperature": []
},
"failedOverToThisController": "No",
"failOverReason": "Not applicable",
"firmware": {
"backplaneType": "7",
"buildDate": "Thu Jun 29 09:26:26 MDT 2017",
"bundleVersion": "GL221R020-14",
"capiVersion": "3.19",
"cpldCodeVersion": "56",
"diskInterfaceHardwareVersion": "3",
"expanderControllerCodeVersion": "3206",
"hardwareVersion": "5.2",
"hostInterfaceHardwareVersion": "2",
"hostInterfaceModuleModel": "6",
"hostInterfaceModuleVersion": "11",
"managementControllerCodeVersion": "GLM221R037-02",
"managementControllerLoaderCodeVersion": "6.27.25440",
"scBootMemoryReferenceCodeVersion": "1.2.1.10",
"storageControllerCodeBaselevel": "GLS221R13-01",
"storageControllerCodeVersion": "GLS221R13-01",
"storageControllerCpuType": "Gladden 1300MHz",
"storageControllerLoaderCodeVersion": "27.016",
},
"hardwareVersion": "5.2",
"health": "Normal",
"healthReason": "",
"healthRecommendation": "",
"hostPorts": 4,
"networkPorts": {
"addressingMode": "Manual",
"gateway": "10.243.0.1",
"health": "OK",
"healthReason": "",
"healthRecommendation": "",
"ipAddress": "10.243.9.149",
"ipVersion": 4,
"macAddress": "00:c0:ff:28:04:01",
"name": "mgmtport_b",
"networkMask": "255.255.224.0"
},
"phyIsolation": "Enabled",
"ports": [{
"action": "- If this host port is intentionally unused, no action is required.\n
- Otherwise, use an appropriate interface cable to connect this host
port to a switch or host.\n
- If a cable is connected, check the cable and the switch or host for
problems.",
"actualSpeed": "",
"configSpeed": "Auto",
"health": "N/A",
"media": "FC(-)",
"port": "B3",
"reason": "There is no active connection to this host port.",
"status": "Disconnected",
"targetId": "277000c0ff280e8b",
"topology": "PTP"
},
...]
"position": "Bottom",
"powerState": "On",
"systemCacheMemory": 6144,
"serialNumber": "11S00WC050Y010DH677182",
"revision": "0",
"status": "Operational",
}
...],
"drives": [{
"model": "ST2000NM0034 X",
"vendorName": "LENOVO-X",
"status": "Up",
"location": "0.7",
"serialNumber": "Z4H04RK70000R543K1TB",
"healthReason": "The disk may contain invalid metadata.",
"health": "Degraded",
"type": "SAS MDL",
"healthRecommendation": "- If the associated disk group is offline or quarantined, contact
technical support. Otherwise, clear the disk's metadata to reuse
the disk.",
"size": "2000.3GB"
},
...],
"enclosureInfo": {
"diskCount": 11,
"driveBays": 12,
"enclosureId": 0,
"health": "Degraded",
"midplaneSerialNumber": "11S00WC065Y010DH67C0RF",
"model": "S3200",
"vendorName": "Lenovo",
"status": "Up",
"wwn": "500C0FF0280E8B3C"
},
"energyMetrics": {
"enclosurePower": []
},
"frus": [{
"description": "SPS Memory Card",
"fruLocation": "LOWER IOM MEMORY CARD SLOT",
"fruStatus": "OK",
"partNumber": "40-00000053",
"serialNumber": "",
"shortName": "Memory Card"
},
...],
"location": {
"rack": "lxcm-test",
"room": "",
"location": "",
"lowestRackUnit": 49
},
"powerSupplies": [{
"health": "OK",
"healthReason": "",
"healthRecommendation": "",
"model": "00WC067",
"position": "Right",
"status": "Up",
"vendorName": ""
},
{
"health": "OK",
"healthReason": "",
"healthRecommendation": "",
"model": "00WC067",
"position": "Left",
"status": "Up",
"vendorName": ""
}],
"slots": ["0","1","2","3","4","5","6","7","8","9","10"]
}],
"enclosureCount": 1,
"excludedHealthState": "Critical",
"healthReason": "A subcomponent of this component is unhealthy.",
"ipv4Addresses": ["10.243.9.148","10.243.9.149"],
"isConnectionTrusted": "true",
"location": {
"rack": "lxcm-test",
"room": "",
"location": "",
"lowestRackUnit": 49
},
"machineType": "6411",
"mgmtProcIPaddress": "10.243.9.148",
"model": "S3200",
"name": "S3200",
"otherMcStatus": "Operational",
"overallHealthState": "Critical",
"parent": {
"uri": ""
"uuid": ""
},
"pfu": "Idle",
"productBrand": "Storage",
"productName": "S3200",
"scsiProductId": "S3200",
"scsiVendorId": "Lenovo",
"securityDescriptor": {
"managedAuthEnabled": false,
"managedAuthSupported": false,
"publicAccess": false,
"roleGroups": [],
"uri": "storage/208000c0ff280e8b"
},
"serialNumber": "280E8B",
"supportedLocales": "English (English), Arabic (العربية), Portuguese (português), Spanish (español),
French (français), German (Deutsch), Italian (italiano), Japanese (日本語),
Korean (한국어), Dutch (Nederlands), Russian (русский),
Chinese-Simplified (简体中文), Chinese-Traditional (繁體中文)",
"systemLocation": ",,lxcm-test",
"type": "Lenovo Storage",
"uri": "storage/208000C0FF280E8B",
"userDefinedName": "S3200",
"userDescription": "mineminemine",
"uuid": "208000C0FF280E8B",
"vendorName": "Lenovo",
"virtualPools": 2,
"wwnn": "208000C0FF280E8B"
}
}],
"switchList": [],
"UUID": "83094B8D-4709-4254-8E28-2C571816FE81"
}
Give documentation feedback