APIs in Category: qtree | Cluster-Mode API version 1.20

qtree-list-iter | Because of possible large amount of information returned by qtree list, it is highly recommended to use the qtree list iterator APIs. There are three iterator APIs for qtree list: -start, -next, and -end.

NetApp Manage ONTAP

qtree-list-iter | [top]

> Iterate over the list of qtrees in the cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | qtree-info optional | Specify the attributes that should be returned in the qtree-info object. 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..2^32-1] | integer optional | The maximum number of records to return in this response.
> query |  | qtree-info optional | A query that specifies which qtrees need to be returned. A query could be specified on any number of attributes in the qtree-info object. All qtree objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the previous iteration. It is usually not specified for the first iteration. For subsequent iterations, copy the value from the 'next-tag' obtained from the previous iteration.
> Output Name | Range | Type | Description
> attributes-list |  | qtree-info[] optional | The list of attributes of qtree objects.
> next-tag |  | string optional | Tag for the next iteration. Not present when there are no more qtree objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this response.

> Errno | Description
> EINTERNALERROR |  |

Element definition: qtree-info | [top]

> Information about a single qtree.

> Name | Range | Type | Description
> id | [0..4994] | integer | Id of the qtree (unique within the volume), which is 0 if qtree is the volume itself.
> oplocks |  | string | Indicates whether opportunistic locks are enabled on the qtree. Possible values: "enabled", "disabled".
> qtree |  | string | Name of the qtree, blank if qtree is the volume itself
> security-style |  | string | Security style of the qtree. Possible values are "unix", "ntfs", or "mixed".
> status |  | string | Status of the qtree. Possible values include: "snapvaulted", "snapmirrored", "normal", and "readonly".
> volume |  | string | Name of the volume containing the qtree
> vserver |  | string optional | The vserver in which the volume belongs