Manual Pages

Table of Contents


igroup - Commands for managing initiator groups


igroup command argument ...


The igroup family of commands manages the initiator groups. These commands can be used to create new initiator groups and to show, modify or destroy existing ones.


igroup add [ -f ] initiator_group node ...

Adds node(s) to an existing initiator group. You may use the alias for a node set with the fcp wwpnalias command.

The optional -f argument disables checking with the cluster partner for lun mapping conflicts.

igroup bind initiator_group portset

Binds an initiator group to a portset.

The initiator group must not be currently bound to any portset If the initiator group is bound, use the `igroup unbind' command to first unbind the initiator group before attempting to bind to another portset.

You can only bind an initiator group to a non-empty portset.

igroup create { -f | -i } -t ostype [ -a portset ] initia_tor_group [ node ... ]

Creates a new initiator group.

If the -f option is given, an FCP initiator group is created.

If the -i option is given, an iSCSI initiator group is created.

The -t option can be used to specify the ostype 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 solaris, windows, hpux, aix, linux, netware, vmware, openvms, xen and hyper_v.

The -a option can be used to specify a portset to bind to the newly created initiator group. The portset must not be empty in order for an initiator group to bind to it.

If the initiator_group includes spaces, it must be enclosed in double quotation marks. The maximum length of the initiator_group is 96 bytes.

FCP nodes are specified as world wide port names (WWPN), written as 16 hexadecimal characters with optional (:) characters. Alternatively, you may also use aliases set for wwpns using the fcp wwpnalias command. iSCSI nodes are written in the dotted-domain fashion.

igroup destroy [ -f ] initiator_group ...

Destroys existing initiator group(s). 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 -f option which will destroy the initiator group and any associated lun maps.

igroup rename existing_group_name new_group_name

Rename an existing initiator group. The rename operation will not impact access to LUNs that are mapped to the initiator group being modified.

igroup help sub_command

Displays the help information for the given sub_command.

igroup remove [ -f ] initiator_group node ...

Removes node (s) from an initiator group. You may use the alias for the node , set with the fcp wwpnalias command.

The operation is prohibited if there are existing lun maps defined for that group. The -f option can be used to force node removal.

igroup set [ -f ] initiator_group attribute value

Sets an attribute for an initiator group.


Sets the operating system type for this initiator group, valid values are solaris win_dows aix hpux linux netware vmware openvms xen and hyper_v.


Reserves a percentage of SCSI target command blocks for this igroups exclusive usage. Valid values are 0-99 A setting of 0 means the igroup will share the unreserved command block pool.


When set to yes the throttle will exceed its command block reservation if unreserved command blocks are available. If the throttle_reserve is 0 this setting has no meaning.


If yes, then the initiators in the igroup can support Asymmetric Logical Unit Access. The default value for newly created igroups is no. Valid values are yes and no. Alua is supported on all iSCSI igroups, Alua is supported on FCP igroups when the filer is clustered and running in the `single_image' cfmode.

The -f flag overrides all warnings, and is required with rsh.

igroup show [ -v ] [ initiator_group ]

Displays the nodes in an initiator group and their aliases, set with the fcp wwpnalias command. If no initiator_group is specified, the members of all initiator groups are displayed. You can use the -v flag to get a verbose listing.

igroup show -t [ -i interval [ -c count ] [ -a ] ]

If the -t flag is used, igroup throttles will be listed. The -i flag is used to specify the interval over which the statistics will be displayed. The -c option can be used to specify the number of intervals to display statistics for. The -a flag will cause all throttles to be displayed, instead of only throttles with non-zero statistics.

igroup unbind initiator_group

Unbinds an initiator group from a portset.

This allows initiators in the initiator group to access target luns on all ports.


When the system is in takeover mode, the initiator groups for both the systems can be managed using the igroup commands.


When run from a vfiler context (e.g. via the vfiler run command), igroup operates on the concerned vfiler. Initiator groups created in a vfiler context can only be manipulated when the igroup command is executed in that vfiler context. Only iSCSI initiator groups can be created in a non-default vfiler context.


na_vfiler(1), na_lun(1), na_fcp(1), na_iscsi(1), na_san(1)

Table of Contents