GET /storage/<UUID_list>

Use this GET method to retrieve properties for one or more storage devices.

Note: This API requires Lenovo XClarity Administrator v1.2.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/storage/<UUID_list>

where <UUID_list> is a list of one or more UUIDs, separated by a comma, of the storage devices to be retrieved. To obtain the storage UUIDs, use the GET /storage 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:
  • 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.

The following example returns a CSV file that contains information about a two storage devices.
GET https://192.0.2.0/storage/0E7D8E1CDF7D11D4ABB0D5D5D5313131,0E7D8E1CDF7D11D4ABB0D5D5E7533456
?formatType=csv

Request body

None

Response codes

Code Description
200 OK
400 Bad request
401 Unauthorized
403 Forbidden
404 Not found
409 Conflict
500 Internal server error

Response body

The returned attributes vary, depending on the type of storage device.

Attributes Type Description
accessState String Access state of the server. This can be one of the following values.
  • Online
  • Offline
  • Partial
  • Pending
  • Unknown
canisterSlots Integer Canister slots
cmmHealthState String Health summary that corresponds to the highest event severity of all storage devices. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
contact String Contact
description String Description
diskGroups Integer  
driveBays Integer Drive bays
enclosureCount Integer Number of enclosures
enclosures Array of objects Information about each enclosure
  batteries Array of objects  
    age String  
    daysUntilReplacement String  
    position String  
    serialNumber String  
    status String  
    vendorName String  
  canisters Array of objects Information about storage controllers (canisters)
    cmmDisplayName String (Flex System storage devices only) The display name provided by the CMM
    controllerId String  
    controllerRedundancyMode String  
    controllerRedundancyStatus String  
    disks Integer Number of disks
    diskBusType String  
    diskChannels Integer  
    energyMetrics Object Energy metrics for the storage controller

Each energy metric contains one or more arrays that include when the sample was taken (timeStamp) and the value of the sample (metricValue).

      diskControllerTemperature Array of objects Disk-controller temperature samples
      inletAirTemperature   Inlet air temperature samples
      memoryTemperature   Memory temperature samples
    expansionPorts Array of objects  
        health String  
        healthReason String  
        healthRecommendation String  
        media String  
        name String  
        status String  
    failOverReason String  
    failedOverToThisController String  
    firmware Object  
        backplaneType String  
        bundleVersion String  
        buildDate String  
        capiVersion String  
        cpldCodeVersion String  
        diskInterfaceHardwareVersion String  
        expanderControllerCodeVersion String  
        hardwareVersion String  
        hostInterfaceHardwareVersion String  
        hostInterfaceModuleModel String  
        hostInterfaceModuleVersion String  
        managementControllerCodeVersion String  
        managementControllerLoaderCodeVersion String  
        scBootMemoryReferenceCodeVersion String  
        storageControllerCodeBaselevel String  
        storageControllerCodeVersion String  
        storageControllerCpuType String  
        storageControllerLoaderCodeVersion String  
    hardwareVersion String  
    health String  
    healthReason String  
    healthRecommendation String  
  hostAdapters Array of objects  
    model String  
    serialNumber String  
    status String  
    type String  
    hostPorts Integer  
    networkPorts Object  
        addressingMode String  
        gateway String  
        health String  
        healthReason String  
        healthRecommendation String  
        ipAddress String  
        ipVersion Integer  
        media String  
        macAddress String  
        name String  
        networkMask String  
        role String  
    phyIsolation String  
    ports Array of objects  
        action String  
        actualSpeed String  
        configSpeed String  
        health String  
        media String  
        port String  
        reason String  
        status String  
        targetId String  
        topology String  
    position String  
    powerState String  
    revision String  
    serialNumber String  
    status String  
    systemCacheMemory Long  
    drawers Array of objects  
      name String  
      model String  
      opened String  
      serialNumber String  
      status String  
  drives Array of objects Information about drives in the storage enclosure
    available String  
    health String  
    healthReason String  
    healthRecommendation String  
    location String  
    media String  
    model String  
    serialNumber String  
    size String Drive capacity, in GB
    status String  
    type String  
    vendorName String  
  enclosureInfo Object  
    diskCount Integer  
    driveBays Integer  
    enclosureId Integer  
    generatedUUID String Unique identifier for an individual storage enclosure. This attribute is present only when the wwn attribute is not available for the enclosure
    health String  
    height String  
    location String  
    model String  
    midplaneSerialNumber String  
    status String  
    vendorName String  
    wwn String  
  energyMetrics Object Energy metrics for the enclosure

