Input Name	Range	Type	Description
disk-limit		string 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. Default is unlimited.
file-limit		string optional	This is the number of files that the target can have. Set the value to "-" if the limit is to be unlimited. Default is unlimited.
perform-user-mapping		boolean optional	If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is false.
policy		string optional	Name of the quota policy in which the quota rule should be added. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
qtree		string	This is the qtree name that the quota resides on. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
quota-target		string	This is 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. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
quota-type		string	The type of quota rule. Possible values are "user", "group", or "tree".
soft-disk-limit		string 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. Default is unlimited.
soft-file-limit		string 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. Default is unlimited.
threshold		string 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. Default is unlimited.
volume		string	This is the volume name that the quota resides on.

Errno	Description
EQUOTAEXISTS
EQUOTAINVALID
EQUOTADIRECTIVE
EVSERVERNOTFOUND
EVOLUMEDOESNOTEXIST
EQUOTA_POLICY_NOT_FOUND
EINTERNALERROR
EVOLUMEREADONLY
EVOLUMEOFFLINE
EVOL_RESTRICTED

Vfiler-enabled

Yes

Deletes a quota entry specified by type, target, volume, and tree.

Input Name	Range	Type	Description
policy		string optional	Name of the quota policy in which the quota rule should be deleted. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
qtree		string	Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
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. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
quota-type		string	The type of quota rule. Possible values are "user", "group", or "tree".
volume		string	Name of the volume for the quota.

Errno	Description
EQUOTAINVALID
EQUOTADIRECTIVE
EQUOTADOESTEXIST

Vfiler-enabled

Yes

Obtains a quota entry specified by type, target, volume, and tree.

Input Name	Range	Type	Description
policy		string optional	Name of the quota policy from which the quota rule should be obtained. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
qtree		string	Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
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. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
quota-type		string	The type of quota rule. Possible values are "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 optional	If the value is true, quota management will perform user mapping according to /etc/usermap.cfg for unclustered volumes. For clustered volumes, user mapping is performed according to the user mapping configured for the vserver to which the volume belongs.
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.
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
EINTERNALERROR

Vfiler-enabled

Yes

Iterate over the list of quota rules in the cluster.

Input Name	Range	Type	Description
desired-attributes		quota-entry optional	Specify the attributes that should be returned in the quota-entry 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..100]	integer optional	The maximum number of records to return in this response. Default: 100
query		quota-entry optional	A query that specifies which quota rules need to be returned. A query could be specified on any number of attributes in the quota-entry object. All quota entry 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		quota-entry[] optional	The list of attributes of quota entry objects.
next-tag		string optional	Tag for the next iteration. Not present when there are no more quota entry objects to return.
num-records	[0..100]	integer	The number of records returned in this response.

Errno	Description
EINTERNALERROR

Modifys a quota entry. If the type, target, volume, and tree exist, the entry is modified. If the type, target, volume, and tree do not exist, then an error is returned.

Input Name	Range	Type	Description
disk-limit		string 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. Default is the current value.
file-limit		string optional	This is the number of files that the target can have. Set the value to "-" if the limit is to be unlimited. Default is the current value.
perform-user-mapping		boolean optional	If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is the current value.
policy		string optional	Name of the quota policy in which the quota rule should be modified. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
qtree		string	This is the qtree name that the quota resides on. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
quota-target		string	This is 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. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
quota-type		string	The type of quota rule. Possible values are "user", "group", or "tree".
soft-disk-limit		string 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. Default is the current value.
soft-file-limit		string 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. Default is the current value.
threshold		string 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. Default is the current value.
volume		string	This is the volume name that the quota resides on.

Errno	Description
EQUOTADOESNOTEXIST
EQUOTAINVALID
EQUOTADIRECTIVE
EVSERVERNOTFOUND
EVOLUMEDOESNOTEXIST
EQUOTA_POLICY_NOT_FOUND
EINTERNALERROR

Vfiler-enabled

Yes

Turns the quota subsystem off for a volume. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.

