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

Errno	Description
EINTERNALERROR

Copy a volume A job will be spawned to operate on the volume and the job id will be returned. The progress of the job can be tracked using the job APIs.

Input Name	Range	Type	Description
destination-aggregate		string	Specify the name of aggregate where the source-volume should be copied.
destination-volume		string	Specify the name of volume on destination aggregate where the source-volume should be copied.
source-volume		string	Specifies the name of the volume to be copied.
vserver		string	The name of the Vserver which owns the volume.
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	Job Id, if this operation was performed via a job.
result-status		string	The operation status. Possible values: "succeeded", "in_progress", "failed".

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR
EVOLUME_TYPE_NOT_SUPPORTED
EOP_DISALLOWED_ON_LOADSHARING_VOL
EOP_DISALLOWED_ON_7MODE_VOL
ESTRIPEDVOL_PRIVILEGELEVEL
EVOLUME_DEST_STRIPED_VOL_NAME_NOT_ALLOWED
EAGGRDOESNOTEXIST
EVOLUME_FLEX_TO_STRIPED_NOT_ALLOWED
EAGGRNOTONLINE
EOPNOTSUPPORTED

Iterate over a list of volume objects.

Input Name	Range	Type	Description
desired-attributes		volume-attributes optional	Specify the attributes that should be returned. 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 call. Default: 20
query		volume-attributes optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the volume object. All volume objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		volume-attributes[] optional	The list of attributes of volume objects.
next-tag		string optional	Tag for the next call. Not present when there are no more volume objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify the attributes of volume or a group of volume objects.

Input Name	Range	Type	Description
attributes		volume-attributes	Specify at least one modifiable element. Do not specify any other element.
continue-on-failure		boolean optional	This input element is useful when multiple volume objects match a given query. If set to true, the API will continue modifying the next matching volume even when modification of a previous volume fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching volume even when the modification of a previous matching volume fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of objects to be modified in this call. Default: 20
query		volume-attributes	If modifying a specific volume, this input element must specify all keys. If modifying volume objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of volume objects (just keys) that were not modified due to some error. If set to false, the list of volume objects not modified will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of volume objects (just keys) that were successfully updated. If set to false, the list of volume objects modified will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
failure-list		volume-modify-iter-info[] optional	Information about volume objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching volume objects to be modified.
num-failed	[0..100]	integer optional	Number of volume objects that matched the query, but were not modified due to some error.
num-succeeded	[0..100]	integer optional	The number of volume objects that matched the query and were successfully updated.
success-list		volume-modify-iter-info[] optional	The volume objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

License

Striped_Volume

This API is applicable to Data ONTAP 7-Mode as well as Data ONTAP Cluster-Mode. If the API is sent to a Data ONTAP 7-Mode controller, Vol Move will move a single 7-mode flexvol between two aggregates on the same controller. If the API is sent to the Admin Vserver LIF, the flexvol can be moved to any eligible aggregate in the cluster. The list of eligible aggregates can be obtained using the "volume-move-target-aggr-get-iter" API. This API will start the move. It will run a series of checks to determine if the volume can be moved. If any of the checks results in an error or warning, the API will return with an error. The user has to take the necessary corrective action before restarting the move. If all the checks pass, the API will return a success. If "perform-validation-only" is not true, the destination volume will be created and the move will start. By default, the move will cutover automatically. If "perform-validation-only" is set to true, all the errors and warnings encountered from the checks will be returned in the errors-warnings output element. The API will return successfully. The move will not be initiated. When the API is sent to a Data ONTAP 7-Mode controller, if "is-override-warnings" is set to true and the checks return no errors but one or more warnings, the API will return successfully. The warnings will be in the errors-warnings output element. If the API is sent to a Data ONTAP 7-Mode controller, the status of the move can be obtained using the "volume-move-status" API. If the move fails an EMS message will be generated. The reason for the failure can be obtained from the volume-move-status API. After a successful move, the source volume will be destroyed unless the user has specified the "is-keep-source" option. If cutover cannot be completed in the default or user specified number of attempts, an EMS message will be printed and the move will pause. The reason for the pause will be available in the "volume-move-status" API. The user can either resume or abort the move. This is an asynchronous API. If the API is sent to the Admin Vserver LIF, a background job will be created and the API returns immediately with the job ID information. The status of the move job can be obtained by using "job-get" or "job-get-iter" API.

Input Name	Range	Type	Description
cutover-action		string optional	Specifies the action to be taken for cutover. Possible values are "abort_on_failure", "defer_on_failure", "force" and "wait". Default is "defer_on_failure". If "abort_on_failure" action is specified, the job will try cutover till the cutover-attempts are exhausted, and cleanup if it fails to cutover. If "defer_on_failure" action is specified, the job will try cutover till the cutover-attempts are exhausted and move into "cutover deferred" state if it fails to cutover. This is the default option. The volume move job waits for intervention to restart the cutover process again. If "force" action is specified, the job will try cutover till the cutover-attempts are exhausted and force the cutover at the expense of disrupting the clients. If "wait" action is specified, when the job hits the decision point, it will not go into cutover automatically, instead it will wait for the user to issue a "volume-move-trigger-cutover" command as the signal to try the cutover.
cutover-attempts	[1..25]	integer optional	Number of cutover attempts. Default value is 3
cutover-window	[30..300]	integer optional	Time interval to complete cutover in seconds. Default value for Data ONTAP Cluster-Mode volume move is 45 seconds. Default value for Data ONTAP 7-mode volume move is 60 seconds.
dest-aggr		string	Name of the destination aggregate
perform-validation-only		boolean optional	Run pre-checks for the move, return all the errors and warning messages encountered during the checks in the errors-warnings element and exit. The move will not be triggered. Default is false.
source-volume		string	Name of the volume that must be moved
vserver		string optional	Name of the Vserver in which the volume to be moved resides. This value is required for C-Mode volumes.
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	Job Id, if this operation was performed via a job.
result-status		string optional	The operation status. Possible values: "succeeded", "in_progress", "failed".

