Read
GET v1/initiators
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| access_protocol | NsAccessProtocol |
| initiator_group_id | NsObjectID |
| initiator_group_name | NsObjectName |
| label | NsObjectName |
| iqn | NsIQN |
| ip_address | NsInitiatorIPAddress |
| alias | NsInitiatorAlias |
| wwpn | NsWWN |
| creation_time | NsTime |
| last_modified | NsTime |
GET v1/initiators/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| access_protocol | NsAccessProtocol |
| initiator_group_id | NsObjectID |
| initiator_group_name | NsObjectName |
| label | NsObjectName |
| iqn | NsIQN |
| ip_address | NsInitiatorIPAddress |
| alias | NsInitiatorAlias |
| wwpn | NsWWN |
| creation_time | NsTime |
| last_modified | NsTime |
Description
List a set of initiators used for authentication.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for initiator. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| access_protocol | NsAccessProtocol | string enum | Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'. Possible values: 'iscsi', 'fc'. | |
| initiator_group_id | NsObjectID | string | Identifier of the initiator group that this initiator is assigned to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| initiator_group_name | NsObjectName | string | Name of the initiator group that this initiator is assigned to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| label | NsObjectName | string | Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| iqn | NsIQN | string | IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'. Alphanumeric, hyphenated, colon or period separated string of up to 255 characters or '*'. Example: 'iqn.2007-11.com.storage:zmytestvol1-v0df0fe6f7dc7bb16.0000016b.70374579'. | |
| ip_address | NsInitiatorIPAddress | string | IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'. String of four period-separated numbers, each in range [0,255]. Example: '128.0.0.1' or '*'. | |
| alias | NsInitiatorAlias | string | Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias. String of up to 32 alphanumeric characters, or one of $^-_.: cannot begin with non-alphanumeric character. Example: 'my_initiator-4'. | |
| wwpn | NsWWN | string | WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias. Eight bytes expressed in hex separated by colons. Example: 'af:32:f1:20:bc:ba:43:1a'. | |
| creation_time | NsTime | number | Time when this initiator group was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this initiator group was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. |
JSON Response
{
"data" : {
"initiator_group_name" : "initiatorgrp0.489241334523562",
"wwpn" : "",
"last_modified" : 1426776573,
"access_protocol" : "iscsi",
"initiator_group_id" : "0200000000000004d3000000000000000000000006",
"iqn" : "iqn.1992-01.com.example:storage.tape1.sys1.xyz",
"label" : "label1",
"creation_time" : 1426776573,
"id" : "0b00000000000004d3000000000000000000000001",
"ip_address" : "1.1.1.1",
"alias" : ""
}
}