Create
POST v1/initiator_groups
Description
Create an initiator group used for authentication.
Normal Response Codes
201
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
SM_conflicting_initiator_alias
SM_conflicting_initiator_alias_with_args
SM_duplicate_initiator_with_args
SM_fc_initiatorgrp_subnet_not_supported
SM_initiatorgroups_out_of_sync
SM_insufficient_fc_initiator_input
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'. | true | ||
| description | NsDescription | string | Text description of initiator group. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | false | |
| access_protocol | NsAccessProtocol | string enum | Initiator group access protocol. Possible values: 'iscsi', 'fc'. | true | ||
| host_type | NsObjectName | string | Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | '' | false | |
| 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. | '[]' | false | |
| iscsi_initiators | NsISCSIInitiators | Array of NsISCSIInitiator | List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label. List of iSCSI initiators. | '[]' | false | |
| fc_initiators | NsFCInitiators | Array of NsFCInitiator | List of FC initiators. When create/update fc_initiators, wwpn is required. List of Fibre Channel initiators. | '[]' | false | |
| app_uuid | NsAppUuid | string | Application identifier of initiator group. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'. | '' | false |
JSON Request
{
"data" : {
"name" : "igroup1",
"access_protocol" : "iscsi",
"target_subnets" : [
{
"id":"0c00000000000004d30000000000000001",
"label" : "subnet1"
}
],
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE"
"app_uuid" : "abcd",
}
}
{
"data" : {
"name" : "igroup1",
"access_protocol" : "iscsi",
"target_subnets" : [
{
"id":"0c00000000000004d30000000000000001",
"label" : "subnet1"
}
],
"iscsi_initiators" : [
{
"label":"itor1",
"ip_address":"1.1.1.1",
"iqn":"iqn.1992-01.com.example:storage.tape1.sys1.xyz"
}
],
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE"
"app_uuid" : "abcd",
}
}
{
"data" : {
"name" : "igroup1",
"access_protocol" : "fc",
"fc_initiators" : [
{
"wwpn":"11:11:11:11:11:11:11:11",
"alias":"alias1"
}
],
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE"
}
}
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'. | |
| host_type | NsObjectName | string | Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| 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. When create/update iscsi_initiators, either iqn or ip_address is always required with label. List of iSCSI initiators. | |
| fc_initiators | NsFCInitiators | Array of NsFCInitiator | List of FC initiators. When create/update fc_initiators, wwpn is required. 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'. | |
| app_uuid | NsAppUuid | string | Application identifier of initiator group. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'. | |
| volume_count | NsUnsignedLong | number | Number of volumes that are accessible by the initiator group. Unsigned 64-bit integer. Example: 1234. | |
| volume_list | NsVolumesWithAppCategoryList | Array of NsVolumeSummaryWithAppCategory | List of volumes that are accessible by the initiator group. List of volumes. | |
| num_connections | NsUnsignedLong | number | Total number of connections from initiators in the initiator group. Unsigned 64-bit integer. Example: 1234. |
JSON Response
{
"data" : {
"search_name" : "igroup1",
"name" : "igroup1",
"last_modified" : 1426776461,
"fc_initiators" : null,
"access_protocol" : "iscsi",
"app_uuid" : "abcd",
"iscsi_initiators" : null,
"full_name" : "igroup1",
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE",
"creation_time" : 1426776461,
"id" : "0200000000000004d3000000000000000000000001",
"target_subnets" : [
{
"id":"0c00000000000004d30000000000000001",
"label" : "subnet1"
}
]
}
}
{
"data" : {
"search_name" : "igroup1",
"name" : "igroup1",
"last_modified" : 1426776461,
"fc_initiators" : null,
"access_protocol" : "iscsi",
"app_uuid" : "abcd",
"full_name" : "igroup1",
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE",
"creation_time" : 1426776461,
"id" : "0200000000000004d3000000000000000000000001",
"target_subnets" : [
{
"id":"0c00000000000004d30000000000000001",
"label" : "subnet1"
}
],
"iscsi_initiators": [
{
"id": "0b00000000000004d3000000000000000000000001",
"initiator_id": "0b00000000000004d3000000000000000000000001",
"label": "itor1",
"iqn": "iqn.1992-01.com.example:storage.tape1.sys1.xyz",
"ip_address": "1.1.1.1"
}
]
}
}
{
"data" : {
"search_name" : "igroup1",
"name" : "igroup1",
"last_modified" : 1426776461,
"access_protocol" : "fc",
"app_uuid" : "",
"iscsi_initiators" : null,
"full_name" : "igroup1",
"description" : "wtuNSNWYXWKznxsLIBZndxctuEEkoEtarxaXW0K3IAUbK0FtLgKkJ4pzNR1NhZXE",
"creation_time" : 1426776461,
"id" : "0200000000000004d3000000000000000000000001",
"target_subnets" : null,
"fc_initiators": [
{
"id": "0b00000000000004d3000000000000000000000001",
"initiator_id": "0b00000000000004d3000000000000000000000001",
"wwpn": "11:11:11:11:11:11:11:11",
"alias": "alias1"
}
]
}
}