Input Name	Range	Type	Description
volume		string	Name of the volume on which to turn quotas off.
Output Name	Range	Type	Description
result-error-code	[0..2^32-1]	integer optional	Error code, if the operation caused an error.
result-error-message		string optional	Error description, if the operation caused an error.
result-jobid	[0..2^64-1]	integer optional	The job id of the job that was queued to turn off quotas.
result-status		string optional	The operation status. Possible values: "succeeded", "in-progress", "failed".

Errno	Description
EVOLUMEBUSY
EVOLUMEDOESNOTEXIST
EAPIERROR
EVOLUMEMOUNTING
EVOL_RESTRICTED
EVOLUMEOFFLINE
EVSERVERNOTFOUND
EONTAPI_EINVAL
EAGGRDOESNOTEXIST
EAGGRNOTONLINE
EAGGRFAILINGOVER
EAGGRMISMATCH

Vfiler-enabled

Yes

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. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.

Input Name	Range	Type	Description
volume		string	Name of the volume on which to enable quotas.
Output Name	Range	Type	Description
result-error-code	[0..2^32-1]	integer optional	error code, if the operation caused an error.
result-error-message		string optional	error description, if the operation caused an error.
result-jobid	[0..2^64-1]	integer optional	The job id of the job that was queued to turn on quotas.
result-status		string optional	The operation status. Possible values: "succeeded", "in-progress", "failed".

Errno	Description
EVOLUMEBUSY
EVOLUMEDOESNOTEXIST
EVOLUMEMOUNTING
EVOL_RESTRICTED
EVOLUMEOFFLINE
EAPIERROR
EVSERVERNOTFOUND
EONTAPI_EINVAL
EAGGRDOESNOTEXIST
EAGGRNOTONLINE
EAGGRFAILINGOVER
EAGGRMISMATCH
EQUOTAS_NO_VALID_RULES

Vfiler-enabled

Yes

Iterate over the quota report in the cluster.

Input Name	Range	Type	Description
desired-attributes		quota optional	Specify the attributes that should be returned in the quota report 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..100]	integer optional	The maximum number of records to return in this response. Default: 100
path		string optional	A path (including a /vol/ prefix). If specified, the report will contain only quotas that apply to the specified path name.
query		quota optional	A query that specifies which quota report needs to be returned. A query could be specified on any number of attributes in the quota report object. All quota report 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		quota[] optional	The list of attributes of quota report objects.
next-tag		string optional	Tag for the next iteration. Not present when there are no more quota report objects to return.
num-records	[0..100]	integer	The number of records returned in this response.

Errno	Description
EINTERNALERROR

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. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.

Input Name	Range	Type	Description
volume		string	Name of the volume on which to resize quotas.
Output Name	Range	Type	Description
result-error-code	[0..2^32-1]	integer optional	Error code, if the operation caused an error.
result-error-message		string optional	Error description, if the operation caused an error.
result-jobid	[0..2^64-1]	integer optional	The job id of the job that was queued to resize quotas.
result-status		string optional	The operation status. Possible values: "succeeded", "in-progress", "failed".

Errno	Description
EVOLUMEBUSY
EVOLUMEDOESNOTEXIST
EVOLUMEMOUNTING
EVOL_RESTRICTED
EVOLUMEOFFLINE
EAPIERROR
EVSERVERNOTFOUND
EONTAPI_EINVAL
EAGGRDOESNOTEXIST
EAGGRNOTONLINE
EAGGRFAILINGOVER
EAGGRMISMATCH
EQUOTAS_NO_VALID_RULES

Vfiler-enabled

Yes

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.
perform-user-mapping		boolean optional	If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is false.
policy		string optional	Name of the quota policy in which the quota rule should be set. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
qtree		string	Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
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. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
quota-type		string	The type of quota rule. Possible values are "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
EVSERVERNOTFOUND
EVOLUMEDOESNOTEXIST
EQUOTA_POLICY_NOT_FOUND
EINTERNALERROR
EVOLUMEREADONLY
EVOLUMEOFFLINE
EVOL_RESTRICTED

Vfiler-enabled

