APIs in Category: volume | Cluster-Mode API version 1.20

volume-clone-get-iter volume-copy-start volume-footprint-get-iter volume-get-iter volume-modify-iter volume-modify-iter-async volume-move-get-iter volume-move-start volume-move-target-aggr-get-iter volume-move-trigger-abort volume-move-trigger-cutover volume-space-get-iter volume-storage-service-get-iter volume-transition-check volume-transition-log-delete volume-transition-log-get-iter volume-transition-protect

NetApp Manage ONTAP

volume-clone-get-iter | [top]

> Display a list of FlexClone volumes

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-copy-start | [top]

> 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 |  |
> EVOLUME_DEST_STRIPED_VOL_NAME_NOT_ALLOWED |  |
> EAGGRDOESNOTEXIST |  |
> EAGGRNOTONLINE |  |
> EOPNOTSUPPORTED |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EVOLUME_TYPE_NOT_SUPPORTED |  |

volume-footprint-get-iter | [top]

> Display a list of volumes and their data and metadata footprints in their parent aggregate. The term footprint is used to refer to space that is considered used in an aggregate due to data in a specific volume.

> Input Name | Range | Type | Description
> desired-attributes |  | footprint-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | footprint-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-footprint object. All volume-footprint 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 |  | footprint-info[] optional | The list of attributes of volume-footprint objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more volume-footprint objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-modify-iter | [top]

> Modify the attributes of a volume or a group of volume objects. This API is not supported for Infinite Volumes.

> 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..2^32-1] | 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..2^32-1] | integer optional | Number of volume objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..2^32-1] | 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

volume-modify-iter-async | [top]

> Modify the attributes of an Infinite Volume or a group of repositories. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation of expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initilization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents. This API does not require any license when operating on an Infinite Volume.

> 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..2^32-1] | 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 or scheduled for update. 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-async-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..2^32-1] | integer optional | Number of volume objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of volume objects that matched the query and were successfully updated or scheduled for update.
> success-list |  | volume-modify-iter-async-info[] optional | The volume objects that were successfully updated or scheduled for update. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

> License
> Striped_Volume

volume-move-get-iter | [top]

> Get status of move operation

> Input Name | Range | Type | Description
> desired-attributes |  | volume-move-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | volume-move-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-move-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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-move-start | [top]

> 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 |  |
> EVOL_TOO_MANY |  |
> 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 |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> ECANNOT_MOVE_TRANSITION_VOLUME |  |
> EVOL_CLONE_BEING_SPLIT |  |
> EVOLMOVE_CANNOT_MOVE_TO_CFO |  |
> EVOLMOVE_CANNOT_MOVE_FROM_CFO_AGGR_IN_TAKEOVER |  |

volume-move-target-aggr-get-iter | [top]

> 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> 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 (Required field)
> vserver |  | string | Vserver Name (Required field)
> 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EOP_DISALLOWED_ON_7MODE_VOL |  |

volume-move-trigger-abort | [top]

> Stop a running volume move operation. This is an asynchrous API call and it does not wait for the abort to finish before returning. volume-move-get-iter can be used to monitor the progress of the abort and get the status. Unlike 'job stop', this API makes it possible to stop a move job by the vserver and volume name. If the specified volume has completed the volume move operation, an error is returned.

> Input Name | Range | Type | Description
> source-volume |  | string | The volume that is part of a completed or running volume move operation.
> vserver |  | string | Vserver Name

> Errno | Description
> EAPIERROR |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUME_MOVE_COMPLETED |  |

volume-move-trigger-cutover | [top]

> 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 |  |
> EVSERVER_OP_NOT_ALLOWED |  |

volume-space-get-iter | [top]

> Display a list of volumes and a breakup of their used space. This information is only available when the volume is online

> Input Name | Range | Type | Description
> desired-attributes |  | space-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | space-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-space object. All volume-space 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 |  | space-info[] optional | The list of attributes of volume-space objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more volume-space objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-storage-service-get-iter | [top]

> Iterate over a list of volume-storage-service objects.

> Input Name | Range | Type | Description
> desired-attributes |  | storage-service-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | storage-service-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-storage-service object. All volume-storage-service 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 |  | storage-service-info[] optional | The list of attributes of volume-storage-service objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more volume-storage-service objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

volume-transition-check | [top]

> 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 |  |

volume-transition-log-delete | [top]

> 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 |  |

volume-transition-log-get-iter | [top]

> 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 | [0..2^32-1] | 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 |  |

volume-transition-protect | [top]

> Fence access to volume during Transition.

> Input Name | Range | Type | Description
> is-enabled |  | boolean | Protection Enabled
> volume |  | string | The name of the volume.
> vserver |  | string | The name of the Vserver which owns the volume.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVOLUMENOTONLINE |  |
> EONTAPI_EINPROGESS |  |
> EVOLTRANSERROR |  |
> EVOLTRANSWARNING |  |
> EVOLTRANSNOTALLOWED |  |

