APIs in Category: portset
API version 6.1

 
portset-iter

NetApp Manage ONTAP
 
portset-iter [top]

Iterate over portsets.
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:
  • resource group
  • cluster
  • vserver
  • portset
  • initiator group
If resource-filter identifies a portset, that single portset will be returned. If resource-filter resolves to more than one portset, all of them will be returned. If no resource-filter is provided, all portsets will be listed.
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 portset-info[]
optional
The list of records.

 
Element definition: portset-info [top]
Information about a portset.
Name Range Type Description
portset-igroups portset-igroup[]
List of initiator group bound to this portset.
portset-members portset-member[]
List of portset members. The portset members can be tpgroups, FCP data LIFs.
portset-name obj-name
Name of the portset.
portset-type string
Portset type. The type of portset can be
  • iscsi
  • fcp
  • mixed
resource-key resource-key
Resource Key for this portset.
vserver-name obj-name
Name of vserver on which the portset resides. Always present in the output. The name is any simple name such as 'myhost'.
vserver-resource-key resource-key
Identifier of vserver on which the portset resides. Always present in the output.

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[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:
  • 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.
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:
  • 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.
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 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]

 
Element definition: portset-igroup [top]
List of initiator group bound to the portset.
Name Range Type Description
igroup-name string
Name of initiator group bound to this portset.
igroup-resource-key resource-key
Identifier of initiator group.

 
Element definition: portset-member [top]
Name of the portset member (tpgroups or FCP data LIF).
[none]

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]