Errno	Description
EINVALIDINPUTERROR
EVOLUMEDOESNOTEXIST
EVOLUMENAMEINVALID
EVOLUMENOTONLINE
EAGGRDOESNOTEXIST
EAGGRNOTONLINE
EALREADYSTARTED
EAPIMISSINGARGUMENT
EINVALIDINPUTERROR
EINVALIDSTATE
ENOTSTARTED
EONTAPI_EALREADY
EVFILEROPNOTALLOWED
EVOLAGGRISIRONING
EVOLUME_TYPE_NOT_SUPPORTED
EVOL_CIFS_ENABLED
EVOL_ONLINE_ERROR
EVOLUME_ADMINOP_NOT_FENCED
EVOL_NFS_ENABLED
EOP_DISALLOWED_ON_BUSY_MIRROR
EOP_DISALLOWED_ON_LOADSHARING_VOL
EOP_DISALLOWED_ON_CLONE_PARENT
EOP_DISALLOWED_ON_BACKUP_ACTIVE_VOL
EOP_DISALLOWED_ON_STRIPED_VOL
EOP_DISALLOWED_ON_COMPRESSED_VOL
EOP_DISALLOWED_ON_7MODE_VOL
EOP_DISALLOWED_ON_STRIPED_AGGR
EOP_DISALLOWED_ON_VOL_ALREADY_ON_AGGR
EOP_DISALLOWED_ON_ROOT_AGGR
ESNAPMIRROR_NOT_INITIALIZED
EONTAPI_ENOSPCAGGR
ENDMPRUNNING
EVOLISGRIDIRONING
EVOLMOVE_NDMP_DUMPS_RUNNING
EVOLMOVE_NDMP_RESTORE_RUNNING
EVOLMOVE_SIS_UNDO_RUNNING
E_VOL_MOVE_INCOMPATIBLE_VERSION
E_VOL_MOVE_DC_NOT_ALLOWED
ENODENOTFOUND
E_OP_DISALLOWED_ON_AGGR_NOT_IN_VSERVER_LIST
E_OP_UNSUPPORTED_NO_SPACE_ON_DESTINATION_AGGR
EVOLUME_RELSTATUS_UNKNOWN
EINTERNALERROR
ESNAPMIRRORNOTSUPPORT
ESNAPMIRRORVOLNOTFOUND
ESNAPMIRRORINVALIDINPUT
ESNAPMIRRORINVALIDUUID
EAPIMISSINGARGUMENT
ENOMEM

Scans aggregates and returns a list of compatible target aggregates for the given volume move operation.

Input Name	Range	Type	Description
desired-attributes		volume-move-target-aggr-info optional	Specify the attributes that should be returned. 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 call. Default: 50
query		volume-move-target-aggr-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the volume object. All volume objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
volume-name		string	Volume Name
vserver		string	Vserver Name
Output Name	Range	Type	Description
attributes-list		volume-move-target-aggr-info[] optional	The list of attributes of volume objects.
next-tag		string optional	Tag for the next call. Not present when there are no more volume objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR
EOP_DISALLOWED_ON_7MODE_VOL

Trigger cutover of a move job

Input Name	Range	Type	Description
force		boolean optional	Force cutover
source-volume		string	The name of the volume.
vserver		string optional	Name of the Vserver in which the volume to be moved resides. This value is required for C-Mode volumes.

Errno	Description
EOBJECTNOTFOUND
EJOBNOTINCUTOVERDEFERRED

Transition a volume between 7-Mode and Cluster-Mode. Currently the only supported operation type is transitioning a 7-Mode Flexible Volume that has been copied from a 7-Mode Filer for the purpose of transitioning it to a Cluster-Mode Flexible Volume. A job-id will be returned that can be used to query to progress of the transition job.

Input Name	Range	Type	Description
destination-vserver-name		string optional	The name of the vserver into which a volume is being transitioned.
non-disruptive		boolean optional	A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
operation-type		string optional	The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
override-warnings		boolean optional	A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
source-node		string	The name of the node where the target volumes reside.
volumes		volume-transition-volinfo[]	Volumes to attempt to transition.
Output Name	Range	Type	Description
job-id		integer	Job id which can be used to query the status of the process.

Errno	Description
EINTERNALERROR
EINVALIDINPUTERROR
EVSERVERNOTFOUND
EVOLUMENOTONLINE
EALREADYSTARTED
EVOL_TOO_MANY
EONTAPI_ENOSPC
EONTAPI_ESYSTEMERR
EONTAPI_EAGAIN
EONTAPI_EALREADY
EONTAPI_EEXIST
EONTAPI_EINPROGESS
EMULTIPLEVOLSFOUND
EVOLTRANSERROR

Check to see if a desired volume transition can be performed from one volume type to another. Only 7-mode flexible volume to cluster-mode flexible volume and vice versa with limited options are supported at this time.

Input Name	Range	Type	Description
destination-vserver-name		string optional	The name of the vserver into which a volume is being transitioned.
non-disruptive		boolean optional	A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
operation-type		string optional	The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
override-warnings		boolean optional	A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
source-node		string	The name of the node where the target volumes reside.
volumes		volume-transition-volinfo[]	Volumes to check for the ability to transition to Cluster-Mode.

Errno	Description
EINTERNALERROR
EINVALIDINPUTERROR
EVSERVERNOTFOUND
EVOLUMENOTONLINE
EVOL_TOO_MANY
EONTAPI_ENOSPC
EONTAPI_ESYSTEMERR
EMULTIPLEVOLSFOUND
EVOLTRANSERROR
EVOLTRANWARNING

Transition a volume from one type to another. Delete the logged information about a transition operation.

Input Name	Range	Type	Description
destination-vserver-name		string optional	The name of the containing vserver for the volume, if applicable.
operation-type		string optional	The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
source-node		string optional	Node owning the 7-mode volumes being transitioned
volume-name		string	Volumes to delete the transition log from.

Errno	Description
EINTERNALERROR
EINVALIDINPUTERROR
EVOLUMENOTONLINE
EALREADYSTARTED
EONTAPI_ESYSTEMERR
EONTAPI_EAGAIN
EONTAPI_EALREADY
EONTAPI_EINPROGESS
EMULTIPLEVOLSFOUND
EVOLTRANSERROR

Retrieve the logged information about a transition operation.

Input Name	Range	Type	Description
desired-features		string[] optional	The list of the specific features whose log records are desired by the caller. The caller can either specify a list of features or "all" to include all phases. If this argument is not provided, then it is equivalent to setting 'desired-features' to 'all'.
desired-levels		string[] optional	The list of the specific level log records which are desired by the caller. The caller can either specify a list of levels or "all" to include all levels. Possible values: all error warning info debug trace If this argument is not provided, then it is equivalent to setting 'desired-levels' to 'all'.
desired-phases		string[] optional	The list of the specific phases whose log records are desired by the caller. To receive all phases, "all" can be specified. Possible values: all check lock_config prepare pre_commit commit post_commit online rollback cleanup unlock_config complete If this argument is not provided, the default is 'all'.
destination-vserver-name		string optional	The name of the containing vserver for the volume, if applicable.
maximum-records	[1..100]	integer optional	The maximum number of records to return
operation-type		string optional	The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
source-node		string optional	Node owning the 7-Mode volumes being transitioned.
tag		string optional	Value to use to get next entry.
volume-name		string	Volume to obtain transition log information from.
Output Name	Range	Type	Description
eof		boolean	True if there are no more entries to read.
next-tag		string	Value to use to get next entry.
num-records	[1..100]	integer	Number of records being returned.
records		volume-transition-log-record-info[] optional	Actual records from the log.

Errno	Description
EINTERNALERROR
EINVALIDINPUTERROR
EVOLUMENOTONLINE
EONTAPI_ESYSTEMERR
EONTAPI_EAGAIN
EONTAPI_EALREADY
EONTAPI_EINPROGESS
EMULTIPLEVOLSFOUND
EVOLTRANSERROR