Element definition: footprint-info | [top]

> Space configuration info 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
> dedupe-metafiles-footprint | [0..2^63-1] | integer optional | This field represents temporary deduplication metadata footprint in bytes. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-footprint-percent | [0..100] | integer optional | This field represents deduplication metadata footprint as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-temporary-footprint | [0..2^63-1] | integer optional | This field represents temporary deduplication metadata footprint in bytes. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-temporary-footprint-percent | [0..100] | integer optional | This field represents deduplication metadata footprint as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> delayed-free-footprint | [0..2^63-1] | integer optional | This field represents the delayed free blocks footprint in bytes. This system is used to improve delete performance by batching delete requests. Attributes: non-creatable, non-modifiable
> delayed-free-footprint-percent | [0..100] | integer optional | This field represents the delayed free blocks footprint as a percentage of aggregate size. This system is used to improve delete performance by batching delete requests. Attributes: non-creatable, non-modifiable
> flexvol-metadata-footprint | [0..2^63-1] | integer optional | This field represents flexible volume metadata in bytes. Attributes: non-creatable, non-modifiable
> flexvol-metadata-footprint-percent | [0..100] | integer optional | This field represents flexible volume metadata as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> snapmirror-destination-footprint | [0..2^63-1] | integer optional | This field represents the SnapMirror destination footprint in bytes. Attributes: non-creatable, non-modifiable
> snapmirror-destination-footprint-percent | [0..100] | integer optional | This field represents the SnapMirror destination footprint as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> tape-backup-metafiles-footprint | [0..2^63-1] | integer optional | This fields represents the tape backup metadata footprint in bytes. Attributes: non-creatable, non-modifiable
> tape-backup-metafiles-footprint-percent | [0..100] | integer optional | This field represents the tape backup metadata footprint as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> total-footprint | [0..2^63-1] | integer optional | This field represents the total footprint in bytes. Attributes: non-creatable, non-modifiable
> total-footprint-percent | [0..100] | integer optional | This field represents the total footprint as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> volume |  | string optional | Name of the volume for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
> volume-blocks-footprint | [0..2^63-1] | integer optional | This field represents the footprint of blocks written to the volume in bytes. Attributes: non-creatable, non-modifiable
> volume-blocks-footprint-percent | [0..100] | integer optional | This field represents the footprint of blocks written to the volume as a percentage of aggregate size. Attributes: non-creatable, non-modifiable
> volume-guarantee-footprint | [0..2^63-1] | integer optional | This field represents the volume guarantee footprint in bytes. Alternatively, it is the space reserved for future writes in the volume. Attributes: non-creatable, non-modifiable
> volume-guarantee-footprint-percent | [0..100] | integer optional | This field represents the volume guarantee footprint as a percentage of aggregate size. Alternatively, it is the percentage of space reserved for future writes in the volume. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Name of the Vserver that contains the volumes for which the space usage is requested. Attributes: key, non-creatable, non-modifiable

Element definition: space-info | [top]

