|
APIs in Category: quota |
API version 1.0 |
quota-delete-entry |
| quota-delete-entry | [top] |
Deletes a quota entry specified by type, target, volume, and tree.
Input Name Range Type Description quota-target string
This is the quota target of the type specified. The target can be of the form: name, number, or path name. quota-type string
This is the quota type: user, group, tree, or default. tree string
This is the qtree name that the quota resides on. It can be the qtree name or "" if no qtree. volume string
This is the volume name that the quota resides on.
Errno Description EAPIINVALIDQUOTA
| quota-get-entry | [top] |
Obtains a quota entry specified by type, target, volume, and tree.
Input Name Range Type Description quota-target string
This is the quota target of the type specified. The target can be of the form: name, number, or path name. quota-type string
This is the quota type: user, group, tree, or default. tree string
This is the qtree name that the quota resides on. It can be the qtree name or "" if no qtree. volume string
This is the volume name that the quota resides on. Output Name Range Type Description disk-limit integer
This is 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 integer
This is 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. soft-disk-limit integer
This is 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 integer
This is 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 integer
This is 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 EAPIINVALIDQUOTA EQUOTAPARSEERROR
| quota-op-off | [top] |
Turns the quota subsystem off for a volume.
Input Name Range Type Description volume string
The volume where the quota resides.
| quota-op-on | [top] |
Turns the quota subsystem on for a volume.
Input Name Range Type Description volume string
The volume where the quota resides.
| quota-op-resize | [top] |
Informs ONTAP to resize the quota subsystem for a volume.
Input Name Range Type Description volume string
The volume where the quota resides.
| quota-op-status | [top] |
Obtains the status on quotas
Input Name Range Type Description volume string
The volume where the quota resides. Output Name Range Type Description percent-complete integer
optional
The percentage complete on an "on" or "resize" operation. This is valid in the "resizing" and "initializing" substatus. quota-error-msg string
optional
The last quota error message. If not present, there are no errors. quota-status string
The major quota status. The values are "on", "off", "resizing", "initializing", and "shuting down". quota-substatus string
The minor quota status. quota-substatus is only valid for the states "resizing", and "initializing". The valid values are: "scanning", "etc scanning", "setup", "queue scan", "done", and "none".
| 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. volume string
optional
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. quotas quota[]
An array of 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 integer
optional
This is 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 integer
optional
This is the number of files that the target can have. Set the value to "-" if the limit is to be unlimited. perform-user-mapping boolean
optional
If the value is true, quota management will perform user mapping according to /etc/usermap.cfg. quota-target string
This is the quota target of the type specified. The target can be of the form: name, number, or path name. quota-type string
This is the quota type: user, group, tree, or default. soft-disk-limit integer
optional
This is 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 integer
optional
This is 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 integer
optional
This is 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. tree string
This is the qtree name that the quota resides on. It can be the qtree name or "" if no qtree. volume string
This is the volume name that the quota resides on.
| Element definition: error-info | [top] |
This type contains information about a single error.
Name Range Type Description errno integer
This is an error number. reason string
This is a readable error message. status string
This is either 'passed' or 'failed'.
| Element definition: quota | [top] |
This type contains information about a single quota.
Name Range Type Description disk-limit integer
maximum amount of disk space allowed for the quota target in kilobytes (hard disk space limit) disk-used integer
current amount of disk space used by the quota target in kilobytes file-limit integer
maximum no. of files allowed for the quota target (hard files limit) files-used integer
current no. of files used by the quota target quota-type string
quota type, which can be user, group, or tree quota_users quota-user[]
A list of quota users. soft-disk-limit integer
soft disk space limit for the quota target in kilobytes soft-file-limit integer
soft file limit for the quota target threshold integer
disk space threshold for the quota target in kilobytes tree string
qtree to which the quota is applied vfiler string
optional
vfiler name volume string
volume to which the quota is applied
| Element definition: quota-user | [top] |
Contains information about the quota user
Name Range Type Description quota-target string
for an explicit quota, it shows how the quota target is specified in the /etc/quotas file. For a derived quota, the field is blank. quota-user-id string
This is the id of the user. The quota-user-type determines the format. quota-user-name string
This is the name of the user. quota-user-type string
This is the type of quota user. There are currently two possible values: sid, for Windows users, and uid for UNIX users.