APIs in Category: igroup
 API version 1.2

 
igroup-add
igroup-create
igroup-destroy
igroup-list-info
igroup-remove
igroup-set-attribute

NetApp Manage ONTAP
 
igroup-add [top]

Adds initiator to an existing initiator group.
Input Name Range Type Description
initiator string
Initiator to add.
initiator-group-name string
Name of initiator group.
 Errno  Description
 VDISK_ERROR_NO_SUCH_INITGROUP
 VDISK_ERROR_NOT_VALID_FC_WWN
 VDISK_ERROR_NOT_VALID_ISCSI_NAME
 VDISK_ERROR_INITGROUP_HAS_NODE
 VDISK_ERROR_LUN_MAPPING_CONFLICT

 
igroup-create [top]
Creates a new initiator group.
Input Name Range Type Description
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. 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" and "linux". If not specified, "default" is used.
 Errno  Description
 EINVALIDINPUTERROR
 VDISK_ERROR_INITGROUP_INVALID_ATTR_OS_TYPE_VALUE
 VDISK_ERROR_INITGROUP_EXISTS
 VDISK_ERROR_INITGROUP_MISSING_ARGS
 VDISK_ERROR_INITGROUP_INVALID_ATTR_TYPE

 
igroup-destroy [top]
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
 VDISK_ERROR_NO_SUCH_INITGROUP
 VDISK_ERROR_INITGROUP_MAPS_EXIST

 
igroup-list-info [top]
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
 VDISK_ERROR_NO_SUCH_INITGROUP

 
igroup-remove [top]
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
 VDISK_ERROR_NO_SUCH_INITGROUP
 VDISK_ERROR_INITGROUP_MAPS_EXIST
 VDISK_ERROR_NOT_VALID_FC_WWN
 VDISK_ERROR_NOT_VALID_ISCSI_NAME
 VDISK_ERROR_NODE_NOT_IN_INITGROUP

 
igroup-set-attribute [top]
Sets an attribute for an initiator group. The current attribute supported is the ostype for the initiator group. The valid values are default, solaris, windows, hpux, aix and linux.
Input Name Range Type Description
attribute string
Name of the attribute, currently only "ostype" is supported.
initiator-group-name string
Name of initiator group.
value string
Value for the attribute. The valid values are "default", "solaris", "windows", "hpux", "aix" and "linux".
 Errno  Description
 VDISK_ERROR_NO_SUCH_INITGROUP
 VDISK_ERROR_INITGROUP_MISSING_ARGS
 VDISK_ERROR_INITGROUP_INVALID_ATTR_TYPE

 
Element definition: initiator-group-info [top]
Information about an initiator group.
Name Range Type Description
initiator-group-name string
Name of this initiator group.
initiator-group-os-type string
OS type of the initiator group, i.e. "windows", "solaris", etc.
initiator-group-type string
Type of the initiators in this group. Current supported types are "iscsi" and "fcp".
initiators initiator-info[]
List of initiators belonging to this group.

 
Element definition: initiator-info [top]
Information about one initiator.
Name Range Type Description
initiator-name string
Name of the initiator.