Create an initiator group
POST /protocols/san/igroups
Introduced In: 9.6
Creates an initiator group.
Required properties
-
svm.uuid
orsvm.name
- Existing SVM in which to create the initiator group. -
name
- Name of the initiator group. -
os_type
- Operating system of the initiator group's initiators.
Recommended optional properties
-
initiators.name
- Name(s) of initiator group's initiators. This property can be used to create the initiator group and populate it with initiators in a single request.
Default property values
If not specified in POST, the following default property values are assigned.
-
protocol
- mixed - Data protocol of the initiator group's initiators.
Related ONTAP commands
-
lun igroup create
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
Name | Type | Description |
---|---|---|
_links |
||
comment |
string |
A comment available for use by the administrator. Valid in POST and PATCH. |
connectivity_tracking |
An overview of the connections to ONTAP by the initiators in this group.
|
|
delete_on_unmap |
boolean |
An option that causes the initiator group to be deleted when the last LUN map associated with it is deleted. Optional in POST and PATCH. This property defaults to false when the initiator group is created. |
igroups |
array[igroup_child] |
The initiator groups that are members of the group. Optional in POST. This property is mutually exclusive with the initiators property during POST. This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregatation of all initiators in any nested initiator groups. After creation, nested initiator groups can be added or removed from the initiator group using the |
initiators |
array[initiators] |
The initiators that are members of the group or any group nested below this group. Optional in POST. This property is mutually exclusive with the igroups property during POST. During GET, this array contains initiators that are members of this group or any nested initiator groups below this group. When initiators of nested groups are returned, they include links to the initiator group that directly contains the initiator. Zero or more initiators can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the |
lun_maps |
array[lun_maps] |
All LUN maps with which the initiator is associated. If the requested igroup is part of a remote, non-local, MetroCluster SVM, the LUN maps are not retrieved. There is an added computational cost to retrieving property values for |
name |
string |
The name of the initiator group. Required in POST; optional in PATCH. |
os_type |
string |
The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH. |
parent_igroups |
array[igroup_parent] |
The initiator groups that contain this initiator group as a member. |
portset |
The portset to which the initiator group is bound. Binding the initiator group to a portset restricts the initiators of the group to accessing mapped LUNs only through network interfaces in the portset. In a nested initiator group hierarchy, only a portset bound to the initiator group at the same level at which it is mapped, applies; portsets bound to parent or child initiator groups are ignored. Optional in POST and PATCH. To unbind a portset from the initiator group, PATCH the |
|
protocol |
string |
The protocols supported by the initiator group. This restricts the type of initiators that can be added to the initiator group. Optional in POST; if not supplied, this defaults to mixed. The protocol of an initiator group cannot be changed after creation of the group. |
replication |
Properties related to initator group replication. |
|
supports_igroups |
boolean |
An initiator group may contain either initiators or other initiator groups, but not both simultaneously. This property is true when initiator groups can be added to this initiator group. The |
svm |
SVM, applies only to SVM-scoped objects. |
|
target |
Properties of the SCSI target to which the initiator group provides access. |
|
uuid |
string |
The unique identifier of the initiator group. |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"alerts": [
{
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
}
],
"connection_state": "string",
"required_nodes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
]
},
"igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"igroups": [
null
],
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"initiators": [
{
"_links": {
"connectivity_tracking": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"connection_state": "string"
},
"igroup": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"name": "iqn.1998-01.com.corp.iscsi:name1",
"proximity": {
"peer_svms": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
}
]
}
}
],
"lun_maps": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"logical_unit_number": 0,
"lun": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "lun1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
}
],
"name": "igroup1",
"os_type": "string",
"parent_igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"name": "igroup1",
"parent_igroups": [
null
],
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"portset": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "portset1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"protocol": "string",
"replication": {
"error": {
"igroup": {
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
},
"peer_svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
},
"state": "string"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"target": {
"firmware_revision": "9111",
"product_id": "LUN C-Mode",
"vendor_id": "NETAPP"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
Response
Status: 201, Created
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
The number of records in the response. |
records |
array[igroup] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"alerts": [
{
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
}
],
"connection_state": "string",
"required_nodes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
]
},
"igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"igroups": [
null
],
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"initiators": [
{
"_links": {
"connectivity_tracking": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"connectivity_tracking": {
"connection_state": "string"
},
"igroup": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"name": "iqn.1998-01.com.corp.iscsi:name1",
"proximity": {
"peer_svms": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
}
]
}
}
],
"lun_maps": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"logical_unit_number": 0,
"lun": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "lun1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
}
],
"name": "igroup1",
"os_type": "string",
"parent_igroups": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"name": "igroup1",
"parent_igroups": [
null
],
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"portset": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "portset1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"protocol": "string",
"replication": {
"error": {
"igroup": {
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"summary": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
}
},
"peer_svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "peer1",
"uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
},
"state": "string"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"target": {
"firmware_revision": "9111",
"product_id": "LUN C-Mode",
"vendor_id": "NETAPP"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
]
}
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
2621462 |
The supplied SVM does not exist. |
2621706 |
The specified |
2621707 |
No SVM was specified. Either |
5373958 |
An invalid initiator group name was supplied. |
5373966 |
An initiator group cannot be created in an SVM that is configured for NVMe. |
5373969 |
A supplied initiator name looks like an iSCSI IQN initiator, but the portions after the prefix are missing. |
5373971 |
A supplied initiator name looks like an iSCSI IQN initiator, but the date portion is invalid. |
5373972 |
A supplied initiator name looks like an iSCSI IQN initiator, but the naming authority portion is invalid. |
5373977 |
A supplied initiator name looks like an iSCSI EUI initiator, but the length is invalid. |
5373978 |
A supplied initiator name looks like an iSCSI EUI initiator, but the format is invalid. |
5373982 |
An invalid WWN was specified. The length is incorrect. |
5373983 |
An invalid WWN was specified. The format is incorrect. |
5373992 |
A supplied initiator name was too long to be valid. |
5373993 |
A supplied initiator name did not match any valid format. |
5374023 |
An initiator group with the same name already exists. |
5374027 |
An attempt was made to bind a portset with no member network interfaces to the initiator group. |
5374028 |
An attempt was made to bind a portset with an incompatible protocol to the initiator group. |
5374038 |
An invalid Fibre Channel WWPN was supplied. |
5374039 |
An invalid iSCSI initiator name was supplied. |
5374040 |
Initiators and child initiator groups were both supplied, but only one option is allowed. |
5374732 |
An initiator is already in another initiator group with a conflicting operating system type. |
5374735 |
An attempt was made to add a child igroup that would exceed the maximum allowable depth. |
5374737 |
A supplied child initiator group already exists in another initiator group's hierarchy. |
5374739 |
A supplied child initiator group has an operating system type that differs from the parent initiator group. |
5374740 |
A supplied child initiator group has an protocol that differs from the parent initiator group. |
5374741 |
A supplied child initiator group is already owned by a different child in the initiator group's hierarchy. |
5374742 |
A supplied child initiator group contains an initiator that is already owned by another initiator group in the hierarchy. |
5374745 |
Initiator group cannot be added as a child to itself. |
5374746 |
The cluster is currently running in a mixed version and nested initiator groups cannot be created until the effective cluster version reaches 9.9.1. |
5374747 |
The cluster is currently running in a mixed version and initiator group comments cannot be created until the effective cluster version reaches 9.9.1. |
5374758 |
An error was reported by the peer cluster while creating a replicated initiator group. The specific error will be included as a nested error. |
5374878 |
The supplied child initiator group does not exist. |
5374911 |
The supplied portset does not exist. |
5374917 |
Duplicated initiators have conflicting property values. |
5375055 |
The |
5375056 |
An SVM peering relationship that does not have the initiator group's SVM as the local SVM was specified. |
5375258 |
The igroup is already replicated to a different peer SVM. |
5375261 |
Setting initiator proximity is not supported for the SVM type. |
5376057 |
Setting initiator proximity is not supported for the ONTAP version. |
5376059 |
Setting initiator proximity to a peer that is either the destination of an SVM DR relationship or in a Metrocluster configuration is not supported. |
5376253 |
Initiator group replication requires an effective cluster version of 9.15.1. |
5376255 |
Initiator group replication requires the peer cluster to have an effective cluster version of 9.15.1. |
6620376 |
SVM peering information is unavailable. |
6620384 |
The supplied SVMs are not peered. |
26345672 |
The specified SVM peering relationship was not found. |
26345673 |
An SVM peering relationship between the initiator group's SVM and specified peer SVM was not found. |
26345675 |
An SVM peering relationship UUID and name were specified and they do not refer to the same SVM peering relationship. |
26345680 |
Supplied SVM peer is on the local cluster. The operation requires a peer on a remote cluster. |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
summary
A user friendly message describing the connection state of the initiator group.
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |