Skip to main content

Update an initiator group

Contributors
PDFs

PATCH /protocols/san/igroups/{uuid}

Introduced In: 9.6

Updates an initiator group.

  • lun igroup modify

  • lun igroup rename

  • lun igroup bind

  • lun igroup unbind

Learn more

Request Body

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator. Valid in POST and PATCH.

connectivity_tracking

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

  • readOnly: 1

  • Introduced in: 9.11

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 igroups property of the child initiator group.

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 /protocols/san/igroups/{igroup.uuid}/igroups endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.

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 /protocols/san/igroups/{igroup.uuid}/initiators endpoint. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

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 lun_maps. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

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

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 portset object to null, or PATCH portset.name to an empty string ("").

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

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 initiators.name property cannot be used to determine this via a query because it reports initiators inherited from nested igroups.

svm

svm

SVM, applies only to SVM-scoped objects.

target

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: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1254264

An attempt was made to bind a portset to an initiator group that is already bound to a portset.

5373958

An invalid initiator group name was supplied for a rename operation.

5374023

A rename operation failed because 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.

5374733

An initiator is already in another initiator group with a conflicting operating system type.

5374745

An attempt was made to add an initiator group 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.

5374749

An initiator group's replication peer SVM cannot be changed without first being cleared.

5374759

An error was reported by the peer cluster while modifying a replicated initiator group. The specific error will be included as a nested error.

5374763

An error was reported by the peer cluster while renaming a replicated initiator group. The specific error will be included as a nested error.

5374765

An initiator group cannot be replicated if it has unreplicated child initiatior groups.

5374766

A replicated initiator group cannot be changed to unreplicated if it is the child of a replicated initiatior group.

5374770

An unreplicated initiator group cannot be changed to replicated due to a conflict in its LUN maps.

5374852

The initiator group does not exist.

5374868

The initiator group was partially modified before an error was encountered while renaming the initiator group.

5375258

The igroup is already replicated to a different peer SVM.

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.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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

href

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

string

Error message

alerts

Name Type Description

summary

summary

A user friendly message describing the connection state of the initiator group.

required_nodes

Name Type Description

_links

_links

name

string

uuid

string

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

Name Type Description

alerts

array[alerts]

connection_state

string

Connection state.

required_nodes

array[required_nodes]

Nodes to which the initiators in this group should be connected to ensure reliable service. This is the collection of any node hosting a LUN mapped to this igroup as well as the HA partners of those nodes.

igroup_child

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator.

igroups

array[]

Further nested initiator groups.

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

Name Type Description

href

string

self

A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

Name Type Description

href

string

_links

Name Type Description

connectivity_tracking

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

self

self

A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

connectivity_tracking

Overview of the initiator's connections to ONTAP.

Name Type Description

connection_state

string

Connection state.

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

Name Type Description

_links

_links

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

peer_svms

A reference to an SVM peer relationship.

Name Type Description

_links

_links

name

string

The local name of the peer SVM. This name is unique among all local and peer SVMs.

uuid

string

The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

Name Type Description

local_svm

boolean

A boolean that indicates if the initiator is proximal to the SVM of the containing initiator group. This is required for any POST or PATCH that includes the proximity sub-object.

peer_svms

array[peer_svms]

An array of remote peer SVMs to which the initiator is proximal.

initiators

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator. Valid in POST and PATCH.

connectivity_tracking

connectivity_tracking

Overview of the initiator's connections to ONTAP.

  • readOnly: 1

  • Introduced in: 9.11

igroup

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

name

string

The FC WWPN, iSCSI IQN, or iSCSI EUI that identifies the host initiator. Valid in POST only and not allowed when the records property is used.

An FC WWPN consists of 16 hexadecimal digits grouped as 8 pairs separated by colons. The format for an iSCSI IQN is iqn.yyyy-mm.reverse_domain_name:any. The iSCSI EUI format consists of the eui. prefix followed by 16 hexadecimal characters.

proximity

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

node

Name Type Description

_links

_links

name

string

uuid

string

lun

The LUN to which the initiator group is mapped.

Name Type Description

_links

_links

name

string

The name of the LUN.

node

node

uuid

string

The unique identifier of the LUN.

lun_maps

A LUN map with which the initiator group is associated.

Name Type Description

_links

_links

logical_unit_number

integer

The logical unit number assigned to the LUN for initiators in the initiator group.

lun

lun

The LUN to which the initiator group is mapped.

igroup_parent

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator.

name

string

The name of the initiator group.

parent_igroups

array[]

The initiator groups that contain this initiator group as a member.

uuid

string

The unique identifier of the initiator group.

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 portset object to null, or PATCH portset.name to an empty string ("").

Name Type Description

_links

_links

name

string

The name of the portset.

uuid

string

The unique identifier of the portset.

igroup

Name Type Description

local_svm

boolean

Indicates whether the reported igroup is on the local SVM or the peer SVM. When deleting a replicated igroup, the local copy is deleted first and then the peer copy is deleted. If the error is encountered between these two operations and only the peer igroup remains, the peer igroup is reported and the problem might need to be corrected on the peer cluster.

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

summary

A user friendly message describing the error.

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