Yes

Obtains the status of 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".
quota-errors		string optional	Collection of quota errors including the value of the reason tag above. Each error will be separated by a newline, '\n'. Since the quota parser does not stop when a parsing error occurs, this tag returns all the errors from the quota parser. If not present, there are no errors.
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", "transferring rules", "finishing", "corrupt", and "none".

Errno	Description
EVOLUMEDOESNOTEXIST
EVOLUMEBUSY
EVOLUMEOFFLINE
EVOLUMEOFFLINE
EAPIERROR
EVSERVERNOTFOUND
EONTAPI_EINVAL
EAGGRDOESNOTEXIST
EAGGRNOTONLINE
EAGGRFAILINGOVER
EAGGRMISMATCH

Vfiler-enabled

Yes

Iterate over quota status for all volumes in the cluster

Input Name	Range	Type	Description
desired-attributes		quota-status-attributes optional	Specify the attributes that should be returned in the quota status 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..100]	integer optional	The maximum number of records to return in this response. Default: 100
query		quota-status-attributes optional	A query that specifies which quota status attributes need to be returned. A query could be specified on any number of attributes in the quota status object. All quota status 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		quota-status-attributes[] optional	The list of attributes of quota status objects.
next-tag		string optional	Tag for the next iteration. Not present when there are no more quota status objects to return.
num-records	[0..100]	integer	The number of records returned in this response.

Errno	Description
EINTERNALERROR

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 is a fully qualified quota target which is the quota target specified in the /etc/quotas file and the domain in the QUOTA_TARGET_DOMAIN directive is in effect. See na_quotas(5) for more information. Mulitple targets are comma separated. 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 and group.
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.
volume		string	Name of the volume to which the quota is applied.
vserver		string optional	The vserver name in which the volume belongs, for which the quota is applicable

Information about a single quota rule.

Name	Range	Type	Description
disk-limit		string optional	Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is "-" if the limit is unlimited.
file-limit		string optional	Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited.
perform-user-mapping		boolean optional	If the value is true, user mapping will be performed for this rule.
policy		string optional	The quota policy to which the rule belongs.
qtree		string optional	Name of the qtree for the quota. It can be the qtree name or "" if no qtree. If there is an error in the quota entry, this value might not present. For tree rules, this field will be "".
quota-error		quota-error optional	This value is only present if there is an error, and gives complete details for an error for a specific quota entry.
quota-target		string optional	The quota target of the type specified. The value will be one of: <name>, <number>, or <path name>. Mulitple targets can be specified by a comma-separated list. Quota directives in /etc/quotas are used to form the quota target. If there is an error in the quota entry, this value might not present. For explicit tree rules, this field will indicate the qtree name in the format "/vol/< volume name >/ < qtree name >".
quota-type		string optional	The type of quota rule. Possible values are "user", "group", or "tree". If there is an error in the quota entry, this value might not present.
soft-disk-limit		string optional	Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
soft-file-limit		string optional	Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited.
threshold		string optional	Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
volume		string optional	Name of the volume for the quota. If there is an error in the quota entry, this value might not present.
vserver		string optional	The vserver name.

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.

Attributes of quota status

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".
quota-error-msgs		quota-error-msg[] optional	Collection of quota errors including the value of the reason tag above. Since the quota parser does not stop when a parsing error occurs, this tag returns all the errors from the quota parser. If not present, there are no errors.
reason		quota-error-msg 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" and "initializing".
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", "transferring_rules", "finishing", "corrupt", and "none".
volume		string	Name of the volume to which the quota is applied.
vserver		string	The vserver name in which the volume belongs, for which the quota is applicable

Information about the single quota error.

[none]

Information about a quota user or group.

Name	Range	Type	Description
quota-user-id		string	The id of the user. The quota-user-type determines the format. For uid and gid, the format is an integer. For sid, the format is the usual "S-*" style.
quota-user-name		string	Name of the user, group, or sid.
quota-user-type		string	The type of quota user. There are two possible values: sid (for Windows users), uid (for UNIX users), and gid (for UNIX groups).