Attributes of a volume. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
volume-64bit-upgrade-attributes		volume-64bit-upgrade-attributes optional	Information related to 64-bit upgrade. After 64-bit upgrade completes, this information is no longer available.
volume-antivirus-attributes		volume-antivirus-attributes optional	This field contains information about Anti-Virus On-Access settings for the volume.
volume-autosize-attributes		volume-autosize-attributes optional	This field contains information about the autosize settings of the volume.
volume-clone-attributes		volume-clone-attributes optional	This field contains information applying exclusively to clone volumes.
volume-directory-attributes		volume-directory-attributes optional	This field contains information related to directories in a volume.
volume-export-attributes		volume-export-attributes optional	This field contains information about export settings of the volume.
volume-flexcache-attributes		volume-flexcache-attributes optional	This field contains information applying exclusively to flexcache volumes.
volume-id-attributes		volume-id-attributes optional	This field contains identification information about the volume.
volume-inode-attributes		volume-inode-attributes optional	This field contains information about inodes in a volume.
volume-language-attributes		volume-language-attributes optional	This field contains information about volume language-related settings.
volume-mirror-attributes		volume-mirror-attributes optional	This field contains information applying exclusive to volume mirror.
volume-performance-attributes		volume-performance-attributes optional	This field contains information that relates to the performance of the volume.
volume-security-attributes		volume-security-attributes optional	This field contains information about volume security settings.
volume-sis-attributes		volume-sis-attributes optional	This field contains information about Deduplication, file clone, compression, etc.
volume-snapshot-attributes		volume-snapshot-attributes optional	This field contains information applying exclusively to all the snapshots in the volume. Volume disk space-related settings are excluded.
volume-snapshot-autodelete-attributes		volume-snapshot-autodelete-attributes optional	This field contains information about snapshot autodelete policy settings.
volume-space-attributes		volume-space-attributes optional	This field contains information related to volume disk space management including on-disk layout.
volume-state-attributes		volume-state-attributes optional	This field contains information about the state or status of a volume or its features.
volume-striping-attributes		volume-striping-attributes optional	This field contains information applying exclusively to striped volumes.

Volume FlexClone typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
aggregate		string optional	FlexClone Aggregate Attributes: non-creatable, non-modifiable
blocks-scanned	[0..2^64-1]	integer optional	Blocks Scanned Attributes: non-creatable, non-modifiable
blocks-updated	[0..2^64-1]	integer optional	Blocks Updated Attributes: non-creatable, non-modifiable
dsid	[0..2^64-1]	integer optional	FlexClone Data Set ID Attributes: non-creatable, non-modifiable
inode-percentage-complete	[0..2^64-1]	integer optional	Percentage Complete Attributes: non-creatable, non-modifiable
inodes-processed	[0..2^64-1]	integer optional	Inodes Processed Attributes: non-creatable, non-modifiable
inodes-total	[0..2^64-1]	integer optional	Total Inodes Attributes: non-creatable, non-modifiable
junction-active		boolean optional	Junction Active Attributes: optional-for-create, non-modifiable
junction-path		string optional	Junction Path Attributes: optional-for-create, non-modifiable
msid	[0..2^64-1]	integer optional	FlexClone Master Data Set ID Attributes: non-creatable, non-modifiable
parent-snapshot		string optional	FlexClone Parent Snapshot Attributes: optional-for-create, non-modifiable
parent-volume		string optional	FlexClone Parent Volume Attributes: required-for-create, non-modifiable
size	[0..2^63-1]	integer optional	FlexClone Size Attributes: non-creatable, non-modifiable
space-guarantee-enabled		boolean optional	Space Guarantee In Effect Attributes: non-creatable, non-modifiable
space-reserve		string optional	Space Guarantee Style Attributes: optional-for-create, non-modifiable Possible values: "none" , "volume" , "file"
split-estimate		integer optional	Split Estimate Attributes: non-creatable, non-modifiable
state		string optional	FlexClone Volume State Possible values are: 'online', 'offline', 'restricted'. Attributes: non-creatable, non-modifiable
used	[0..2^63-1]	integer optional	Used Size Attributes: non-creatable, non-modifiable
volume		string optional	FlexClone Volume Attributes: key, required-for-create, non-modifiable
vserver		string optional	Vserver Name Attributes: key, non-creatable, non-modifiable

Information about the modify operation that was attempted/performed against volume object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the modify operation caused an error.
error-message		string optional	Error description, if the modify operation caused an error.
volume-key		volume-attributes	The keys for the volume object to which the modify operation applies.

Compatible target aggregate information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
aggr-name		aggr-name optional	Aggregate Name Attributes: key, non-creatable, non-modifiable
available-size		size optional	Available size Attributes: non-creatable, non-modifiable
storage-type		string optional	Storage Type Attributes: non-creatable, non-modifiable

Information about a single log record.

Name	Range	Type	Description
attributes		volume-transition-log-attrs-info[] optional	Information about attributes included in an Action record.
description		string optional	Detailed description if any associated with this record.
feature		string optional	Which feature logged this message. This is valid only for plugin_start, plugin_end and action record types.
level		string optional	Describes why this record was logged. Possible values: "all" "error" "warning" "info" "debug" "trace"
phase		string	Which phase logged this message. Possible values: "all" "check" "lock_config" "prepare" "pre_commit" "commit" "post_commit" "online" "rollback" "cleanup" "unlock_config" "complete"
record-type		string	Type of record. Possible values: "phase_start" "phase_end" "plugin_start" "plugin_end" "action"
timestamp		string	Timestamp when record was logged. Timestamp will be in the following format: "MM/DD HH:MM:SS"

Information describing the volume and how to transition it.

Name	Range	Type	Description
junction-path		string optional	The path in the vserver into which the volume should be mounted. Note that this is only valid for transitions from 7-mode to Cluster-mode and not untransition. Path should be of the format "/".
volume-name		string	The name of the volume which is to be transitioned.

Name of the aggregate

[none]

Size in bytes Range : [0..2^63-1].

[none]

Information related to 64-bit upgrade.

Name	Range	Type	Description
volume-64bit-upgrade-check-attributes		volume-64bit-upgrade-check-attributes optional	Information returned when 'upgrade-64bit-mode' input in 'aggr-add' is 'check'. Upgrade check results such as 'used-space', 'available-space', 'capacity', and 'grow-space' are only updated after the space estimate is completed successfully.

Information about Anti-Virus settings for the volume.

Name	Range	Type	Description
on-access-policy		string optional	The name of the Anti-Virus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces. Attributes: optional-for-create, modifiable

Attributes of a volume. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
volume-64bit-upgrade-attributes		volume-64bit-upgrade-attributes optional	Information related to 64-bit upgrade. After 64-bit upgrade completes, this information is no longer available.
volume-antivirus-attributes		volume-antivirus-attributes optional	This field contains information about Anti-Virus On-Access settings for the volume.
volume-autosize-attributes		volume-autosize-attributes optional	This field contains information about the autosize settings of the volume.
volume-clone-attributes		volume-clone-attributes optional	This field contains information applying exclusively to clone volumes.
volume-directory-attributes		volume-directory-attributes optional	This field contains information related to directories in a volume.
volume-export-attributes		volume-export-attributes optional	This field contains information about export settings of the volume.
volume-flexcache-attributes		volume-flexcache-attributes optional	This field contains information applying exclusively to flexcache volumes.
volume-id-attributes		volume-id-attributes optional	This field contains identification information about the volume.
volume-inode-attributes		volume-inode-attributes optional	This field contains information about inodes in a volume.
volume-language-attributes		volume-language-attributes optional	This field contains information about volume language-related settings.
volume-mirror-attributes		volume-mirror-attributes optional	This field contains information applying exclusive to volume mirror.
volume-performance-attributes		volume-performance-attributes optional	This field contains information that relates to the performance of the volume.
volume-security-attributes		volume-security-attributes optional	This field contains information about volume security settings.
volume-sis-attributes		volume-sis-attributes optional	This field contains information about Deduplication, file clone, compression, etc.
volume-snapshot-attributes		volume-snapshot-attributes optional	This field contains information applying exclusively to all the snapshots in the volume. Volume disk space-related settings are excluded.
volume-snapshot-autodelete-attributes		volume-snapshot-autodelete-attributes optional	This field contains information about snapshot autodelete policy settings.
volume-space-attributes		volume-space-attributes optional	This field contains information related to volume disk space management including on-disk layout.
volume-state-attributes		volume-state-attributes optional	This field contains information about the state or status of a volume or its features.
volume-striping-attributes		volume-striping-attributes optional	This field contains information applying exclusively to striped volumes.

