Input Name	Range	Type	Description
force		boolean optional	Forcibly add the initiator, disabling mapping and type conflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibility and is ignored.
initiator		string	WWPN or Alias of Initiator to add.
initiator-group-name		string	Name of initiator group.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_NOT_VALID_FC_WWN
EVDISK_ERROR_NOT_VALID_ISCSI_NAME
EVDISK_ERROR_INITGROUP_HAS_NODE
EVDISK_ERROR_LUN_MAPPING_CONFLICT
EVDISK_ERROR_INITGROUP_TOO_MANY_NODENAMES
EVDISK_ERROR_PARTNER_HAS_LUN
EVDISK_ERROR_PARTNER_NOT_REACHABLE
EVDISK_ERROR_PARTNER_HAS_DIFFERENT_OS_TYPE
EVDISK_ERROR_VIRTUAL_LUN_MAPPING_CONFLICT

Vfiler-enabled

Yes

Bind an existing igroup to a given portset.

Input Name	Range	Type	Description
initiator-group-name		string	Name of initiator group to bind the portset to.
portset-name		string	Name of portset.

Errno	Description
EVDISK_ERROR_PORTSET_NO_SUCH_SET
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_ALREADY_BOUND
EVDISK_ERROR_PORTSET_THROTTLE_EXCEEDED
EVDISK_ERROR_INITGROUP_BIND_WRONG_TYPE
EVDISK_ERROR_INITGROUP_EMPTY_PSET_BIND

Creates a new initiator group. In Data ONTAP 7.3 and later, the ALUA (Asymmetiric Logical Unit Access) attribute will be enabled by default if initiator-group-type is "fcp" and os-type is "aix", "hpux", or "linux. In Data ONTAP Cluster-Mode 8.1 and later, the ALUA attribute is enabled by default on all initiator groups.

Input Name	Range	Type	Description
bind-portset		string optional	Name of a current portset to bind to the newly created igroup.
initiator-group-name		string	Name of initiator group.
initiator-group-type		string	Type of the initiator group. Possible values: "fcp", "iscsi", "mixed". "mixed" is available in Data ONTAP Cluster-Mode 8.1 or later only.
os-type		initiator-group-os-type optional	OS type of the initiators within the group. The default value if not specified is "default". The os type applies to all initiators within the group and governs the finer details of SCSI protocol interaction with these initiators. It is strongly recommended for the caller of this API to specify an OS type that is not "default". Some host OSes require this type field be set correctly in order to function properly.

Errno	Description
EINVALIDINPUTERROR
EVDISK_ERROR_INITGROUP_INVALID_ATTR_OS_TYPE_VALUE
EVDISK_ERROR_INITGROUP_EXISTS
EVDISK_ERROR_INITGROUP_MISSING_ARGS
EVDISK_ERROR_INITGROUP_INVALID_ATTR_TYPE
EVDISK_ERROR_PORTSET_NO_SUCH_SET
EVDISK_ERROR_INITGROUP_EMPTY_PSET_BIND
EVDISK_ERROR_INITGROUP_BIND_WRONG_TYPE

Vfiler-enabled

Yes

Destroys an existing initiator group. By default a group cannot be destroyed if there are existing lun maps defined for that group. This behaviour can be overridden with the use of force option set to "true" which will destroy the initiator group and any associated lun maps.

Input Name	Range	Type	Description
force		boolean optional	Forcibly destroy the initiator group, even if there are existing lun maps. Best practice is to attempt to unmap all the luns associated with a group before destroying it.
initiator-group-name		string	Name of initiator group.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_MAPS_EXIST

Vfiler-enabled

Yes

Get information for initiator group(s).

Input Name	Range	Type	Description
initiator-group-name		string optional	Name of initiator group. If specified, only information for that group is returned. If not specified, information for all inititor groups are returned.
Output Name	Range	Type	Description
initiator-groups		initiator-group-info[]	List of initiator groups.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP

Vfiler-enabled

Yes

Find the path to the lun mapped at a given lun-id for a given initiator group.

Input Name	Range	Type	Description
initiator-group-name		string	Name of initiator group to search.
lun-id	[0..4095]	integer	Lun-id (Logical Unit Number) to search for.
Output Name	Range	Type	Description
path		string	Path to the lun.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_NO_SUCH_LUNMAP

Vfiler-enabled

Yes

Removes node(s) from an initiator group. The operation is prohibited if there are existing lun maps defined for that group. The force option set to "true" can be used to forcibly remove the node regardless of mappings.

Input Name	Range	Type	Description
force		boolean optional	Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group. Best practice is to attempt to unmap all the luns associated with a group before removing the initiator.
initiator		string	WWPN or WWPN Alias of Initiator to remove.
initiator-group-name		string	Name of initiator group.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_MAPS_EXIST
EVDISK_ERROR_NOT_VALID_FC_WWN
EVDISK_ERROR_NOT_VALID_ISCSI_NAME
EVDISK_ERROR_NODE_NOT_IN_INITGROUP

Vfiler-enabled

Yes

Rename an existing initiator group. The rename operation is non-disruptive.

Input Name	Range	Type	Description
initiator-group-name		string	Name of initiator group to be renamed.
initiator-group-new-name		string	New name to be given to initiator group.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_EXISTS
EVDISK_ERROR_CANT_CREATE_INITGROUP_FILE
EVDISK_ERROR_CANT_WRITE_INITGROUP_FILE
EVDISK_ERROR_CANT_RENAME_INITGROUP_FILE
EINVALIDINPUTERROR

Vfiler-enabled

Yes

Sets an attribute for an initiator group.

Input Name	Range	Type	Description
attribute		string	Name of the attribute to change. Possible values: "alua", "os-type", "throttle_borrow", "throttle_reserve", "report_scsi_name". "alua" is available in Data ONTAP 7.2 or later. "report_scsi_name" is available in Data ONTAP 8.1.0 or later. "throttle_reserve","throttle_borrow" and "report_scsi_name" are not available in Data ONTAP Cluster-Mode.
force		boolean optional	If the requested attribute is "os-type", forcibly set the attribute, disabling conflict checks with the high-availability partner where and when applicable. If not specified all conflict checks are performed. This field is ignored in Data ONTAP Cluster-Mode or if the requested attribute is not "os-type".
initiator-group-name		string	Name of initiator group.
value		string	Value for the attribute. The valid values for "os-type" are the supported os-types listed in the igroup-create API. In Data ONTAP 7-Mode, setting the "os-type" attribute will perform checks with the high-availability partner if this filer is running in the 'single_image' fcp cfmode and this igroup is an FCP igroup. The optional force argument can be used to override these checks if the high-availability partner can not be reached. It is also strongly recommended the "default" os-type not be used. Using "default" may cause problems with LUN access. API to always require the proper OS type information The valid values for "throttle_reserve" are 0-99 The valid values for "throttle_borrow" are true or false The valid values for "alua" are true or false The valid values for "report_scsi_name" are true or false

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_MISSING_ARGS
EVDISK_ERROR_INITGROUP_INVALID_ATTR_TYPE
EVDISK_ERROR_IGROUP_NOT_THROTTLED
EVDISK_ERROR_IGROUP_ALREADY_THROTTLED
EVDISK_ERROR_THROTTLE_TOO_MUCH
EVDISK_ERROR_THROTTLE_BEING_DELETED
EVDISK_ERROR_NO_ISCSI_THROTTLES
EVDISK_ERROR_INITGROUP_INVALID_ATTR_MODE_VALUE
EVDISK_ERROR_INITGROUP_INVALID_ATTR_MODE_CONFIG
EVDISK_ERROR_PARTNER_HAS_DIFFERENT_OS_TYPE
EVDISK_ERROR_PARTNER_NOT_REACHABLE
EVDISK_ERROR_ALUA_NOT_SUPPORTED
EVDISK_ERROR_INITGROUP_WRONG_TYPE
EVDISK_ERROR_ALUA_ISCSI_TRANSPORT_TYPE_CONFLICT
EVDISK_ERROR_ALUA_FCP_TRANSPORT_TYPE_CONFLICT

