APIs in Category: igroup | Cluster-Mode API version 1.15

igroup-get-iter

NetApp Manage ONTAP

igroup-get-iter | [top]

> Iterate over a list of igroup objects.

> Input Name | Range | Type | Description
> desired-attributes |  | initiator-group-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | initiator-group-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the igroup object. All igroup objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | initiator-group-info[] optional | The list of attributes of igroup objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more igroup objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: initiator-group-info | [top]

> 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-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.
> vserver |  | string optional | Name of the vserver hosting this initiator group

Element definition: initiator-group-os-type | [top]

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

Element definition: initiator-info | [top]

> Information about one initiator.

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