Each energy metric contains one or more arrays that include when the sample was taken (timeStamp) and the value of the sample (metricValue).

    enclosurePower Array of objects Enclosure power samples
  fans Array of objects  
    description String  
    status String  
  frus Array of objects  
    description String  
    fruLocation String  
    fruStatus String  
    partNumber String FRU part number
    serialNumber String FRU serial number
    shortName String  
  ioModules Array of objects  
    fwVersion String  
    model String  
  location Object  
    location String  
    lowestRackUnit String  
    rack String  
    room String  
  powerSupplies Array of objects Information about power supplies in the enclosure
    fwVersion String  
    health String  
    healthReason String  
    healthRecommendation String  
    model String Power-supply model.
    position String  
    serialNumber String  
    status String  
    vendorName String  
  slots Array of strings  
excludedHealthState String Highest severity alert with exclusions. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
healthReason String  
ipv4Addresses Array of strings IPv4 address
isConnectionTrusted    
location object Information about the location of the storage device
  location String Location
  lowestRackUnit String Lowest rack unit
  rack String Rack
  room String Room
machineType String Storage-device machine type
mgmtProcIPaddress String Management IP address
model String Storage-device model
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 "hostname," then the value for this name attribute is the same as the hostname attribute in the GET /aicc method.

otherMcStatus String  
overallHealthState String Highest severity of all alerts. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
parent Object Information about the parent of the storage device, if applicable
  uri String Parent UUID
  uuid String Parent URI
pfu String  
productBrand String  
productName String Product name
scsiProductId String  
scsiVendorId String  
securityDescriptor Object Information about the authentication enablement and support the associated stored credentials for a managed device
  managedAuthEnabled Boolean Indicates whether the device uses managed authentication. This can be one of the following values.
  • true. The device uses managed authentication.

  • false. The device uses local authentication.

  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.
  • true. This device supports the ability to choose managed authentication.

  • false. This device does not support the ability to choose managed authentication.

  publicAccess Boolean Indicates whether the resource can be accessed by all role groups. This can be one of the following values.
  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups.

  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.
    description String Description of the stored credential
    id String ID of the stored credential
    userName String Name of the stored credential
  uri String URI of the device
serialNumber String  
supportedLocales String  
systemLocation String  
type String Resource type
uri String URI
userDefinedName String User-defined name for the device
userDescription String User description
uri String  
uuid String UUID
vendorName String  
virtualPools Integer  
wwnn String  

Response example