Information about autosize settings of the volume.

Name	Range	Type	Description
increment-size	[0..2^63-1]	integer optional	The increment size (in bytes) by which the volume would be grown. Attributes: optional-for-create, modifiable
is-enabled		boolean optional	Is the autosize feature enabled on this volume? The default value is false. Attributes: optional-for-create, modifiable
maximum-size	[0..2^63-1]	integer optional	The maximum size (in bytes) to which the volume would be grown automatically. Attributes: optional-for-create, modifiable

Information about volume clones.

Name	Range	Type	Description
clone-child-count	[1..500]	integer optional	Number of clones for which this volume is the parent. Attributes: non-creatable, non-modifiable
volume-clone-parent-attributes		volume-clone-parent-attributes optional	This field appears for a flexible volume if it is a clone of another flexible volume, describing the clone's parentage.

Information related to directories in the volume.

Name	Range	Type	Description
i2p-enabled		boolean optional	If true, native inode-to-parent information is kept for inodes. By default, this field is true. Attributes: non-creatable, non-modifiable
index-dir-enabled		boolean optional	If true, index directory format is enabled. Default: false. Attributes: optional-for-create, modifiable
max-dir-size	[0..2^63-1]	integer optional	The maximum size (in bytes) to which any directory in this volume can grow. The default maximum directory size is set to 1% of the system memory. So if the system memory is 1GB, then the maximum directory size value will be 10MB which allows upto 300,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters. Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create. Attributes: optional-for-create, modifiable
root-dir-gen	[0..2^32-1]	integer optional	This field contains the generation number of the root directory. Attributes: non-creatable, non-modifiable

Information about export settings of the volume.

Name	Range	Type	Description
policy		string optional	The name of the Export Policy to be used by NFS/CIFS protocols. The default policy name is 'default'. Attributes: optional-for-create, modifiable

Information about FlexCache volumes.

Name	Range	Type	Description
cache-policy		cache-policy optional	The name of the cache policy. The default policy name is 'default'. This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API. Attributes: optional-for-create, modifiable
fill-policy		cache-policy optional	The name of the fill policy. The default policy name is 'default'. This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API. Attributes: optional-for-create, modifiable
origin		volume-name optional	The name of the origin volume that contains the authoritative data. This field is valid only for a FlexCache volume. The origin volume must belong to the same vserver that owns this volume. Attributes: optional-for-create, non-modifiable

Identification information about a volume.

Name	Range	Type	Description
comment		string optional	A description for the volume. Attributes: optional-for-create, modifiable
containing-aggregate-name		string optional	The name of the aggregate in which the given flexible volume resides. Attributes: required-for-create, non-modifiable
containing-aggregate-uuid		uuid optional	The 128-bit universally-unique identifier of the aggregate in which the given volume resides. Attributes: non-creatable, non-modifiable
creation-time	[0..2^31-1]	integer optional	Creation time of the volume in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
dsid	[0..2^64-1]	integer optional	The volume's Data Set ID. Attributes: non-creatable, non-modifiable
fsid		string optional	The File System Identifier (FSID) value that serves as one of this volume's internal indicies. This value serves as an internal index for a volume. All volumes on a given controller must have unique FSIDs, except for the two special values described below: A value of 0 indicates that this volume does not currently have a legal FSID for some unexpected reason. Such volumes are forcibly kept offline until this attribute is assigned a legal value. A value of 1 indicates that this volume has recently appeared on its current controller due to having its aggregate be copied from a different controller. All volumes in this newly-created aggregate must be assigned legal, controller-unique IDs when they are onlined. That will be handled automatically by WAFL upon mount. If modifiable, this field may be set only when the volume is restricted. It may be set to any value that is not currently being used by any other volume on the same controller. If a request to set this value to '0' is received, the system will select a new value that is currently unused. Note that setting a volume's FSID sometimes has external effects. In particular, a 7-Mode volume's FSID is part of the NFS file handles constructed for its files. Attributes: non-creatable, non-modifiable
instance-uuid		uuid optional	Universal unique identifier (UUID) for the volume that remains unchanged when the volume is moved to a new location. This differs from the volume's regular UUID which changes after a move. The instance UUID can be used to identify a volume even after it is moved. This field is valid for flexible volumes only. UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used. Here is an example of an actual UUID: 49e370d6-5b5a-11d9-9eb5-000100000529 Attributes: non-creatable, non-modifiable
junction-parent-name		volume-name optional	The name of the parent volume that contains the junction inode of this volume. The junction parent volume must belong to the same vserver that owns this volume. Attributes: non-creatable, non-modifiable
junction-path		junction-path optional	The Junction Path at which this volume is mounted. This field is valid only for a Cluster-Mode volume. Attributes: optional-for-create, non-modifiable
msid	[0..2^64-1]	integer optional	The volume's Mirror Set ID. This field is valid only for a Cluster-Mode volume. Attributes: non-creatable, non-modifiable
name		volume-name optional	The name of the volume. Attributes: key, required-for-create, non-modifiable
name-ordinal		string optional	The ordinal assignment used in relation to this volume's name. Ordinals are used to disambiguate volumes that have the same base name on the same controller. A value of zero indicates that the base volume name is unique on a controller. A value greater than zero indicates that the volume's base name is used by two or more volumes on the same controller, and that appending '(n)' to this volume's name uniquely identifies it on that controller. A value of -1 indicates that the name ordinal has not yet been determined. Attributes: non-creatable, non-modifiable
owning-vserver-name		string optional	The name of the Vserver that owns this volume. Attributes: key, non-creatable, non-modifiable
owning-vserver-uuid		uuid optional	The 128-bit universally-unique identifier for the vserver that currently owns this volume. Attributes: non-creatable, non-modifiable
provenance-uuid		uuid optional	Universal unique identifier (UUID) for the volume that is used to identify the source volume in a mirroring relationship. When the mirroring relationship is broken, a volume's Instance UUID and Provenance UUID are made identical. An unmirrored volume's Provenance UUID is the same as its Instance UUID. This field is valid for flexible volumes only. UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used. Here is an example of an actual UUID: 49e370d6-5b5a-11d9-9eb5-000100000529 Attributes: non-creatable, non-modifiable
type		string optional	The type of the volume. Possible values: 'rw' ... read-write volume, 'ls' ... load-sharing volume, 'dp' ... data-protection volume, 'dc' ... data-cache volume (FlexCache), 'tmp' ... temporary volume (not valid for create) Default value is 'rw'. Attributes: optional-for-create, non-modifiable
uuid		uuid optional	Universal unique identifier (UUID) for this volume. Attributes: non-creatable, non-modifiable