> Space configuration info 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
> dedupe-metafiles | [0..2^63-1] | integer optional | This field represents space used by deduplication metafiles in bytes. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-percent | [0..100] | integer optional | This field represents space used by deduplication metafiles as a percentage of volume size. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-temporary | [0..2^63-1] | integer optional | This field represents space used by temporary deduplication metafiles in bytes. Attributes: non-creatable, non-modifiable
> dedupe-metafiles-temporary-percent | [0..100] | integer optional | This field represents space used by temporary deduplication metafiles as a percentage of volume size. Attributes: non-creatable, non-modifiable
> filesystem-metadata | [0..2^63-1] | integer optional | This field represents volume filesystem metadata in bytes. Attributes: non-creatable, non-modifiable
> filesystem-metadata-percent | [0..100] | integer optional | This field represents volume filesystem metadata as a percentage of volume size Attributes: non-creatable, non-modifiable
> inodes | [0..2^63-1] | integer optional | This field represents space used by inode metadata in bytes. Attributes: non-creatable, non-modifiable
> inodes-percent | [0..100] | integer optional | This field represents space used by inode metadata as a percentage of volume size. Attributes: non-creatable, non-modifiable
> quota-metafiles | [0..2^63-1] | integer optional | This field represents space used by quota metafiles in bytes. Attributes: non-creatable, non-modifiable
> quota-metafiles-percent | [0..100] | integer optional | This field represents space used by quota metafiles as a percentage of volume size. Attributes: non-creatable, non-modifiable
> snapmirror-metadata | [0..2^63-1] | integer optional | This field represents space used by metafiles during SnapMirror operations in bytes. Attributes: non-creatable, non-modifiable
> snapmirror-metadata-percent | [0..100] | integer optional | This field represents space used by metafiles during SnapMirror operations as a percentage of volume size. Attributes: non-creatable, non-modifiable
> snapshot-reserve | [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
> snapshot-reserve-percent | [0..100] | integer optional | This field represents the snapshot reserve as a percentage of volume size. Attributes: non-creatable, non-modifiable
> snapshot-spill | [0..2^63-1] | integer optional | This field represents space used by Snapshot copies when it exceeds the size of the Snapshot reserve in bytes. It is computed as Snapshot used minus Snapshot reserve when Snapshot used exceeds Snapshot reserve. Attributes: non-creatable, non-modifiable
> snapshot-spill-percent | [0..100] | integer optional | This field represents Snapshot spill as a percentage of volume size. It is computed as Snapshot used minus Snapshot reserve when Snapshot used exceeds Snapshot reserve. Attributes: non-creatable, non-modifiable
> tape-backup-metadata | [0..2^63-1] | integer optional | This fields represents the tape backup metadata in bytes. Attributes: non-creatable, non-modifiable
> tape-backup-metadata-percent | [0..100] | integer optional | This field represents the tape backup metadata as a percentage of volume size. Attributes: non-creatable, non-modifiable
> total-used | [0..2^63-1] | integer optional | Total used space in the volume including snapshot reserve in bytes. Attributes: non-creatable, non-modifiable
> total-used-percent | [0..100] | integer optional | Total used space in the volume including snapshot reserve as a percentage of volume size. Attributes: non-creatable, non-modifiable
> user-data | [0..2^63-1] | integer optional | This field represents user data in bytes. Alternatively, this is the space reserved to overwrite the data in the volume. Attributes: non-creatable, non-modifiable
> user-data-percent | [0..100] | integer optional | This field represents user data as a percentage of volume size. Attributes: non-creatable, non-modifiable
> volume |  | string optional | Name of the volume for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
> vserver |  | string optional | Name of the Vserver that contains the volumes for which the space usage is requested. Attributes: key, non-creatable, non-modifiable

Element definition: storage-service-info | [top]

> Storage Services 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
> constituent-group-id | [0..2^32-1] | integer optional | Constituent Group ID Attributes: non-creatable, non-modifiable
> storage-service |  | storage-service-name optional | Storage Service Name Attributes: non-creatable, non-modifiable
> storage-service-id |  | storage-service-id optional | Storage Service ID Attributes: key, non-creatable, non-modifiable
> storage-service-type |  | storage-service-type optional | Storage Service Type Attributes: non-creatable, non-modifiable Possible values: "legacy" - No Support for Storage Services, "normal" - Support For Storage Services
> volume |  | volume-name optional | Volume Name Attributes: key, non-creatable, non-modifiable
> vserver |  | vserver-name optional | Vserver Name Attributes: key, non-creatable, non-modifiable

Element definition: volume-attributes | [top]

> 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 Antivirus 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-hybrid-cache-attributes |  | volume-hybrid-cache-attributes optional | This field contains information on Flash Pool caching attributes on a volume
> volume-id-attributes |  | volume-id-attributes optional | This field contains identification information about the volume.
> volume-infinitevol-attributes |  | volume-infinitevol-attributes optional | This field contains information about the state of an Infinite 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-qos-attributes |  | volume-qos-attributes optional | This field contains the information that relates to QoS.
> 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-transition-attributes |  | volume-transition-attributes optional | This field contains information applying exclusively to transitioned or transitioning volumes.
> volume-vm-align-attributes |  | volume-vm-align-attributes optional | This field contains information related to the Virtual Machine alignment settings on a volume

Element definition: volume-clone-info | [top]

> 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
> qos-policy-group-name |  | string optional | QoS Policy Group Name Attributes: optional-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
> volume-type |  | string optional | The type of the volume to be created. Possible values: 'rw' ... read-write volume, 'dp' ... data-protection volume Default value is 'rw'. Attributes: optional-for-create, non-modifiable
> vserver |  | string optional | Vserver Name Attributes: key, non-creatable, non-modifiable

Element definition: volume-modify-iter-async-info | [top]

> 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.
> jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".
> volume-key |  | volume-attributes | The keys for the volume object to which the modify operation applies.

Element definition: volume-modify-iter-info | [top]

> 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.

Element definition: volume-move-info | [top]

> Status of the move operation 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
> actual-completion-timestamp | [0..2^31-1] | integer optional | The date and time in cluster timezone when the volume move completed (successfully or otherwise). If the volume move operation completed successfully, this is the time when the volume on the destination aggregate has been made master and the original volume on the source aggregate has been deleted or is no longer a master copy. Attributes: non-creatable, non-modifiable
> actual-duration | [0..2^32-1] | integer optional | The duration in days, hours, minutes and seconds for which the volume move was or is in progress. Attributes: non-creatable, non-modifiable
> bytes-remaining | [0..2^63-1] | integer optional | The number of bytes remaining to be sent during volume move. This is an approximate number and lags the current status by a few (3) minutes while the volume move is in operation. The bytes-remaining is applicable only for ongoing volume moves. It is not applicable to completed or failed moves. The data inside the volume is considered to be much much larger than data outside the volume. This value most of the time will track data inside the volume yet to be sent. Note that the bytes-remaining can increase over a period of time depending on the rate of change of volume by protocols or other consumers of the volume. Attributes: non-creatable, non-modifiable
> bytes-sent | [0..2^63-1] | integer optional | The number of bytes sent thus far as part of volume move. This is an approximate number and lags the current status by a few seconds while the volume move is in operation. The bytes-sent is applicable only for ongoing and successful volume moves. The bytes-sent counter is mononotonically increasing in most cases. It is stored in memory. As a result, any reboots or failover of the move operation can lead to resetting of this counter to a lesser value than reported earlier. The data inside the volume is considered to be much much larger than metadata of the volume, mostly stored outside the volume. This value most of the time will track data inside the volume sent at the time of retreiving status. Attributes: non-creatable, non-modifiable
> completion-code | [0..2^64-1] | integer optional | The status code of the move operation. The status code will be 0 while the job is running or is successful. It will be non-zero if it is not successful. The code field will be the same as job show's 'status job' field. This field will be in diag mode of the UI. Attributes: non-creatable, non-modifiable
> completion-status |  | string optional | Once a volume move is complete, the final state of the volume move operation. This is available in diag mode only. Attributes: non-creatable, non-modifiable
> cutover-action |  | string optional | The action to be taken for cutover or during cutover failure. Can be one of abort_on_failure, defer_on_failure, force or wait. This is the input given during the start of volume move. Attributes: non-creatable, modifiable
> cutover-attempted-count | [0..2^32-1] | integer optional | Number of times cutover has been attempted during the move operation. This is a diag only field. Attributes: non-creatable, non-modifiable
> cutover-attempts | [1..25] | integer optional | The number of attempts to be used by the move operation to cutover to the destination volume. This is the input by the upper layers. If the number of attempts is exhausted, the cutover-action input determines the next course of action for the move operation. Attributes: non-creatable, modifiable
> cutover-hard-deferred-count | [0..2^32-1] | integer optional | Number of times cutover has been hard deferred during the move operation due to non-transient, intervention-necessary conditions. This is a diag only field. Attributes: non-creatable, non-modifiable
> cutover-trigger-timestamp | [0..2^31-1] | integer optional | The time when move operation last accepted a trigger to initiate cutover. This is applicable when the move operation is waiting for a cutover to be triggered because of a hard cutover deferred state or because the cutover-action was wait. Attributes: non-creatable, non-modifiable
> cutover-window | [30..300] | integer optional | The time window in seconds given as input for the cutover phase of volume move. Attributes: non-creatable, modifiable
> cutovers-soft-deferred-count | [0..2^32-1] | integer optional | Number of times cutover has been soft deferred during the move operation due to transient conditions. This is a diag only field. Attributes: non-creatable, non-modifiable
> destination-aggregate |  | string optional | The name of the aggregate where the volume is being moved to. Attributes: non-creatable, non-modifiable
> destination-node |  | string optional | The name of the node where the destination aggregate is. This will be a diagnostic only field. Attributes: non-creatable, non-modifiable
> details |  | string optional | This field contains details about any warnings, errors and state of the move operation. This is a string field. Attributes: non-creatable, non-modifiable
> estimated-completion-time | [0..2^31-1] | integer optional | The approximate date and time in the cluster time zone when the entire volume move operation is expected to complete. The move operation completes when the volume instance on the destination aggregate has become the master copy and the volume instance on the source aggregate has been deleted or is no longer the master copy. The format will be in Ontap's Date format. Note that this time may keep increasing when the move goes into Cutover-Deferrred mode. In those cases where the input for cutover-action is wait, during data copy phase, estimated time of completion will approximate the time to reach cutover point and wait for user intervention. Attributes: non-creatable, non-modifiable
> estimated-remaining-duration | [0..2^32-1] | integer optional | The approximate amount of time in terms of days, hours, minutes and seconds remaining to complete the volume move. Note that this duration will not go down to zero when the move goes into Cutover-Deferrred mode. The duration displayed in the examples is not correct. cutover. Attributes: non-creatable, non-modifiable
> execution-progress |  | string optional | The execution progress of the job as reported by the job. This is used for debugging purposes only and is only available in diag mode. Attributes: non-creatable, non-modifiable
> internal-state |  | string optional | This is the actual internal state of the move job. This is used for debugging purposes only and is only available in diag mode. Attributes: non-creatable, non-modifiable
> job-id | [0..2^64-1] | integer optional | The ui job id of the move job. This is available in diag mode only. Attributes: non-creatable, non-modifiable
> job-uuid |  | uuid optional | The job uuid of the move job. This is available in diag mode only. Attributes: non-creatable, non-modifiable
> last-cutover-trigger-timestamp | [0..2^31-1] | integer optional | The time when move operation initiated cutover. Attributes: non-creatable, non-modifiable
> managing-node |  | string optional | The node in the cluster on which the move operation/job is or was running. This is usually on the node hosting the volume to be moved. Attributes: non-creatable, non-modifiable
> percent-complete | [0..100] | integer optional | The amount of work to move the volume completed thus far in terms of percentage. Attributes: non-creatable, non-modifiable
> phase |  | string optional | The phase of the move operation. The move operation can have the following phases: Queued - Phase where the move operation is queued for execution by the cluster. Initializing - Phase where the move operation is setting up resources and initializing them for moving the volume. Replicating - Phase in which move operation is doing data copy from source volume to destination aggregate. Cutover - Phase in which the move operation is attempting to switch over volume to the destination aggregate and ensuring client i/o and system operations go to the volume on the destination aggregate. In this phase client i/o and system operations are temporarily suspended while a final data copy is taking place from the current volume to the destination aggregate. cutover_hard_deferred - Phase in which the move operation is deferring cutover due to some errors in the system during move. The move operation is waiting for corrective action from the admin or MEI tools to take place. The details field contains the reason for the error. cutover_soft_deferred - Phase in which the move operation is deferring cutover due to some transient errors in the system during move. The move operation is replicating in the background and waiting for the transient error which is causing the soft deferral to clear up. If the move operation has not yet started the replication in the background, the 'Detailed Status' field will contain the reason for soft deferral. Completed - The move operation has completed successfully and the volume is now on destination aggregate. cleaning_up - The move operation aborted and is in the process of cleaning up. This is a transient condition that will eventually lead to Failed phase. Failed - The move operation was not successful. The details field and the code indicates the reason for the failure. Failed - The move operation did not complete successfully. Restarting - The move operation is restarting. Attributes: non-creatable, non-modifiable
> prior-issues |  | string optional | The list of issues or transient errors encountered causing the move operation to retry the data copy phase or the cutover phase. For RR.1, there will be only one transient error reported. For later releases, there can be many transient errors seperated by newlines reported, with the order being earliest at top and latest error at the bottom of the list. This is a diag only field. Attributes: non-creatable, non-modifiable
> replication-throughput |  | string optional | The current replication throughput of the move operation in terms of Kb/s, Mb/s or Gb/s. Attributes: non-creatable, non-modifiable
> source-aggregate |  | string optional | The name of the aggregate where the volume being moved originally resides or resided. Attributes: non-creatable, non-modifiable
> source-node |  | string optional | The name of the node where the source aggregate is. Attributes: non-creatable, non-modifiable
> start-timestamp | [0..2^31-1] | integer optional | The date and time in cluster timezone when the volume move started. Attributes: non-creatable, non-modifiable
> state |  | string optional | The state of the volume move at the time of issuing the command and the system gathering up the information about the move. The states can have the following values: Healthy - Volume move is proceeding as planned, with no issues so far Done - Volume move has finished successfully. Failed - Volume move has failed due to some reason, with the reason being available in the Detailed Status section. Warning - Volume move has encountered a transient error condition during its operation, but is continuing on since then. The details and phase section has more context into the cause of the error. Alert - Volume move has encountered a serious condition that cannot be rectified by the system alone and needs input from the upper layers (admin or tools) before proceeding. The volume move will go into Cutover-Deferred phase waiting for user intervention in case of errors, with volume move trigger-cutover being the way the move operation can be restarted. Attributes: non-creatable, non-modifiable
> volume |  | volume-name optional | This is the name of the vserver-scoped volume being moved. Attributes: key, non-creatable, non-modifiable
> volume-instance-uuid |  | uuid optional | This is the instance uuid of the vserver-scoped volume being moved. Attributes: non-creatable, non-modifiable
> vserver |  | vserver-name optional | This is the name of the vserver in which the volume being moved is part of. Attributes: key, non-creatable, non-modifiable

Element definition: volume-move-target-aggr-info | [top]

> 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

Element definition: volume-transition-log-record-info | [top]

> 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"

Element definition: volume-transition-volinfo | [top]

> 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.

Element definition: aggr-name | [top]

> Name of the aggregate

> [none]

Element definition: size | [top]

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

> [none]

Element definition: storage-service-id | [top]

> The Storage Service Identifier

> [none]

Element definition: storage-service-name | [top]

> The Storage Service Name

> [none]

Element definition: storage-service-type | [top]

> legacy|normal Possible values: "legacy" - No Support for Storage Services, "normal" - Support For Storage Services

> [none]

Element definition: uuid | [top]

> 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]

