Create
POST v1/initiator_groups
Description
Create an initiator group used for authentication.
Normal Response Codes
201
HTTP Error Codes
400 401 404 409 500 503
Detail Error Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsObjectName | string | Name of initiator group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | Yes | ||
| description | NsDescription | string | Text description of initiator group. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | No | |
| access_protocol | NsAccessProtocol | string enum | Initiator group access protocol. Possible values: 'iscsi', 'fc'. | Yes | ||
| target_subnets | NsTargetSubnets | Array of NsTargetSubnet | List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets. List of target subnet tables. | '[]' | No |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for initiator group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of initiator group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| full_name | NsObjectName | string | Initiator group's full name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| search_name | NsSearchName | string | Initiator group name used for search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Text description of initiator group. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| access_protocol | NsAccessProtocol | string enum | Initiator group access protocol. Possible values: 'iscsi', 'fc'. | |
| target_subnets | NsTargetSubnets | Array of NsTargetSubnet | List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets. List of target subnet tables. | |
| iscsi_initiators | NsISCSIInitiators | Array of NsISCSIInitiator | List of iSCSI initiators. List of iSCSI initiators. | |
| fc_initiators | NsFCInitiators | Array of NsFCInitiator | List of FC initiators. List of Fibre Channel initiators. | |
| 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