Information about inodes in the volume.

Name	Range	Type	Description
block-type		string optional	The indirect block format of the volume. Possible values: '32_bit', '64_bit' Attributes: non-creatable, non-modifiable
files-private-used	[0..2^64-1]	integer optional	Number of system (not user-visible) files (inodes) used. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
files-total	[0..2^64-1]	integer optional	Total user-visible file (inode) count, i.e., current maximum number of user-visible files (inodes) that this volume can currently hold. Attributes: non-creatable, modifiable
files-used	[0..2^64-1]	integer optional	Number of user-visible files (inodes) used. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
inodefile-private-capacity	[0..2^64-1]	integer optional	Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
inodefile-public-capacity	[0..2^64-1]	integer optional	Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable

Information about the volume language settings.

Name	Range	Type	Description
is-convert-ucode-enabled		boolean optional	This field controls whether all directories in this volume are forcibly converted to UNICODE format when accessed from both NFS and CIFS. The default value for 7-Mode volumes is false, in which case access from CIFS causes conversion of pre-4.0 and 4.0-format directories, and access from NFS causes conversion to 4.0-format directories. The default value for Cluster-Mode volumes is true. Note that this field can be set to false if and only if the volume is a 7-Mode volume, or a Cluster-Mode volume that was transitioned from 7-Mode. Attributes: non-creatable, modifiable
is-create-ucode-enabled		boolean optional	This field controls whether all directories in this volume are forced to use the UNICODE format when they are created, both from NFS and CIFS. The default value is false for 7-Mode volumes, in which case all directories are created in pre-4.0 format and only converted to UNICODE format upon the first CIFS access. The default value is true for Cluster-Mode volumes. Note that this field can be set to false if and only if the volume is a 7-Mode volume. Attributes: non-creatable, non-modifiable
language		string optional	The volume's fully-qualified language mapping, in the form: 'LanguageCode (Full Name).' Example: 'en_US (English (US)).' Attributes: non-creatable, non-modifiable
language-code		language-code optional	The volume's language code (e.g. 'en_US'). Attributes: non-creatable, non-modifiable
nfs-character-set		string optional	The NFS language mapping character set that is currently in effect for the volume. This field is of the following format: '<nfs-character-set>|<display-name>|<asctime>' Note that '|' is not an OR syntax. <asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.' It uses the C Programming Language Printf format: '%.3s %.3s%3d %02d:%02d:%02d %s %d' This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second> <timezone> OR <''>, <year> E.g., If the volume language code is set to 'en_US,' the default NFS character set is as follows: 'iso-8859-1|iso-8859-1|Thu Oct 1 15:00:53 PDT 1998' Attributes: non-creatable, non-modifiable
oem-character-set		string optional	The OEM language mapping character set that is currently in effect for the volume. This field is of the following format: '<oem-code-page>|<display-name>|<asctime>' Note that '|' is not an OR syntax. <asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.' It uses the C Programming Language Printf format: '%.3s %.3s%3d %02d:%02d:%02d %s %d' This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <''>, <year> E.g., If the volume language code is set to 'en_US,' the default OEM character set is as follows: 'cp437|cp437|Thu Oct 1 15:00:53 PDT 1998' Attributes: non-creatable, non-modifiable

Information about the volume mirror.

Name	Range	Type	Description
is-data-protection-mirror		boolean optional	True if this is a data protection mirror. Attributes: non-creatable, non-modifiable
is-load-sharing-mirror		boolean optional	True if this is a load sharing mirror. Attributes: non-creatable, non-modifiable
is-move-mirror		boolean optional	True if this is a volume move mirror. Attributes: non-creatable, non-modifiable
is-replica-volume		boolean optional	True if this is a read only replica volume. Attributes: non-creatable, non-modifiable
mirror-transfer-in-progress		boolean optional	True if a SnapMirror transfer is in progress on this mirrored volume. This mirror's active filesystem can be inconsistent during snapmirror transfer. As a result, snapshot create operation is temporary disabled on this mirror until the current transfer session finishes. This field is set to true at the start of a SnapMirror transfer session and set to false at the end of that session. Attributes: non-creatable, non-modifiable
redirect-snapshot-id	[0..255]	integer optional	If the volume is a logical mirror destination or is in the process of being made one, this field indicates the logical-id of the snapshot to which clients are to be redirected. If modifiable, when setting this attribute, invalid snapshot id or a non-existent snapshot id specified will be rejected with error ESNAPSHOTDOESNOTEXIST. Failure to set ('stamp') the attribute in the volume will cause error ESTAMPREDIRECTSNAPIDERROR to be returned. This field can be set only for online volumes. This option is valid only in Cluster-Mode. The volume can be set to have no redirection snapshot by using a value of 0. This option can be set only for Cluster-Mode volumes participating in a logical-mirror relationship. Setting this field on a Cluster-Mode volume which is not a logical mirror destination (yet) will not have any impact on client access or the volume's behavior. The client access will be impacted with regard to this value only when the volume is converted to a logical-mirror destination. When reading this attribute, the value of 0 indicates volume has no redirection snapshot. The field cannot be interpreted authoritatively if the volume is offline or restricted. Attributes: non-creatable, non-modifiable

Information about performance settings on a volume.

Name	Range	Type	Description
extent-enabled		string optional	If turned on, this field enables extents in the volume. This causes application writes to be written in the volume as a write of a larger group of related data blocks called an extent. The following values are recognized: 'on' ... Perform this optimization on this volume. This option may duplicate blocks from snapshots into the active file system, thereby using additional disk space. Read performance from snapshots will not be changed. 'space_optimized' ... Perform this optimization on this volume, but do not duplicate blocks from snapshots into the active file system, thereby using space conservatively. Read performance from snapshots may be degraded. 'off' ... Don't perform this optimization on this volume. By default, it is set to 'off'. Using extents may help workloads that perform many small random writes followed by a large sequential read. However, using extents may increase the number of disk operations performed on the controller, so this field should only be turned on when applicable. Attributes: non-creatable, modifiable
is-atime-update-enabled		boolean optional	If false, prevent the update of inode access times when a file is read. This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files. By default, this value is true. This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume. Attributes: non-creatable, modifiable
max-write-alloc-blocks	[0..2048]	integer optional	The maximum number of blocks used for write allocation. This option is deprecated. Attributes: optional-for-create, modifiable
minimal-read-ahead		boolean optional	If true, the node performs minimal read-ahead for the volume. By default, this field is false, causing the node that contains this volume to perform very aggressive read-ahead. Attributes: non-creatable, modifiable
read-realloc		string optional	Controls whether application reads cause optimization of the layout of parts of a file or LUN after the data has been read from disk and is in the controller's memory. This optimization is only supported for flexible volumes. The following values are recognized: 'on' ... Perform this optimization on this volume. This option may duplicate blocks from snapshots into the active file system, thereby using additional disk space. Read performance from snapshots will not be changed. 'space_optimized' ... Perform this optimization on this volume, but do not duplicated blocks from snapshots into the active file system, thereby using space conservatively. Read performance from snapshots may be degraded. 'off' ... Don't perform this optimization on this volume. By default, it is set to 'off'. Using read reallocation may help workloads that perform a mixture of random writes and large sequential reads. Attributes: non-creatable, modifiable