Element definition: volume-64bit-upgrade-attributes | [top]

> 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.

Element definition: volume-antivirus-attributes | [top]

> Information about Antivirus settings for the volume.

> Name | Range | Type | Description
> on-access-policy |  | string optional | The name of the Antivirus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Antivirus 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

Element definition: volume-attributes | [top]

> 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 Antivirus 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-hybrid-cache-attributes |  | volume-hybrid-cache-attributes optional | This field contains information on Flash Pool caching attributes on a volume
> volume-id-attributes |  | volume-id-attributes optional | This field contains identification information about the volume.
> volume-infinitevol-attributes |  | volume-infinitevol-attributes optional | This field contains information about the state of an Infinite 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-qos-attributes |  | volume-qos-attributes optional | This field contains the information that relates to QoS.
> 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-transition-attributes |  | volume-transition-attributes optional | This field contains information applying exclusively to transitioned or transitioning volumes.
> volume-vm-align-attributes |  | volume-vm-align-attributes optional | This field contains information related to the Virtual Machine alignment settings on a volume

Element definition: volume-autosize-attributes | [top]

> Information about autosize settings of the volume.

> Name | Range | Type | Description
> grow-threshold-percent | [0..100] | integer optional | Used space threshold which triggers autogrow. When the volume-info.size-used is greater than this percent of volume-info.size-total, the volume will be grown. The computed value is rounded down. The default value of this element varies from 85% to 98%, depending on the volume size. It is an error for the grow threshold to be less than or equal to the shrink threshold. Attributes: optional-for-create, modifiable
> increment-percent | [0..100] | integer optional | Using this value, the increment size will be computed as a percentage of the volume size at the time autosize was enabled. The default value is 5%. The increment-percent element is mutually exclusive with increment-size, and an error will be generated if both are specified. Attributes: optional-for-create, modifiable
> increment-size | [0..2^63-1] | integer optional | The increment size (in bytes) by which the volume would be grown. The default value is 5%. Increment-size and increment-percent are mutually exclusive, and an error will be generated if both are specified. Attributes: optional-for-create, modifiable
> is-enabled |  | boolean optional | This element is deprecated in Data ONTAP 8.2 and later. Please use autosize-mode instead. Setting this parameter to 'true' enables the 'grow' mode, while setting it to 'false' disables autosize and sets the autosize mode to 'off'. 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. The default value is 20% greater than the volume size at the time autosize was enabled. It is an error for the maximum volume size to be less than the current volume size. It is also an error for the maximum size to be less than or equal to the minimum size. Attributes: optional-for-create, modifiable
> minimum-size | [0..2^63-1] | integer optional | The minimum size (in bytes) below which the volume would not be shrunk automatically. The default value is the size of the volume at the time the 'grow_shrink' mode was enabled. It is an error for the minimum size to be greater than or equal to the maximum size. Attributes: optional-for-create, modifiable
> mode |  | string optional | The current mode of operation of volume autosize. Valid modes are 'off', 'grow', and 'grow_shrink'. The default mode is 'off'. Attributes: optional-for-create, modifiable Possible values: "off" , "grow" , "grow_shrink"
> reset |  | boolean optional | Resets the values of autosize, autosize-increment, max-autosize, min-autosize, autosize-shrink-threshold-percent, autosize-grow-threshold-percent and autosize-mode to their defaults. Attributes: non-creatable, modifiable
> shrink-threshold-percent | [0..100] | integer optional | The used space threshold below which autoshrink is triggered. When the volume-info.size-used is less than this percent of volume-info.size-total, the volume will be shrunk. The computed value is rounded down. The default shrink theshold is 50%. It is an error for the shrink threshold to be greater than or equal to the grow threshold. Attributes: optional-for-create, modifiable

