APIs in Category: group_member | API version 4.0

group-member-list-iter-end group-member-list-iter-next group-member-list-iter-start

NetApp Manage ONTAP

group-member-list-iter-end | [top]

> See group-member-list-iter-start for more information. Frees up the resources used by previous call to group-member-list-iter-start.

> Input Name | Range | Type | Description
> tag |  | string | Tag returned by the call to group-member-list-iter-start

> Errno | Description
> EINVALIDTAG |  |

group-member-list-iter-next | [top]

> See group-member-list-iter-start for more information. The group-list-iter-next API is used to iterate over the members of the group stored in the temporary store created by the group-list-iter-start API. The DFM station, internally, maintains a cursor pointing to the last record returned. Subsequent calls to this API will return the records after the cursor up to the specified "maximum" or number of actual records left.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of records to be returned from the temporary store.
> tag |  | string | Tag from a previous group-member-list-iter-start. It's an opaque handle used by the DFM station to identify the temporary store created by group-member-list-iter-start.
> Output Name | Range | Type | Description
> group-member-list |  | group-member-info[] | A record in the temporary store describing a group member. A group member is a DFM object
> records |  | integer | The number of entries actually returned as a result of invoking this API.

> Errno | Description
> EAPIPRIVILEDGE |  |
> EAPILICENSE |  |
> ESVCDISABLED |  |
> ESVCNOTAVAIL |  |
> EINVALIDTAG |  |

group-member-list-iter-start | [top]

> DFM has an object that is known as the "group" that contains other DFM objects. Group may also have subgroups. The group-member-list-* APIs are used to retrieve the members of particular groups. These APIs can be used to retrieve either all members or particular type of members of groups. These APIs don't return the subgroups. Use group-list-iter-start to get a list of subgroups. The group-member-list-iter-start API is used to load the group members into a temporary store. Subsequent group-member-list-iter-next invocations iterate over the records in the temporary store. The group-member-list-iter-end API is used to release the temporary store. If group-member-list-iter-start is invoked twice, then the DFM station will create two different temporary stores that can be accessed using the different tags. When this API is invoked without specifying any groups, type parameter must be specified. In that case, API lists all the objects of specified type that are known to DFM. Those objects may or may not be members of any group. If you specify groups when invoking this API, type parameter is optional. API lists all the objects (optionally, of the specified type) that have been directly added to the specified groups.

> Input Name | Range | Type | Description
> groups |  | group[] optional | A list of group names. If no groups are specified, all the DFM objects of the specified type are listed. You must specify either groups or type or both.
> hide-subgroup-members |  | boolean optional | If TRUE, omits members of the subgroups. Otherwise, members of subgroups are also listed.
> object-management-filter |  | object-management-interface optional | Filter the object based on the Data ONTAP interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all objects will be considered.
> type |  | string optional | The type of the members to be listed. Possible values include Cluster, Filer, Agent, Cache, OSSV Host, vFiler, vserver, Volume, Qtree, Configuration, Initiator Group, Lun Path, FCP Target, FCP Initiator, SRM Path, Aggregate, Resource Pool, Dataset. If not specified, all the group members are listed. You must specify either groups or type or both.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with group-member-list-iter-next.
> tag |  | string | Tag to be used in subsequent calls to group-member-list-iter-next.

Element definition: group | [top]

> group name or identifier

> [none]

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

> Name | Range | Type | Description
> group-member-attributes |  | group-member-attribute[] optional | Attributes of the DFM object
> id |  | string | DFM id of the DFM object
> name |  | string | DFM name of the DFM object
> perf-status |  | obj-status | The performance status of the DFM object
> status |  | obj-status | The status of the DFM object
> sub-type |  | string optional | For members of type Host, this is the kind of host; possible values: filer, vfiler, agent, ossv, cluster, vserver. For all other members, this field is absent.
> type |  | string | Type of the DFM object which can be one of Host, Aggregate, Volume, Qtree, Configuration, Initiator Group, Lun Path, FCP Target, FCP Initiator, SRM Path, Resource Pool, or Dataset.

Element definition: object-management-interface | [top]

> Specify the management interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible values are: "node" - For objects manageable by node management interface "cluster" - For objects manageable by cluster management interface

> [none]

Element definition: group-member-attribute | [top]

> Additional named attributes of the DFM object Current attributes are: 'OS Version', 'OS Revision', and 'Primary Address'

> Name | Range | Type | Description
> name |  | string | name of the attribute.
> value |  | string optional | value of the attribute.

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the storage system or agent. warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption. error: An object has error status when it does not cause any service disruption, but it may affect performance. critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]