Unbind an existing igroup from a portset.

Input Name	Range	Type	Description
initiator-group-name		string	Name of initiator group to unbind from the portset.

Errno	Description
EVDISK_ERROR_NO_SUCH_INITGROUP
EVDISK_ERROR_INITGROUP_NOT_BOUND
EVDISK_ERROR_PORTSET_THROTTLE_EXCEEDED

Information about an initiator group.

Name	Range	Type	Description
initiator-group-alua-enabled		boolean	Boolean value to indicate if this initiator group has ALUA (Asymmetric Logical Unit Access) features enabled for luns mapped to this initiator group.
initiator-group-name		string	Name of this initiator group.
initiator-group-os-type		initiator-group-os-type	OS type of the initiator group
initiator-group-portset-name		string optional	Name of the portset that is bound to the initiator group, if any.
initiator-group-report-scsi-name-enabled		boolean optional	Boolean value to indicate whether to report or hide SCSI Name String (8h) Descriptor to initiator's INQUIRY VPD 0x83 page command. This field is available in Data ONTAP 8.1.0 and later.
initiator-group-throttle-borrow		boolean	Boolean value to indicate that the igroups throttle reserve may be exceeded if the igroup attempts to use more than it has reserved.
initiator-group-throttle-reserve		integer	Percentage of filer SCSI command blocks reserved for this initiator group's exclusive usage.
initiator-group-type		string	Type of the initiators in this group. Possible values: "iscsi", "fcp", "mixed".
initiator-group-use-partner		boolean optional	Boolean value to indicate if this initiator group is configured for its luns to require the use of host multi-pathing software for correct high-availability failover operation. In Data ONTAP 7-Mode, this value is optional and is only returned for FCP initiator groups on an storage system in an HA pair. In Data ONTAP Cluster-Mode, this field will always be 'true'.
initiator-group-uuid		string optional	This value is Universally-unique identifier (UUID) of this initiator group. The UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hexadecimal characters, the second through fourth groupings have four hexadecimal characters each, and the fifth and final grouping has 12 hexadecimal characters. Note that a leading '0x' is not used. This field is available in Data ONTAP 7-mode 7.3.6, 8.0.2, 8.1.0 and later for the igroup-list-info API. This field is available in Data ONTAP Cluster-Mode 8.1.0 and later for the igroup-get-iter and lun-map-list-info APIs. Here is an example of an actual UUID: 35d6ca90-c759-11df-8b6d-00a098132c6c
initiator-group-vsa-enabled		boolean	Boolean value to indicate if this initiator group has Volume Set Addressing (VSA) enabled or disabled.
initiators		initiator-info[]	List of initiators belonging to this group.
lun-id	[0..4095]	integer optional	LUN identifier to which the LUN is mapped at the host. This value is optional and is only returned for the lun-map-list-info api.

The operating system of the initiator group. This value modifies the finer details of SCSI protocol interaction for initiators in the group. Possible values: "aix" The initiators belong to an AIX host, "default" The initiators belong to an unknown host type, "hpux" The initiators belong to an HP-UX host, "hyper_v" The initiators belong to a Hyper-V parent host, "linux" The initiators belong to a Linux host, "netware" The initators belong to a NetWare host, "openvms" The initiators belong to an OpenVMS host, "solaris" The initiators belong to a Solaris host, "vmware" The initiators belong to a VMware ESX host, "windows" The initiators belong to a Windows host, "xen" The initiators belong to a Xen hypervisor host.

[none]

Information about one initiator.

Name	Range	Type	Description
initiator-name		string	Name of the initiator.