Element definition: volume-clone-attributes | [top]

> Information about volume clones.

> Name | Range | Type | Description
> clone-child-count | [0..2^32-1] | 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.

Element definition: volume-directory-attributes | [top]

> 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
> 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 |  | string optional | This field contains the generation number of the root directory. Attributes: non-creatable, non-modifiable

Element definition: volume-export-attributes | [top]

> 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

Element definition: volume-flexcache-attributes | [top]

> 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
> min-reserve |  | size optional | The amount of space requested to be preallocated in the aggregate hosting the FlexCache volume. 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

Element definition: volume-hybrid-cache-attributes | [top]

> Information about the Flash Pool caching attributes of a volume.

> Name | Range | Type | Description
> eligibility |  | string optional | Flash Pool caching eligibility of a volume Possible values: 'read' ... Indicates that the volume cannot participate in write caching, 'read-write' ... Indicates that the volume can participate in read and write caching, Attributes: non-creatable, non-modifiable
> write-cache-ineligibility-reason |  | string optional | If the volume cannot participate in write caching, then this field explains the reason. Attributes: non-creatable, non-modifiable

Element definition: volume-id-attributes | [top]

> Identification information about a volume.

> Name | Range | Type | Description
> comment |  | string optional | A description for the volume. Range:[0..1023] 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
> style |  | string optional | The style of the volume. Possible values: 'flex' ... FlexVol, 'infinitevol' . Infinite Volume Default value is 'flex'. 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