All security aspects of a volume.

Name	Range	Type	Description
style		string optional	The security style associated with this volume. Possible values: 'mixed' ... Mixed-style security, 'ntfs' ... NTFS/Windows-style security, 'unix' ... Unix-style security (default setting) If this field is empty ('') or is not present, this attribute isn't applicable to this volume. For example, security styles don't apply to GX-striped data volumes. Attributes: optional-for-create, modifiable
volume-security-unix-attributes		volume-security-unix-attributes optional	The Unix-oriented security settings associated with this volume.

Statistics for Deduplication, file clone, compression, etc.

Name	Range	Type	Description
compression-space-saved	[0..2^63-1]	integer optional	The total disk space (in bytes) that is saved by compressing blocks on the referenced file system. Attributes: non-creatable, non-modifiable
deduplication-space-saved	[0..2^63-1]	integer optional	The total disk space (in bytes) that is saved by deduplication and file cloning. Attributes: non-creatable, non-modifiable
is-sis-logging-enabled		boolean optional	If true, it means that sis is enabled on the volume and fingerprints of newly-written data are being logged. If SIS is enabled, this field is true. If SIS is disabled, this field is false. Attributes: non-creatable, non-modifiable
is-sis-volume		boolean optional	If true, it means that the volume contains shared (deduplication, file clones) or compressed data. If SIS is disabled, this field is false. Attributes: non-creatable, non-modifiable
percentage-compression-space-saved	[0..100]	integer optional	Percentage of the total disk space that is saved by compressing blocks on the referenced file system. Attributes: non-creatable, non-modifiable
percentage-deduplication-space-saved	[0..100]	integer optional	Percentage of the total disk space that is saved by deduplication and file cloning. Attributes: non-creatable, non-modifiable
percentage-total-space-saved	[0..100]	integer optional	Percentage of total disk space that is saved by compressing blocks, deduplication and file cloning. Attributes: non-creatable, non-modifiable
total-space-saved	[0..2^63-1]	integer optional	Total space saved (in bytes) in the volume due to deduplication, compression, and file cloning. Attributes: non-creatable, non-modifiable

Information about snapshot-related attributes in a volume. Volume disk space-related settings are excluded.

Name	Range	Type	Description
auto-snapshots-enabled		boolean optional	If true, enable automatic snapshots on the volume. The default value is true. Attributes: non-creatable, non-modifiable
snapdir-access-enabled		boolean optional	If true, enable the visible '.snapshot' directory that is normally present at system internal mount points. This value also turns on access to all other '.snapshot' directories in the volume. The default value is true. Attributes: non-creatable, modifiable
snapshot-clone-dependency-enabled		boolean optional	Controls the locking of LUN clones. If true, all initial and intermediate backing snapshots are unlocked for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked. If false, the backing snapshot will remain locked until all intermediate backing snapshots are deleted. Attributes: non-creatable, modifiable
snapshot-policy		string optional	The name of the snapshot policy. The default policy name is 'default'. This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs. Attributes: optional-for-create, modifiable

Snapshot autodelete policy settings.

Name	Range	Type	Description
commitment		string optional	Possible values: 'try', 'disrupt', or 'destroy' This option determines the snapshots that 'snapshot autodelete' is allowed to delete to get back space. Setting this option to 'try' only permits the snapshots which are not locked by data protection utilities (dump, mirroring, NDMPcopy) and data-backing functionalities (volume and LUN clones) to be deleted. Setting this option to 'disrupt' permits all snapshots including the snapshots which are locked by data-backing functionalities (volume and LUN clones) to be deleted. Attributes: non-creatable, modifiable
defer-delete		string optional	Possible values: 'scheduled', 'user_created', 'prefix', or 'none' This option determines which kind of snapshots to delete. Setting this option value to 'scheduled' will delete the snapshots created by the snapshot scheduler last. Setting this option value to 'user_created' will delete the snapshots not created by the snapshot scheduler last. Setting this option value to 'prefix' will delete the snapshots matching the prefix string to be deleted last. Setting this option value to 'none' will disable the above choices. Attributes: non-creatable, modifiable
delete-order		string optional	Possible values: 'oldest_first', 'newest_first' This option determines if the oldest or newest snapshot is deleted first. Attributes: non-creatable, modifiable
destroy-list		string optional	Possible values are the combination of: 'lun_clone', 'vol_clone', 'cifs_share', 'file_clone', 'sfsr', or 'none' This options specifies the list of service that can be destroyed if the snapshot is backing that service. This option is valid only when the commitment is set to 'destroy'. The option 'lun_clone,file_clone' should be used for deleting snapshot backing LUN clone and/or File clone. The option 'lun_clone,sfsr' should be used for deleting snapshot backing LUN clone and/or SFSR. It must be noted that 'lun_clone', 'file_clone' and 'sfsr' individually are not valid values. Only pairs of 'lun_clone,file_clone' and 'lun_clone,sfsr' are supported. Attributes: non-creatable, modifiable
is-autodelete-enabled		boolean optional	This option determines if the snapshot autodelete is currently enabled for the volume. The default value is false. Attributes: non-creatable, modifiable
prefix		string optional	This option provides the prefix string for the 'prefix' field value of the 'defer-delete' option. Attributes: non-creatable, modifiable
target-free-space	[0..100]	integer optional	This option determines when snapshot autodelete should stop deleting snapshot. Depending on the trigger, snapshots are deleted until we reach the target free space percentage. Attributes: non-creatable, modifiable
trigger		string optional	Possible values: 'volume', 'snap_reserve', or 'space_reserve' This option determines the condition in which snapshots should be automatically deleted. If modifiable, setting this option to 'volume' triggers snapshot autodelete to run when the volume is near full. Setting this option to 'snap_reserve' triggers snapshot autodelete to run when the snap reserve of the volume is near full. Setting this option to 'space_reserve' triggers snapshot autodelete to run when the space reserved in the volume is near full. Attributes: non-creatable, modifiable

Information about volume space management-related settings including on-disk layout.