error

Information about asynchronous errors encountered while replicating this igroup. Igroups within a peering relationship are replicated in the same stream, so the error reported here might be related to this igroup or a prior replicated igroup that is now blocking the replication of this igroup. Both the error information and the igroup encountering the error are reported. If the error is configuration related, it can be corrected on the referenced igroup. The replication is retried using exponential backoff up to a maximum of one retry every 5 minutes. Every operation on the same stream triggers an immediate retry and restarts the exponential backoff starting with a 1 second delay. If the error is system related, the retries should correct the error when the system enters a healthy state.

Name Type Description

igroup

igroup

summary

summary

A user friendly message describing the error.

peer_svm

The peered SVM to which the initiator group should be replicated. Optional in POST and PATCH. To clear any previously set replication peer, PATCH the replication.peer_svm object to null.

Name Type Description

_links

_links

name

string

The local name of the peer SVM. This name is unique among all local and peer SVMs.

uuid

string

The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

replication

Properties related to initator group replication.

Name Type Description

error

error

Information about asynchronous errors encountered while replicating this igroup. Igroups within a peering relationship are replicated in the same stream, so the error reported here might be related to this igroup or a prior replicated igroup that is now blocking the replication of this igroup. Both the error information and the igroup encountering the error are reported. If the error is configuration related, it can be corrected on the referenced igroup. The replication is retried using exponential backoff up to a maximum of one retry every 5 minutes. Every operation on the same stream triggers an immediate retry and restarts the exponential backoff starting with a 1 second delay. If the error is system related, the retries should correct the error when the system enters a healthy state.

peer_svm

peer_svm

The peered SVM to which the initiator group should be replicated. Optional in POST and PATCH. To clear any previously set replication peer, PATCH the replication.peer_svm object to null.

state

string

The state of the replication queue associated with this igroup. If this igroup is not in the replication queue, the state is reported as ok. If this igroup is in the replication queue, but no errors have been encountered, the state is reported as replicating. If this igroup is in the replication queue and the queue is blocked by an error, the state is reported as error. When in the error state, additional context is provided by the replication.error property.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

target

Properties of the SCSI target to which the initiator group provides access.

Name Type Description

firmware_revision

string

The firmware revision of the SCSI target specific to the OS type of the initiator group.

product_id

string

The product ID of the SCSI target.

vendor_id

string

The vendor ID of the SCSI target.

igroup

An initiator group (igroup) is a collection of Fibre Channel (FC) world wide port names (WWPNs), and/or iSCSI Qualified Names (IQNs), and/or iSCSI EUIs (Extended Unique Identifiers) that identify host endpoints.

Initiator groups are used to control which hosts can access specific LUNs. To grant access to a LUN from one or more hosts, create an initiator group containing the host initiator names, then create a LUN map that associates the initiator group with the LUN.

An initiator group may contain either initiators or other initiator groups, but not both simultaneously. When a parent initiator group is mapped, it inherits all of the initiators of any initiator groups nested below it. If any nested initiator group is modified to contain different initiators, the parent initiator groups inherit the change. A parent can have many nested initiator groups and an initiator group can be nested under multiple parents. Initiators can only be added or removed from the initiator group that directly contains them. The maximum supported depth of nesting is three layers.

Best practice when using nested initiator groups is to match host hierarchies. A single initiator group should correspond to a single host. If a LUN needs to be mapped to multiple hosts, the initiator groups representing those hosts should be aggregated into a parent initiator group and the LUN should be mapped to that initiator group. For multi-ported hosts, initiators have a comment property where the port corresponding to the initiator can be documented.

An initiator can appear in multiple initiator groups. An initiator group can be mapped to multiple LUNs. A specific initiator can be mapped to a specific LUN only once. With the introduction of nestable initiator groups, best practice is to use the hierarchy such that an initiator is only a direct member of a single initiator group, and that initiator group can then be referenced by other initiator groups.

All initiators or nested initiator groups in an initiator group must be from the same operating system. The initiator group's operating system is specified when the initiator group is created.

When an initiator group is created, the protocol property is used to restrict member initiators to Fibre Channel (fcp), iSCSI (iscsi), or both (mixed). Initiator groups within a nested hierarchy may not have conflicting protocols.

Zero or more initiators or nested initiator groups can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/initiators endpoint. Initiator groups containing other initiator groups report the aggregated list of initiators from all nested initiator groups, but modifications of the initiator list must be performed on the initiator group that directly contains the initiators. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator. Valid in POST and PATCH.

connectivity_tracking

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

  • readOnly: 1

  • Introduced in: 9.11

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 igroups property of the child initiator group.

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 /protocols/san/igroups/{igroup.uuid}/igroups endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.

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 /protocols/san/igroups/{igroup.uuid}/initiators endpoint. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

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 lun_maps. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

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

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 portset object to null, or PATCH portset.name to an empty string ("").

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

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 initiators.name property cannot be used to determine this via a query because it reports initiators inherited from nested igroups.

svm

svm

SVM, applies only to SVM-scoped objects.

target

target

Properties of the SCSI target to which the initiator group provides access.

uuid

string

The unique identifier of the initiator group.

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.