Element definition: volume-infinitevol-attributes | [top]

> Information about the state of an Infinite Volume.

> Name | Range | Type | Description
> constituent-role |  | repos-constituent-role optional | This field specifies the role of a constituent within an Infinite Volume. This field is only supported for Infinite Volume constituents. Possible values: 'namespace' ... namespace constituent, 'data' ... data constituent, 'ns_mirror' ... namespace mirror constituent Attributes: optional-for-create, non-modifiable Possible values: "namespace" , "data" , "ols" , "ns_mirror"
> enable-snapdiff |  | boolean optional | Whether to enable Snapdiff. If enabled, the namespace mirrors will be created for Snapdiff use. The default value is false. Attributes: optional-for-create, modifiable
> is-managed-by-service |  | boolean optional | Specifies if the volume is managed by GUI services. The deafult value is false. Attributes: optional-for-create, modifiable
> max-data-constituent-size |  | size optional | The maximum size of each data constituent in bytes. The default value is determined by checking the maximum FlexVol size setting on all nodes used by the Infinite Volume. The smallest value found is chosen as the default for the max-data-constituent-size for the Infinite Volume. Attributes: optional-for-create, modifiable
> max-namespace-constituent-size |  | size optional | The maximum size of the namespace constituent. The default value is 10TB. Attributes: optional-for-create, modifiable
> namespace-mirror-aggr-list |  | aggr-name[] optional | Specifies an array of names of aggregates to be used for Infinite Volume Namespace Mirror constituents. If this input is not specified all the aggregates assigned to the Vserver are used. If the argument 'enable-snapdiff' is being set to 'true', and the Infinite Volume is managed by storage services, a value must be provided. Attributes: optional-for-create, modifiable
> storage-service |  | string optional | The name of the initial storage service for the Infinite Volume. This can only be provided if is-managed-by-service is true. Attributes: optional-for-create, modifiable