Name	Range	Type	Description
is-filesys-size-fixed		boolean optional	If true, this field causes the file system to remain the same size (and not grow) when a SnapMirror relationship is broken. This option is automatically set to 'true' when a volume becomes SnapMirrored. It remains true after the SnapMirror relationship is broken for the volume. This field allows a volume to be SnapMirrored back to the source without needing to grow the source volume. If the volume size is larger than the file system size, setting this field to false forces the file system to grow to the size of the volume. Attributes: non-creatable, modifiable
is-space-guarantee-enabled		boolean optional	Whether or not the storage guarantee associated with the flexible volume is currently in effect. This field is valid only if this is a flexible volume and it is online. By default, space guarantee is enabled. Attributes: non-creatable, non-modifiable
overwrite-reserve	[0..2^63-1]	integer optional	The size (in bytes) that is reserved for overwriting snapshotted data in an otherwise full volume. This space is usable only by space-reserved LUNs and files, and then only when the volume is full. It is equal to 'overwrite-reserve-required' if the value of 'percentage-fractional-reserve' is set to the default value of 100%, but otherwise may be less than 'overwrite-reserve-required'. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
overwrite-reserve-required	[0..2^63-1]	integer optional	The reserved size (in bytes) that is required to ensure that the reserved space is sufficient to allow all space-reserved files and LUNs to be overwritten when the volume is full. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
overwrite-reserve-used	[0..2^63-1]	integer optional	The reserved size (in bytes) that is not available for new overwrites. The number includes both the reserved size which has actually been used for overwrites as well as the size which was never allocated in the first place. On a volume without free space, the 'never allocated' component can become non-zero when 'overwrite-reserve-required' increases as holes are filled in. Because of this, the 'overwrite-reserve-used' value can exceed the snapshotted size. The 'overwrite-reserve-used' value can also exceed the value of 'overwrite-reserve-required', as the filer maintains a small hidden reserve of last resort. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
overwrite-reserve-used-actual	[0..2^63-1]	integer optional	The reserved size (in bytes) that has been used. This value is computed as the smaller of: (1) snapshotted size not in the active filesystem, and (2) 'overwrite-reserve-used'. This formula comes from the observation that you cannot have used more overwrite reserved than have actually overwritten data. This value can exceed the value of 'overwrite-reserve-required', as the filer maintains a small hidden reserve of last resort. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
percentage-fractional-reserve	[0..100]	integer optional	This field can be used to change the amount of space reserved for overwrites of reserved objects (e.g., files, LUNs) in a volume. This field is expressed as a percent. By default, it is set to 100, indicating that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites. Using a value of less than 100 indicates the percentage of the required reserved space should actually be reserved. This returns the extra space to the available space for the volume, decreasing the total amount of space used. However, this does leave the protected objects in the volume vulnerable to out of space errors, since less than 100% of the required reserved space is actually reserved. If reserved space becomes exhausted, this will cause disruptions on the hosts using the objects. If the percentage is decreased below 100%, it is highly recommended that the administrator actively monitor the space usage on the volume and take corrective action if the reserved space nears exhaustion. Attributes: non-creatable, modifiable
percentage-size-used	[0..100]	integer optional	Percentage of the volume size that is used. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
percentage-snapshot-reserve	[0..100]	integer optional	The percentage of volume disk space that has been set aside as reserve for snapshot usage. Attributes: non-creatable, modifiable
percentage-snapshot-reserve-used	[0..2^32-1]	integer optional	Percentage of the volume reserved for snapshots that has been used. Note that in some scenarios, it is possible to pass 100% of the space allocated. Attributes: non-creatable, non-modifiable
size	[0..2^63-1]	integer optional	The volume's overall, absolute size (in bytes). This includes WAFL reserve and volume snapshot reserve. Attributes: optional-for-create, modifiable
size-available	[0..2^63-1]	integer optional	The size (in bytes) that is still available in the volume. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
size-available-for-snapshots	[0..2^63-1]	integer optional	Total free space (in bytes) available in the volume and the snapshot reserve. If this value is 0, a new snapshot cannot be created. Attributes: non-creatable, non-modifiable
size-total	[0..2^63-1]	integer optional	Total usable size (in bytes) of the volume, not including WAFL reserve and volume snapshot reserve. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
size-used	[0..2^63-1]	integer optional	The size (in bytes) that is used in the volume. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
snapshot-reserve-size	[0..2^63-1]	integer optional	The size (in bytes) in the volume that has been set aside as reserve for snapshot usage. Attributes: non-creatable, non-modifiable
space-guarantee		string optional	The storage guarantee option that is associated with the flexible volume. Possible options: 'none', 'volume' (default option), 'file' This field is valid only if this is a flexible volume and it is online. Attributes: optional-for-create, modifiable
space-mgmt-option-try-first		string optional	This field controls the strategy to try first when this volume is space-challenged. There are two available settings: 'volume_grow' ... (default setting) Causes the volume to increase in size before deleting snapshots, 'snap_delete' ... Causes snapshots to be deleted before the volume size is increased. Attributes: non-creatable, modifiable

Information about the state or status of a volume or its features.

Name	Range	Type	Description
become-node-root-after-reboot		boolean optional	Whether this non node-root volume has been marked as the one that will become the node root volume the next time the hosting controller is rebooted. Only one volume at a time may have this marking on any given controller. This field is not directly settable. Instead, a legal request to set the 'is-node-root' attribute (if modifiable) causes this field to be set. Note that marking a volume that is already the node root volume as the new node root has no net effect. By default, this field is false. Attributes: non-creatable, non-modifiable
ignore-inconsistent		boolean optional	If true, then the volume can be brought online when booting even if it is marked as inconsistent. The user is cautioned that bringing it online prior to running wafliron may result in further file system inconsistency. By default, this field is false. Attributes: non-creatable, non-modifiable
in-nvfailed-state		boolean optional	The user can only clear this state and never set it. The file system will set this state on the volume if NVFAIL event occurs. So long as the volume is in this state, all protocol Ops with a special SpinNP flag set are blocked. By clearing this state on the volume, the admin will allow protocol access to the data on the volume and can initiate the recovery process. By default, this field is false. Attributes: non-creatable, modifiable
is-cluster-volume		boolean optional	Indicates whether this volume is a Cluster-Mode volume, namely one that is owned by cluster authorities and agents. These same clustering agents also provide all protocol services for this class of volume. Cluster-Mode volumes are not supported in 7-Mode Data ONTAP deployments. All such volumes are forced offline whenever they are detected in that environment. Similarly, all 7-Mode volumes on a Data ONTAP Cluster-Mode system (except each controller's root volume) are by default forced offline. There are exceptions, in particular when a 7-Mode volume is being prepared to become that controller's new root volume in a recovery scenario. At the moment, traditional volumes cannot be Cluster-Mode volumes. On the other hand, all striped volumes are Cluster-Mode volumes. By default, this field is false. Attributes: non-creatable, non-modifiable
is-inconsistent		boolean optional	Whether or not there is known inconsistency in the file system associated with the volume. By default, the value is false. Attributes: non-creatable, non-modifiable
is-invalid		boolean optional	Whether or not this volume is invalid. Volumes typically become invalid as a result of an aborted 'vol copy' or SnapMirror(R) initial transfer. In such a case, a volume is in a half-created state and cannot be recovered. By default, the value is false. Attributes: non-creatable, non-modifiable
is-junction-active		boolean optional	This field indicates whether the mounted volume is accessible. The default is true. If the mounted path is not accessible, the volume does not appear in the owning Vserver's namespace. This field applies only to Cluster-Mode volumes. Attributes: optional-for-create, modifiable
is-node-root		boolean optional	If true, this volume is the root volume of the node in which it resides. Only the node's internal logic can change this option's value from true to false; this happens when some other volume has the value set to true. By default, this field is false. Attributes: non-creatable, non-modifiable
is-nvfail-enabled		boolean optional	If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in this volume due to an NVRAM failure. For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data). It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found. For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume. To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume. By default, this value is false. Attributes: optional-for-create, modifiable
is-quiesced-in-memory		boolean optional	Is the given volume quiesced? If true, this volume is in an (in-memory) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
is-quiesced-on-disk		boolean optional	Is the given volume quiesced? If true, this volume is in an (on-disk) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
is-unrecoverable		boolean optional	Whether or not there is known inconsistency in the associated file system and it is not recoverable. This field is valid only for flexible volumes. By default, this field is false. Attributes: non-creatable, non-modifiable
is-vserver-root		boolean optional	If true, this volume is the namespace root volume of the Vserver which owns this volume. The default value is false. When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable. Attributes: optional-for-create, non-modifiable
state		string optional	Volume State. Possible values: 'online', 'restricted', 'offline' Attributes: optional-for-create, modifiable

