Input Name	Range	Type	Description
force		boolean optional	Forcibly add the initiator, disabling mapping and type conflict checks with the cluster partner. If not specified all conflict checks are performed.
initiator		string	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

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

Creates a new initiator group.

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, currently only "iscsi" and "fcp" are supported.
os-type		string optional	OS type of the initiators within the group. While optional, this field should always be specified. Please see Note below. The type applies to all initiators within the group and governs the finer details of SCSI protocol interaction with these initiators. Valid arguments are "default", "solaris", "windows", "hpux", "aix", "linux", "netware" and "vmware". If not specified, "default" is used. *NOTE* 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.
ostype		string optional	Deprecated: use os-type instead; OS type of the initiators within the group. While optional, this field should always be specified. Please see Note below. The type applies to all initiators within the group and governs the finer details of SCSI protocol interaction with these initiators. Valid arguments are "default", "solaris", "windows", "hpux", "aix", "linux", "netware" and "vmware". If not specified, "default" is used. *NOTE* 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		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

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	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

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, Currently supported attributes are: os-type throttle_reserve throttle_borrow alua
force		boolean optional	Forcibly set the attribute, disabling conflict checks with the cluster partner where and when applicable. If not specified all conflict checks are performed.
initiator-group-name		string	Name of initiator group.
value		string	Value for the attribute. The valid values for "os-type" are "default", "solaris", "windows", "hpux", "aix", "linux", "netware" and "vmware". Setting the "os-type" attribute will perform checks with the cluster partner if this filer is running in the 'single_image' fcp cfmode and this igroup is an FCP igroups. The optional force argument can be used to override these checks if the cluster partner can not be reached. It is also strongly recommended the "default" os-type not be used and for the caller of this API to always require the proper OS type information to be obtained. Using "default" is dangerous because it could potentially cause problems with LUN access. The valid values for "throttle_reserve" are 0-99 The valid values for "throttle_borrow" are true or false The valid valuse for "alua" 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

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		string	OS type of the initiator group Possible values:aix, default, hpux, linux, solaris, windows, netware, unknown, vmware
initiator-group-portset-name		string optional	Name of the portset that is bound to the initiator group, if any.
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. Current supported types are "iscsi", "fcp" and unknown.
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 cluster failover operation. This value is optional and is only returned for FCP initiator groups on clustered filers.
initiator-group-vsa-enabled		boolean	Boolean value to indicate if this initiator group has VSA enabled or disabled.
initiators		initiator-info[]	List of initiators belonging to this group.
lun-id		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.

Information about one initiator.

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