Element definition: volume-inode-attributes | [top]

> 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

Element definition: volume-language-attributes | [top]

> 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'). Volume language can be specified using 'language-code' parameter. Attributes: optional-for-create, 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

Element definition: volume-mirror-attributes | [top]

> 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

Element definition: volume-name | [top]

> 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]

Element definition: volume-performance-attributes | [top]

> 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
> fc-delegs-enabled |  | boolean optional | If true, FlexCache Read Delegations are turned on for this volume. On by default, only settable in Diag mode. 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

Element definition: volume-qos-attributes | [top]

> QoS policy group attached with a volume.

> Name | Range | Type | Description
> policy-group-name |  | string optional | The QoS policy group associated with this volume. This optionally specifies which QoS policy group to apply to the volume. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a volume, the system will not monitor and control the traffic to it. This parameter is not supported on Infinite Volumes. Attributes: optional-for-create, modifiable

Element definition: volume-security-attributes | [top]

> 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, 'unified' .Unified-style security, Unified UNIX, NFS and CIFS permissions (default for Infinite Volume) 'unix' ... Unix-style security (default for Flexible Volume) This field is only returned if this volume is online. If this field is empty ('') or not present for an online volume, this attribute isn't applicable to the volume. Infinite Volumes can only use the 'unified' security style. All other volumes cannot use the 'unified' security style. Attributes: optional-for-create, modifiable
> volume-security-unix-attributes |  | volume-security-unix-attributes optional | The Unix-oriented security settings associated with this volume.

Element definition: volume-sis-attributes | [top]

> 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
> deduplication-space-shared |  | size optional | The total disk space shared due to 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

Element definition: volume-snapshot-attributes | [top]

> 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-count | [0..255] | integer optional | Number of Snapshot copies in the volume. Attributes: non-creatable, non-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

Element definition: volume-snapshot-autodelete-attributes | [top]

> 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. If the null prefix is set, the string '(not specified)' is returned 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

Element definition: volume-space-attributes | [top]

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