Information about the striping attributes of a volume.

Name	Range	Type	Description
concurrency		string optional	Concurrency Level. Possible values: 'low' ... Maximum compatibility in exchange for significant performance loss, 'medium' ... Excellent client compatibility, but noticeable performance loss, 'high' ... Good level of compatibility with a small performance loss (default setting), 'peak' ... Maximum performance; some applications may observe file-timestamp anomalies Attributes: optional-for-create, modifiable
constituent-volume-count	[1..72]	integer optional	The number of constituent volumes present in the collective striped volume. The default setting is equal to the number of striped contituent aggregates. Attributes: optional-for-create, non-modifiable
optimize		string optional	Optimization Policy. Possible values: 'max_performance' ... Guarantees best performance even if doing so might result in less free space being available, 'performance' ... Provides best performance until free space becomes low; then lowers performance in order to maximize free space (default setting), 'space' ... Balances good performance with moderate constraints to ensure that free space is not wasted, 'max_space' ... Ensures data consumes as little space as possible, even if doing so slightly reduces performance Attributes: optional-for-create, modifiable
stripe-algorithm		string optional	Indicates the striping algorithm in force. Possible values: 'roundrobin' ... Original algorithm for data-only striping, 'full' ... Full striping (data and metadata), 'data' ... Data-only striping. This is the default setting. Attributes: optional-for-create, non-modifiable
stripe-width	[0..2^64-1]	integer optional	The size of a stripe in bytes. Increases can be made in 4KB increments. The default value is 64 MBytes. Attributes: optional-for-create, modifiable

Information about attributes included in an Action record.

Name	Range	Type	Description
attr-type		string	Describes the type of attribute.
attr-value		string	Attribute value.

Cache Policy Name

[none]

The Junction Path. The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An example of a valid junction path is: '/user/my_volume'. Only one volume can be mounted at any given junction path.

[none]

Language Code. The following are the possible language codes along with their names: 'C' ... POSIX, 'ar' ... Arabic, 'cs' ... Czech, 'da' ... Danish, 'de' ... German, 'en' ... English, 'en_US' ... English (US), 'es' ... Spanish, 'fi' ... Finnish, 'fr' ... French, 'he' ... Hebrew, 'hr' ... Croatian, 'hu' ... Hungarian, 'it' ... Italian, 'ja' ... Japanese euc-j*, 'ja_v1' ... Japanese euc-j, 'ja_JP.PCK' ... Japanese PCK (sjis)*, 'ja_JP.932' ... Japanese cp932*, 'ja_JP.PCK_v2' ... Japanese PCK (sjis), 'ko' ... Korean, 'no' ... Norwegian, 'nl' ... Dutch, 'pl' ... Polish, 'pt' ... Portuguese, 'ro' ... Romanian, 'ru' ... Russian, 'sk' ... Slovak, 'sl' ... Slovenian, 'sv' ... Swedish, 'tr' ... Turkish, 'zh' ... Simplified Chinese, 'zh.GBK' ... Simplified Chinese (GBK), 'zh_TW' ... Traditional Chinese euc-tw, 'zh_TW.BIG5' ... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.

[none]

The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]

Information related to 64-bit upgrade.

Name	Range	Type	Description
volume-64bit-upgrade-check-attributes		volume-64bit-upgrade-check-attributes optional	Information returned when 'upgrade-64bit-mode' input in 'aggr-add' is 'check'. Upgrade check results such as 'used-space', 'available-space', 'capacity', and 'grow-space' are only updated after the space estimate is completed successfully.

Information returned when 'upgrade-64bit-mode' in 'aggr-add' is 'check'.

Name	Range	Type	Description
age	[0..2^64-1]	integer optional	The age in seconds of the space check results. Attributes: non-creatable, non-modifiable
available-space	[0..2^64-1]	integer optional	Amount of space (in bytes) that would be available in the volume after it is upgraded to 64-bit. Attributes: non-creatable, non-modifiable
capacity	[0..100]	integer optional	Percentage of space that would be used in the volume after it is upgraded to 64-bit. Attributes: non-creatable, non-modifiable
check-last-errno	[-2^31..2^31-1]	integer optional	The error code of the last attempt to check for space usage on the specific volume. This field is present only if a 64-bit upgrade check was previously attempted. Possible values: 0 - indicates success EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL Upgrade check results may be out of date if check-last-errno is not 0. Attributes: non-creatable, non-modifiable
grow-space	[0..2^64-1]	integer optional	Amount of space (in bytes) the volume must be grown by before successfully upgrading its current data. Attributes: non-creatable, non-modifiable
used-space	[0..2^64-1]	integer optional	Amount of space (in bytes) that would be used in the volume after it is upgraded to 64-bit. Attributes: non-creatable, non-modifiable

Information about Anti-Virus settings for the volume.

Name	Range	Type	Description
on-access-policy		string optional	The name of the Anti-Virus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces. Attributes: optional-for-create, modifiable

Information describing the parentage of a clone volume.

Name	Range	Type	Description
dsid	[0..2^64-1]	integer optional	The clone parent volume's Data Set ID. Attributes: non-creatable, non-modifiable
msid	[0..2^64-1]	integer optional	The clone's parent volume's Mirror Set ID. Attributes: non-creatable, non-modifiable
name		volume-name optional	The clone parent volume's human-readable name. Attributes: non-creatable, non-modifiable
snapshot-id	[0..2^64-1]	integer optional	The clone parent volume's base snapshot identifier. The only legal value for a snapshot identifier is its Data Set ID. Attributes: non-creatable, non-modifiable
snapshot-name		string optional	The clone parent volume's base snapshot name. Attributes: non-creatable, non-modifiable
uuid		uuid optional	The clone parent volume's UUID. Attributes: non-creatable, non-modifiable

The name of the volume. Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name. Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'. For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

[none]

The Unix-oriented security settings associated with this volume.

Name	Range	Type	Description
group-id	[0..2^32-1]	integer optional	The UNIX group ID for the volume. The default value is 0 ('root'). Attributes: optional-for-create, modifiable
permissions		string optional	Unix permission bits in octal string format. It's similar to Unix style permission bits: In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users. In Data ONTAP Cluster-Mode, for security style 'mixed' or 'unix', the default setting of '0700' gives read/write/execute permissions to owner and no permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users. It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group. Attributes: optional-for-create, modifiable
user-id	[0..2^32-1]	integer optional	The UNIX user ID for the volume. The default value is 0 ('root'). Attributes: optional-for-create, modifiable

The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]