ListStorageContainers

05/25/2022 Contributors

You can use the ListStorageContainers method to retrieve information about all virtual volume storage containers known to the system.

Parameters

This method has the following input parameter:

Name	Description	Type	Default value	Required
storageContainerIDs	A list of storage container IDs for which to retrieve information. If you omit this parameter, the method returns information about all storage containers in the system.	UUID array	None	No

Name

Description

Type

Default value

Required

storageContainerIDs

A list of storage container IDs for which to retrieve information. If you omit this parameter, the method returns information about all storage containers in the system.

UUID array

None

Return value

This method has the following return value:

Name

Description

Type

storageContainers

List of objects containing information about all storage containers in the system.

storageContainer array

Request example

Requests for this method are similar to the following example:

{
   "method": "ListStorageContainers",
   "params": {
      "storageContainerIDs": ["efda8307-b916-4424-979e-658a3f16894d"]
   },
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 6395,
  "result": {
    "storageContainers": [
      {
        "accountID": 64,
        "initiatorSecret": "EJ:08An1MyNQmL!7",
        "name": "VvolContainer",
        "protocolEndpointType": "SCSI",
        "status": "active",
        "storageContainerID": "efda8307-b916-4424-979e-658a3f16894d",
        "targetSecret": "g38}zWBK%206jQr~",
        "virtualVolumes": []
      }
    ]
  }
}

New since version

9.6