> Name | Range | Type | Description
> filesystem-size | [0..2^63-1] | integer optional | Filesystem size (in bytes) of the volume. This is the total usable size of the volume, not including WAFL reserve. This value is the same as Size except for certain SnapMirror destination volumes. It is possible for destination volumes to have a different filesystem-size because the filesystem-size is sent across from the source volume. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
> 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: optional-for-create, 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 | Filesystem size (in bytes) of the volume. This is the total usable size of the volume, not including WAFL reserve. This field can not be set on Infinite Volumes that are managed by storage services. 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 or 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
> size-used-by-snapshots | [0..2^63-1] | integer optional | The size (in bytes) that is used by snapshots in the volume. 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-full-threshold-percent | [0..100] | integer optional | This field defines the used space threshold percentage at which EMS critical errors regarding the volume fullness will be generated. The default value is 98%. Setting this threshold to 0 disables the volume full space alerts. This field is valid only if this is a flexible volume and it is online. Attributes: non-creatable, 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 the volume is online. For data-cache volumes, this field is not returned. This field can not be set on Infinite Volumes that are managed by storage services. 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
> space-nearly-full-threshold-percent | [0..100] | integer optional | This field defines the used space threshold percentage at which EMS warnings regarding the volume fullness will be generated. The default value is 95%. Setting this threshold to 0 disables the volume nearly full space alerts. This field is valid only if this is a flexible volume and it is online. Attributes: non-creatable, modifiable

Element definition: volume-state-attributes | [top]

> 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. By default, this field is false. Attributes: non-creatable, non-modifiable
> is-constituent |  | boolean optional | This field indicates if this volume is a constituent within another volume. For an Infinite Volume, this field is true for all its constituents (namespace as well as data). This field is set to false for volumes which are not the constituents of an Infinite Volume. The default value 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-moving |  | boolean optional | Is the given volume moving? If true, this volume is moving from one aggregate to another aggregate in the cluster. The aggregates can be on different nodes of the cluster. Attributes: non-creatable, non-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-volume-in-cutover |  | boolean optional | Is the given volume move operation in cutover phase? If true, this volume is moving from one aggregate to another aggregate in the cluster and is in cutover phase. The aggregates can be on different nodes of the cluster. 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', 'mixed' If an Infinite Volumes constituents are not all in the same state, it will return 'mixed'. The 'mixed' state is read-only. Attributes: optional-for-create, modifiable

Element definition: volume-transition-attributes | [top]

> Information about the transition attributes of a volume.

> Name | Range | Type | Description
> is-copied-for-transition |  | boolean optional | Indicates whether the volume has been copied for copy based transition. Attributes: non-creatable, non-modifiable
> is-transitioned |  | boolean optional | Indicates whether the volume has gone through a transition operation at some point in the past. Attributes: non-creatable, non-modifiable
> transition-behavior |  | string optional | For an in progress transition, indicate what the behavior is. Possible values: 'none' ... No transition is in progress, 'data-move' ... Transition will follow volume move behavior. For example, Lun serial number is preserved, 'data-protection' ... Transition will follow a data protection relationship behavior. Attributes: non-creatable, non-modifiable

Element definition: volume-transition-log-attrs-info | [top]

> 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.

Element definition: volume-vm-align-attributes | [top]

> Information related to the Virtual Machine alignment settings on the volume.

> Name | Range | Type | Description
> vm-align-sector | [1..7] | integer optional | The Virtual Machine alignment 512 byte sector number. All files created with the suffix specified in the 'vm-align-suffix' input parameter will have zero-filled <512 * 'vm-align-sector'> bytes data at the beginning so that it's actual data starts at a different offset instead of zero. This is done so that the read & writes to such files are aligned to WAFL's 4k block boundary. Attributes: optional-for-create, non-modifiable
> vm-align-suffix |  | string optional | The Virtual Machine alignment suffix. The suffix such as '.xyz'. is used to identify the files which needs to be aligned. See the description for 'vm-align-sector' above for more information on this. Attributes: optional-for-create, non-modifiable

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: aggr-name | [top]

> Name of the aggregate

> [none]

Element definition: cache-policy | [top]

> Cache Policy Name

> [none]

Element definition: junction-path | [top]

> 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 Infinite Volume has the additional restriction of allowing only one element. An example of a valid FlexVol junction path is: '/user/my_volume'. An example of a valid Infinite Volume junction path is: '/repository'. Only one volume can be mounted at any given junction path.

> [none]

Element definition: language-code | [top]

> 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]

Element definition: repos-constituent-role | [top]

> Constituent Roles Possible values: "namespace" , "data" , "ols" , "ns_mirror"

> [none]

Element definition: size | [top]

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

> [none]

Element definition: uuid | [top]

> 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]

Element definition: volume-64bit-upgrade-attributes | [top]

> 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.

Element definition: volume-64bit-upgrade-check-attributes | [top]

> 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

Element definition: volume-antivirus-attributes | [top]

> Information about Antivirus settings for the volume.

> Name | Range | Type | Description
> on-access-policy |  | string optional | The name of the Antivirus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Antivirus 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

Element definition: volume-clone-parent-attributes | [top]

> 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

Element definition: volume-name | [top]

> 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]

Element definition: volume-security-unix-attributes | [top]

> 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 '0755' gives read/write/execute permissions to owner and read/execute 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

Element definition: uuid | [top]

> 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]