|
APIs in Category: quota |
API version 1.1 |
| quota-delete-entry | [top] |
Deletes a quota entry specified by type, target, volume, and tree.
Input Name Range Type Description qtree string
Name of the qtree for the quota. It can be the qtree name or "" if no qtree. quota-target string
The quota target of the type specified. Possible values are: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. quota-type string
Quota type: "user", "group", or "tree". volume string
Name of the volume for the quota.
Errno Description EQUOTAINVALID EQUOTADIRECTIVE
| quota-get-entry | [top] |
Obtains a quota entry specified by type, target, volume, and tree.
Input Name Range Type Description qtree string
Name of the qtree for the quota. It can be the qtree name or "" if no qtree. quota-target string
The quota target of the type specified. Possible values are: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. quota-type string
The quota type: "user", "group", or "tree". volume string
Name of the volume for the quota. Output Name Range Type Description disk-limit string
The amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited. file-limit string
The number of files that the target can have. The value is "-" if the limit is unlimited. perform-user-mapping boolean
If the value is true, quota management will perform user mapping according to /etc/usermap.cfg. quota-error quota-error
This value is only present if there is an error, and gives complete details on the error in a specific quota entry. soft-disk-limit string
The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited. soft-file-limit string
The number of files the target would have to exceed before a message is logged and an SNMP trap is generated. The value is "-" if the limit is unlimited. threshold string
The amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited.
Errno Description EQUOTAPARSEERROR EQUOTAINVALID EQUOTADOESNOTEXIST EQUOTADIRECTIVE
| quota-list-entries | [top] |
Returns quota entries from the /etc/quotas file.
Input Name Range Type Description include-output-entry boolean
optional
If specified and true, the raw quota entry is placed in the output element. Output Name Range Type Description quota-entries quota-entry[]
An array of quota entries.
| quota-list-entries-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous quota-list-entries-iter-start.
| quota-list-entries-iter-next | [top] |
Continues an iteration through the list of quotas.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous quota-list-entries-iter-start. Output Name Range Type Description quota-entries quota-entry[]
optional
An array of quota information. records integer
This tells you how many records are being returned from this particular call to quota-list-entries-iter-next. When this value is 0, you have retrieved everything.
| quota-list-entries-iter-start | [top] |
Starts an iteration through the list of quotas entries in /etc/quotas.
Input Name Range Type Description include-output-entry boolean
optional
If specified and true, the entire quota entry is placed in the ouput elements. Output Name Range Type Description records integer
This tells you the number of items that have been saved for future retrieval with quota-list-entries-iter-next. tag string
Tag to be used in subsequent iterations.
| quota-off | [top] |
Turns the quota subsystem off for a volume.
Input Name Range Type Description volume string
Name of the volume on which to turn quotas off.
| quota-on | [top] |
Starts to turn quotas on for a volume. A successful return from this API does not mean that quotas are on, merely that an attempt to start it has been triggered. Use the quota-status API to check the status.
Input Name Range Type Description volume string
Name of the volume on which to enable quotas.
| quota-report | [top] |
Returns a report on all quotas.
Input Name Range Type Description path string
optional
If specified, the report will contain only quotas that apply to the specified path name. The path should start with "/vol/ ". volume string
optional
If provided, the report will contain only quotas on the specified volume name. The name should not contain a "/vol/" prefix. Output Name Range Type Description error error-info
optional
If an error occurs in the midst of a report, this element is included in the output to indicate it (because it's too late at that point to include it in the main of the API. This structure includes the same information (status, reason, errno) that is normally included as attributes on the of the API itself. quotas quota[]
An array of quotas.
| quota-report-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous quota-report-iter-start.
| quota-report-iter-next | [top] |
Returns items from a previous call to quota-report-iter-start
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous quota-report-iter-start. Output Name Range Type Description quotas quota-info[]
optional
An array of quotas. records integer
This tells you how many records are being returned from this particular call to quota-report-iter-next. When this value is 0, you have retrieved everything.
| quota-report-iter-start | [top] |
Generates a report on quotas, the results of which are retrieved by using quota-report-iter-next.
Input Name Range Type Description path string
optional
A path (including a /vol/ prefix). If specified, the report will contain only quotas that apply to the specified path name. volume string
optional
Name of a volume. If specified, the report will contain only quotas on the specified volume. Output Name Range Type Description error error-info
optional
If an error occurs in the midst of a report, this element is included to indicate it. It includes the same information that is normally included as attributes on the element. records integer
Number which tells you how many items have been saved for future retrieval with quota-report-iter-next. tag string
Tag to be used in subsequent calls to quota-report-next-start.
| quota-resize | [top] |
Starts an ONTAP operation to resize quotas for a volume. A successful return from this API does not mean that the operation has finished, merely that an attempt to start it been triggered. Use the quota-status API to check the status.
Input Name Range Type Description volume string
Name of the volume on which to resize quotas.
| quota-set-entry | [top] |
Sets a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then the entry is modified.
Input Name Range Type Description disk-limit string
optional
The amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. file-limit string
optional
The number of files that the target can have. Set the value to "-" if the limit is to be unlimited. qtree string
Name of the qtree for the quota. It can be the qtree name or "" if no qtree. quota-target string
The quota target of the type specified. Possible values are <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. quota-type string
The quota type: "user", "group", or "tree". soft-disk-limit string
optional
The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. soft-file-limit string
optional
The number of files the target would have to exceed before a message is logged and an SNMP trap is generated. Set the value to "-" if the limit is to be unlimited. threshold string
optional
The amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. volume string
Name of the volume for the quota.
Errno Description EQUOTAINVALID EQUOTADIRECTIVE
| quota-status | [top] |
Obtains the status on quotas
Input Name Range Type Description volume string
Name of the volume whose quota status should be obtained. Output Name Range Type Description percent-complete integer
optional
The percentage complete for an "on" or "resize" operation. This is present when the status is "resizing" or "initializing". reason string
optional
The last quota error message. If not present, there are no errors. status string
Primary status of quotas on the indicated volume; Possible values: "on", "off", "resizing", "initializing", and "shutting down". substatus string
Minor quota status on the indicated volume. This status is only valid when primary status is "resizing" or "initializing". Possible values are: "scanning", "etc scanning", "setup", "queue scan", "done", and "none".
| Element definition: error-info | [top] |
Information about a single error.
Name Range Type Description errno integer
The error number. reason string
A human-readable error message. status string
Either 'passed' or 'failed'.
| Element definition: quota | [top] |
Information about a single quota.
Name Range Type Description disk-limit string
Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is "-" if the limit is unlimited. disk-used string
Current amount of disk space, in kilobytes, used by the quota target. The value is "-" if the limit is unlimited. file-limit string
Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited. files-used string
Current number of files used by the quota target. The value is "-" if the limit is unlimited. quota-target string
For an explicit quota, this value indicates how the quota target is specified in the /etc/quotas file. For a derived quota, the field is blank. quota-type string
The type of quota: user, group, or tree. quota-users quota-user[]
A list of quota users. soft-disk-limit string
Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited. soft-file-limit string
Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited. threshold string
Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited. tree string
Name of the qtree to which the quota is applied. vfiler string
optional
Name of the vfiler to which the quota applies, if vfilers are in use. volume string
Name of the volume to which the quota is applied.
| Element definition: quota-entry | [top] |
Information about a single quota.
Name Range Type Description line string
optional
The line that is being parsed. This is only returned when the input element is set to true. qtree string
optional
Name of the qtree name for the quota. It can be the qtree name or "" if no qtree. If there is an error in the quota entry, this value is not present. quota-error quota-error
optional
This value is only present if there is an error, and gives complete details on the error in a specific quota entry. quota-target string
optional
The quota target of the type specified. The target can be of the form: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. If there is an error in the quota entry, this value is not present. quota-type string
optional
Quota type: "user", "group", or "tree". If there is an error in the quota entry, this value is not present. volume string
optional
Name of the volume for the the quota. If there is an error in the quota entry, this value is not present.
| Element definition: quota-error | [top] |
Information about a single quota error.
Name Range Type Description detail string
More details about the error. errno integer
The error number. reason string
A human-readable concise reason for the error.
| Element definition: quota-info | [top] |
Information about a single quota.
Name Range Type Description disk-limit string
Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is "-" if the limit is unlimited. disk-used string
Current amount of disk space, in kilobytes, used by the quota target. The value is "-" if the limit is unlimited. file-limit string
Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited. files-used string
Current number of files used by the quota target. The value is "-" if the limit is unlimited. qtree string
Name of qtree to which the quota is applied. quota-target string
For an explicit quota, this value indicates how the quota target is specified in the /etc/quotas file. For a derived quota, the field is blank. quota-type string
Quota type, which can be user, group, or tree quota-users quota-user[]
A list of quota users. soft-disk-limit string
Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited. soft-file-limit string
Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited. threshold string
Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited. vfiler string
optional
Name of the vfiler to which the quota applies. volume string
Name of volume to which the quota is applied.
| Element definition: quota-user | [top] |
Information about a quota user.
Name Range Type Description quota-user-id string
The id of the user. The quota-user-type determines the format, which is either a Windows SID string or uid number. quota-user-name string
Name of the user. quota-user-type string
The type of quota user. Possible values are: sid (for Windows users), and uid (for UNIX users).