ListInitiators
Suggest changes
PDFs
You can use the ListInitiators method to get the list of initiator IQNs or World Wide Port Names (WWPNs).
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
initiators |
A list of initiator IDs to retrieve. You can supply this parameter or the startInitiatorID parameter, but not both. |
integer array |
None |
No |
startInitiatorID |
The initiator ID at which to begin the listing. You can supply this parameter or the initiators parameter, but not both. |
integer |
0 |
No |
limit |
The maximum number of initiator objects to return. |
integer |
(unlimited) |
No |
Return value
This method has the following return value:
Name |
Description |
Type |
initiators |
List of the initiator information. |
initiator array |
Exceptions
This method can have the following exception:
Name |
Description |
xInvalidParameter |
Thrown if you include both the startInitiatorID and the initiators parameters in the same method call. |
Request example
Requests for this method are similar to the following example:
{
"method": "ListInitiators",
"params": {},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result": {
"initiators": [
{
"alias": "",
"attributes": {},
"initiatorID": 2,
"initiatorName": "iqn.1993-08.org.debian:01:c84ffd71216",
"volumeAccessGroups": [
1
]
}
]
}
}
New since version
9.6