[{
   "accessState": Online",
   "canisterSlots": 2,
   "cmmHealthState": "Normal",
   "contact": "F",
   "description": "F",
   "diskGroups": 2,
   "driveBays": 12,
   "enclosureCount": 1,
   "enclosures": [{
      "canisters": [{
         "cmmDisplayName": "controller_a",
         "controllerId": "A",
         "controllerRedundancyMode": "Active-ActiveULP",
         "controllerRedundancyStatus": "Redundant",
         "disks": 9,
         "diskBusType": "SAS",
         "diskChannels": 2,
         "energyMetrics": {
            "diskControllerTemperature": [],
            "inletAirTemperature": [],
            "memoryTemperature": []
         },
         "expansionPorts": [{
            "health": "N/A",
            "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.",
            "healthRecommendation": "-Noactionisrequired.",
            "name": "OutPort",
            "status": "Disconnected"
         }],
         "failOverReason": "Notapplicable",
         "failedOverToThisController": "No",
         "firmware": {
            "backplaneType": "7",
            "bundleVersion": "GL221R020-14",
            "buildDate": "ThuJun2909: 26: 26MDT2017",
            "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": "Gladden1300MHz",
            "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.148",
            "ipVersion": 4,
            "macAddress": "00: c0: ff: 28: 03: c7",
            "name": "mgmtport_a",
            "networkMask": "255.255.240.0"
         },
         "phyIsolation": "Enabled",
         "ports": [{
            "action": "- If this host port is intentionally unused, no actionis required.\n
                        - Otherwise, use an appropriate interface cable to connect this host
                          port to a switch o rhost.\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": "A2",
            "reason": "There is no active connection to this host port.",
            "status": "Disconnected",
            "targetId": "227000c0ff280e8b",
            "topology": "PTP"
         },
         ...,
         {
            "action": "- If this host port is intentionally unused, no actionis required.\n
                       - Otherwise, use an appropriate interface cable to connect this host
                         port to a switch o rhost.\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": "A3",
            "reason": "There is no active connection to this host port.",
            "status": "Disconnected",
            "targetId": "237000c0ff280e8b",
            "topology": "PTP"
         }]
         "position": "Top",
         "powerState": "On",
         "revision": "0",
         "serialNumber": "11S00WC050Y010DH677180",
         "status": "Operational",
         "systemCacheMemory": 6144,
      }],
      "drives": [{
         "health": "OK",
         "healthReason": "",
         "healthRecommendation": "",
         "location": "0.9",
         "model": "ST2000NM0034X",
         "serialNumber": "Z4H02R730000R538RM68",
         "size": "2000.3GB",
         "status": "Up",
         "type": "SASMDL",
         "vendorName": "LENOVO-X"
      },
      ...,
      {
         "health": "OK",
         "healthReason": "",
         "healthRecommendation": "",
         "location": "0.4",
         "model": "ST2000NM0034X",
         "serialNumber": "Z4H07S8L0000R628K52C",
         "size": "2000.3GB",
         "status": "Up",
         "type": "SASMDL",
         "vendorName": "LENOVO-X"
      }],
      "enclosureInfo": {
         "diskCount": 9,
         "driveBays": 12,
         "enclosureId": 0,
         "health": "OK",
         "model": "S3200",
         "midplaneSerialNumber": "11S00WC065Y010DH67C0RF",
         "status": "Up",
         "vendorName": "Lenovo",
         "wwn": "500C0FF0280E8B3C"
      },
      "energyMetrics": {
         "enclosurePower": []
      },
      "frus": [{
         "description": "SPSMemoryCard",
         "fruLocation": "LOWERIOMMEMORYCARDSLOT",
         "fruStatus": "OK",
         "partNumber": "40-00000053",
         "serialNumber": "",
         "shortName": "MemoryCard"
      },
      ...,
      {
         "description": "48X44xCNCRIOM-LX6GBLENOVO",
         "fruLocation": "LOWERIOMSLOT",
         "fruStatus": "OK",
         "partNumber": "00WC050",
         "serialNumber": "11S00WC050Y010DH677182",
         "shortName": "RAIDIOM"
      }],
      "location": {
         "lowestRackUnit": 0,
         "location": "",
         "rack": "",
         "room": ""
      },
      "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", "4", "5", "6", "8", "9", "10"]
   }],
   "excludedHealthState": "Normal",
   "healthReason": "",
   "ipv4Addresses": ["10.243.9.148", "10.243.9.149"],
   "isConnectionTrusted": "true",
   "location": {
      "location": "",
      "lowestRackUnit": 0,
      "rack": "",
      "room": ""
   },
   "machineType": "6411",
   "mgmtProcIPaddress": "192.0.2.0",
   "model": "S3200",
   "name": "S3200",
   "otherMcStatus": "Operational",
   "overallHealthState": "Normal",
   "parent": {
      "uri": "",
      "uuid": ""
   },
   "pfu": "Idle",
   "productBrand": "Storage",
   "productName": "S3200",
   "scsiProductId": "S3200",
   "scsiVendorId": "Lenovo",
   "securityDescriptor": {
      "managedAuthEnabled": true
      "managedAuthSupported": true,
      "publicAccess": true,
      "roleGroups": ["lxc-admin","lxc-security-admin"],
      "storedCredentials": null,
      "uri": "storage/0069030ADC5F453E9EE49CA4B44DB8DC"
   },
   "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": "LXCA_empty_field, LXCA_empty_field, LXCA_empty_field",
   "type": "LenovoStorage",
   "userDefinedName": "Storage1",
   "userDescription": "F",
   "uri": "storage/208000C0FF280E8B",
   "uuid": "208000C0FF280E8B",
   "vendorName": "Lenovo",
   "virtualPools": 2,
   "wwnn": "208000C0FF280E8B",
}]