|
APIs in Category: qtree |
API version 1.3 |
qtree-create |
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. |
| qtree-create | [top] |
Create a new qtree.
Input Name Range Type Description qtree string
The path of the qtree, relative to the volume. volume string
Name of the volume on which to create the qtree
Errno Description EVOLUMEDOESNOTEXIST EQTREEEXISTS EQTREENOTOWNER EVOLUMEOFFLINE EVOLUMEREADONLY EINVAL
| qtree-list | [top] |
Return list of qtrees
Input Name Range Type Description volume string
optional
Name of the volume to be queried. Do not include a "/vol/" prefix. Output Name Range Type Description qtrees qtree-info[]
An array, one entry per qtree.
Errno Description EVOLUMEDOESNOTEXIST
| qtree-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous qtree-list-iter-start.
| qtree-list-iter-next | [top] |
Continues an iteration through the list of qtrees
Input Name Range Type Description maximum integer
The maximum number of qtrees to retrieve. tag string
Tag from a previous qtree-list-iter-start. Output Name Range Type Description qtrees qtree-info[]
An array, one entry per qtree.
Errno Description EVOLUMEDOESNOTEXIST
| qtree-list-iter-start | [top] |
Starts an iteration through the list of qtrees.
Output Name Range Type Description records integer
Number of items that have been saved for future retrieval with qtree-list-iter-next. tag string
Tag to be used in subsequent iterations.
Errno Description EVOLUMEDOESNOTEXIST
| Element definition: qtree-info | [top] |
Information about a single qtree.
Name Range Type Description id integer
Id of the qtree (unique within the volume), which is 0 if qtree is the volume itself. oplocks boolean
Indicates whether opportunistic locks are enabled on the qtree. qtree string
Name of the qtree, blank if qtree is the volume itself security-style string
Security style of the qtree: unix, ntfs, or mixed volume string
Name of the volume containing the qtree