APIs in Category: igroup |
API version 6.1 |
igroup-iter |
igroup-iter | [top] |
Iterate over initiator groups.
Input Name Range Type Description max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance. resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are: If resource-filter identifies a igroup, that single igroup will be returned. If resource-filter resolves to more than one igroup, all of them will be returned. If no resource-filter is provided, all igroups will be listed.
- cluster
- vserver
- lun
- igroup
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls. Output Name Range Type Description next-tag string
optional
Tag for the next call. Not present when there are no more objects to return. num-records integer
The number of records returned in this call. records igroup-info[]
optional
The list of records.
Element definition: igroup-info | [top] |
Information about one igroup.
Name Range Type Description alua-enabled boolean
optional
Indicates whether ALUA (Asymmetric Logical Unit Access) features are enabled for luns mapped to this initiator group. igroup-name obj-name
Name of the igroup. igroup-type string
Specifies the type (protocol) of the igroup. Possible values are: 'fcp', 'iscsi', and 'mixed' initiators initiator-name[]
Lists the initiators belonging to this igroup. os-type string
Specifies the operating system of the igroup. Possible values are: 'windows', 'linux', 'aix', 'hpux', 'solaris', 'hyper_v', 'vmware', 'xen', 'netware', 'openvms' and 'default'. portset-name obj-name
optional
Name of the portset to which the igroup is bound to. This element will be present only if the igroup is bound to a portset. Portset contains a set of iSCSI Target Portal Groups and/or FCP logical interfaces. The initiators in the igroup can access the mapped LUNs only through the ports added to the portset. portset-resource-key resource-key
optional
Resource key of the portset to which the igroup is bound to. This element will be present only if the igroup is bound to a portset. resource-key resource-key
Resource key of this igroup. vsa-enabled boolean
optional
Indicates whether this initiator group has Volume Set Addressing (VSA) enabled or disabled. vserver-name obj-name
Name of the Vserver to which the igroup belongs. vserver-resource-key resource-key
Resource key of the Vserver to which the igroup belongs.
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: initiator-name | [top] |
Name of the initiator.
[none]
Element definition: obj-name | [top] |
Name of an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format: The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules:
- It must contain between 1 and 64 characters.
- It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
- In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all.
A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior.
- If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUT. Note that because EINVALIDINPUT is such a common error code, ZAPI specifications are not required to document cases when they may return it.
- If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code.
If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name.
[none]