reference_element_api_listvirtualvolumebindings.adoc

permalink	sidebar	keywords	summary
api/reference_element_api_listvirtualvolumebindings.html	sidebar	virtual,volume,vvol,cluster,bound,protocol,endpoint,binding,bindings,list,listing,listvirtualvolumebindings	You can use the ListVirtualVolumeBindings method to get a list of all virtual volumes in the cluster that are bound to protocol endpoints.

ListVirtualVolumeBindings

You can use the ListVirtualVolumeBindings method to get a list of all virtual volumes in the cluster that are bound to protocol endpoints.

Parameters

This method has the following input parameter:

Name	Description	Type	Default value	Required
virtualVolumeBindingIDs	A list of virtual volume binding IDs for which to retrieve information. If you omit this parameter, the method returns information about all virtual volume bindings.	integer array	None	No

Return value

This method has the following return value:

Name	Description	Type
bindings	A list of objects describing all virtual volumes in the cluster that are bound to protocol endpoints.	binding

Request example

Requests for this method are similar to the following example:

{
  "method": "ListVirtualVolumeBindings",
    "params": {
    },
    "id": 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {
    "bindings": [
      {
        "protocolEndpointID": "5dd53da0-b9b7-43f9-9b7e-b41c2558e92b",
        "protocolEndpointInBandID": "naa.6f47acc2000000016a67746700000000",
        "protocolEndpointType": "SCSI",
        "virtualVolumeBindingID": 177,
        "virtualVolumeHostID": "564de1a4-9a99-da0f-8b7c-3a41dfd64bf1",
        "virtualVolumeID": "269d3378-1ca6-4175-a18f-6d4839e5c746",
        "virtualVolumeSecondaryID": "0xe200000000a6"
      }
    ]
  }
}

New since version

9.6