APIs in Category: volume | Vserver API version 1.15

volume-autosize-get volume-autosize-set volume-clone-create volume-clone-get volume-clone-get-iter volume-clone-split-estimate volume-clone-split-start volume-clone-split-status volume-clone-split-stop volume-container volume-create volume-destroy volume-get-iter volume-get-language volume-get-root-name volume-modify-iter volume-mount volume-move-target-aggr-get-iter volume-offline volume-online volume-options-list-info volume-rename volume-restrict volume-set-option volume-set-total-files volume-size volume-unmount

NetApp Manage ONTAP

volume-autosize-get | [top]

> Given the name of a flexible volume, get the autosize settings.

> Input Name | Range | Type | Description
> volume |  | string | The name of the flexible volume for which we want to get autosize.
> Output Name | Range | Type | Description
> increment-size |  | string optional | The increment size by which the volume would be grown, in kbytes.
> is-enabled |  | boolean | Is the vol autosize feature enabled on this volume?
> maximum-size |  | string | The maximum size to which the volume would be grown automatically, in kbytes.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-autosize-set | [top]

> Given the name of a flexible volume, set the autosize settings.

> Input Name | Range | Type | Description
> increment-size |  | string optional | Specify the flexible volume's increment size using the following format < number > [k|m|g|t] The amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of kilobytes desired.
> is-enabled |  | boolean optional | Is the vol autosize feature enabled?
> maximum-size |  | string optional | Specify the flexible volume's maximum allowed size using the following format < number > [k|m|g|t] The amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of kilobytes desired.
> volume |  | string | The name of the flexible volume for which we want to set autosize.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

volume-clone-create | [top]

> Create a flexible volume that is a clone of a "backing" or "parent" flexible volume. A clone is a volume that is a writable snapshot of another volume. Initially, the clone and its parent share the same storage; more storage space is consumed only as one volume or the other changes. If a specific snapshot name within the parent volume is provided, it is chosen as the parent snapshot. Otherwise, the filer will create a new, distinctively- named snapshot in the parent volume for that purpose. The parent snapshot is locked in the parent volume, preventing its deletion until the clone is either destroyed or split from the parent using the 'volume-clone-split-start' command (see below). This command fails if the chosen parent volume is currently involved in a split operation. This command also fails if the chosen parent volume is a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.

> Input Name | Range | Type | Description
> junction-active |  | boolean optional | This field indicates whether the mounted volume is accessible. The default is true. If the mounted junction path is not accessible, the volume does not appear in the owning virtual server's namespace. This field applies only to Cluster-Mode volumes.
> junction-path |  | string optional | The Junction Path at which this volume is to be mounted. The fully-qualified pathname in the owning vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An example of a valid junction path is: '/user/my_volume'. Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
> parent-snapshot |  | string optional | Name of the snapshot within 'parent-volume' that is to serve as the parent snapshot for the clone. If not provided, the filer will create a new snapshot named 'clone_parent_' (using a freshy-generated UUID) in 'parent-volume' for this purpose.
> parent-volume |  | string | Name of the parent flexible volume for the clone.
> space-reserve |  | string optional | Specifies the type of volume guarantee for the clone. Possible values: none, file, volume. If this argument is not provided, then guarantee type is inherited from parent volume.
> volume |  | string | Desired name of the clone.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTONLINE |  |
> EVOL_ALREADY_MOUNTED |  |
> EINVALIDINPUTERROR |  |
> ESNAPSHOTDOESNOTEXIST |  |
> ESNAPSHOTBUSY |  |
> EONTAPI_EEXIST |  |

> Vfiler-enabled
> Yes

volume-clone-get | [top]

> Display details of a specific FlexClone volume

> 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.
> volume |  | string | FlexClone Volume
> Output Name | Range | Type | Description
> attributes |  | volume-clone-info | The attributes of the volume.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTCLONE |  |

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

> Errno | Description
> EINTERNALERROR |  |

volume-clone-split-estimate | [top]

> Display an estimate of additional storage required in the underlying aggregate to perform a volume clone split operation. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.

> Input Name | Range | Type | Description
> volume |  | string | The name of the clone whose split usage is being estimated.
> Output Name | Range | Type | Description
> clone-split-estimate |  | clone-split-estimate-info[] | An estimate of the number of blocks required in the enclosing aggregate to split a clone from its parent.

> Errno | Description
> EONTAPI_ENOENT |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTCLONE |  |
> EVOLUMENOTONLINE |  |
> EVOLUMEINUSE |  |
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

volume-clone-split-start | [top]

> Begin the process by which the given clone is split off from its underlying parent volume and snapshot. New storage is allocated for the clone that is distinct from its parent. This process may take some time and proceeds in the background. Use the 'volume-clone-split-status' command to view the operation's progress. Both clone and parent volumes remain available during the process of splitting them apart. Upon completion, the snapshot on which the clone was based will be unlocked in the parent volume. Any snapshots in the clone are removed at the end of processing. Use the 'volume-clone-split-stop' command to stop this process. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes. In Data ONTAP Cluster-Mode, a job is created to perform the split operation. The job id of the job is returned in the API response. The progress of the job can be tracked using the job APIs.

> Input Name | Range | Type | Description
> volume |  | string | Name of the clone that we want split off from its parent volume and snapshot.
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | error code, if the operation caused an error.
> result-error-message |  | string optional | error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | The job id of the job that was queued to split the clone volume.
> result-status |  | string optional | The operation status. Possible values: "succeeded", "in-progress", "failed".

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTCLONE |  |
> EVOL_SCAN_INIT_FAILED |  |
> EVOL_CLONE_BEING_SPLIT |  |

> Vfiler-enabled
> Yes

volume-clone-split-status | [top]

> Display the progress in separating clones from their underlying parent volumes and snapshots. If a clone name is specified, then the split status for that clone is provided. If no clone name is provided, then status is provided for all clones currently being split. This command fails if applied to a traditional volume, and EONTAPI_EVOLNOTFLEX is thrown. Cloning is a capability that applies exclusively to flexible volumes. This command fails if the volume specified is not a clone, and EVOLNOTCLONE is thrown. This command fails if the volume specified is not being split, and EVOLOPNOTUNDERWAY is thrown.

> Input Name | Range | Type | Description
> volume |  | string optional | The name of the clone being split off from its parent volume and snapshot for which we want status.
> Output Name | Range | Type | Description
> clone-split-details |  | clone-split-detail-info[] optional | List of clones that are currently being split from their parent volumes, along with all relevant status information.

> Errno | Description
> EONTAPI_ENOENT |  |
> EVOLUMEDOESNOTEXIST |  |
> EONTAPI_EVOLNOTFLEX |  |
> EVOLNOTCLONE |  |
> EVOLOPNOTUNDERWAY |  |
> EVOLUMENOTONLINE |  |
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

volume-clone-split-stop | [top]

> Stop the process of splitting off a clone from its parent volume and snapshot. All of the blocks that were formerly shared between the given clone and its parent volume that have already been split off will remain that way. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.

> Input Name | Range | Type | Description
> volume |  | string | The name of the clone for which we want to stop the process of being split off from its parent volume and snapshot.

> Errno | Description
> EONTAPI_ENOENT |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLNOTCLONE |  |
> EVOLOPNOTUNDERWAY |  |
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

volume-container | [top]

> Return the name of the containing aggregate for the named flexible volume.

> Input Name | Range | Type | Description
> volume |  | string | The name of the flexible volume for which we want the containing aggregate.
> Output Name | Range | Type | Description
> containing-aggregate |  | string | Name of the given volume's containing aggregate, if applicable.

> Errno | Description
> EONTAPI_ENOENT |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-create | [top]

> Create a volume. The maximum number of volumes (traditional or flexible in any combination) on a filer is determined by the amount of main memory. All filers with less than 8GB of memory can support a maximum of 200 volumes, and all others can support a maximum of 500 volumes. The detailed behavior of this API depends on where it is received: 1. In Data ONTAP Cluster-Mode, create a new flexible volume. 2. In Data ONTAP 7-Mode, create a new flexible, traditional, or sparse volume with the given name and characteristics. Freshly-created traditional volumes may not be operational immediately after the API returns. Use 'volume-list-info' to obtain information about volumes, including the status of the newly-created traditional volume in order to determine when it is fully operational.

> Input Name | Range | Type | Description
> antivirus-on-access-policy |  | string optional | The name of the Anti-Virus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
> containing-aggr-name |  | string optional | Flexible volumes only. The name of the aggregate in which to create the new flexible volume. If provided, this argument must be accompanied by the "size" parameter described below. This input is required for creating a Cluster-Mode volume.
> export-policy |  | string optional | The name of the Export Policy to be used by NFS/CIFS protocols. The default policy name is 'default'.
> flexcache-cache-policy |  | string optional | The name of the FlexCache 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.
> flexcache-fill-policy |  | string optional | The name of the FlexCache prefill 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.
> flexcache-origin-volume-name |  | string 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.
> group-id | [0..2^32-1] | integer optional | The UNIX group ID for the volume. The default value is 0 ('root').
> index-dir-enabled |  | boolean optional | If true, index directory format is enabled. Default: false.
> is-junction-active |  | boolean optional | This field indicates whether the mounted volume is accessible. The default is true. If the mounted junction path is not accessible, the volume does not appear in the owning virtual server's namespace. This field applies only to Cluster-Mode volumes.
> is-nvfail-enabled |  | string 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.
> 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.
> junction-path |  | string optional | The Junction Path at which this volume is to be mounted. The fully-qualified pathname in the owning vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's namespace. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An example of a valid junction path is: '/user/my_volume'. Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
> max-dir-size | [0..2^63-1] | integer optional | The maximum size (in bytes) to which any directory in this volume can grow. For 7-Mode volumes, the default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 300,000 files. For Cluster-Mode volumes, the default setting is 100 MBytes and it allows the directory to hold up to approximately 3,000,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.
> max-write-alloc-blocks | [0..2048] | integer optional | The maximum number of blocks used for write allocation. This feature is deprecated.
> size |  | string optional | Flexible volumes only. The initial size of the new flexible volume. The format to use is: < number > k|m|g|t where "k" means kilobytes, "m" means megabytes, "g" means gigabytes, and "t" means terabytes. If provided, this argument must be accompanied by the "containing-aggr-name" parameter described above.
> 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.
> space-reserve |  | string optional | Specifies the type of volume guarantee the new volume will use. Possible values: none, file, volume. If this argument is not provided, the default volume guarantee type is volume.
> unix-permissions |  | string optional | Unix permission bits in octal string format. It's similar to Unix style permission bits: In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users. In Data ONTAP Cluster-Mode, for security style "mixed" or "unix", the default setting of '0700' gives read/write/execute permissions to owner and no permissions to group and other users. For security style "ntfs", the default setting of '0000' gives no permissions to owner, group and other users. It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
> user-id | [0..2^32-1] | integer optional | The UNIX user ID for the volume. The default value is 0 ('root').
> volume |  | string | Name of the volume to create. The volume name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore. In Data ONTAP Cluster-Mode, the volume names must be unique within a Vserver. In Data ONTAP 7-mode, the volume names must be unique on a controller.
> volume-comment |  | string optional | A description for the volume being created.
> volume-security-style |  | string optional | The security style associated with this volume. Possible values: 'mixed' ... Mixed-style security, 'ntfs' ... NTFS/Windows-style security, 'unix' ... Unix-style security (default setting) Security styles don't apply to GX-striped data volumes.
> volume-state |  | string optional | Desired state of the volume after it is created. Possible values: 'online', 'restricted', 'offline'
> volume-type |  | string optional | The type of the volume to be created. Possible values: "rw" - read-write volume (default setting), "ls" - load-sharing volume, "dp" - data-protection volume, "dc" - data-cache volume (FlexCache)

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMENAMEINVALID |  |
> EVOLUMERGSIZEINVALID |  |
> EINVALIDINPUTERROR |  |
> EVOLUMELANGUAGEINVALID |  |
> EVOLUMEDISKSIZEINVALID |  |
> EVOLUMEDISKDUP |  |
> ESERVICENOTLICENSED |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EVOLALREADYMOUNTED |  |
> EONTAPI_EWORMNOCLOCK |  |

volume-destroy | [top]

> Destroy the specified volume or plex. If a flexible volume is specified, all of its blocks are freed and returned to its containing aggregate; no other flexible volumes in the same containing aggregate (if any) are affected. If a traditional volume is specified, all of its plexes are destroyed, and its disks are returned to the appropriate spare pool(s). If a plex is specified, it must be for a mirrored aggregate (which could potentially be embedded in a traditional volume), leaving it unmirrored. Only offline volumes and plexes can be destroyed. Plexes are not supported for Cluster-Mode volumes.

> Input Name | Range | Type | Description
> name |  | string | Name of an existing volume or plex.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEPLEXINVALID |  |
> EVOLUME_HAS_VFILER_STORAGE |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |
> EOP_DISALLOWED_ON_CLONE_PARENT |  |

> Vfiler-enabled
> Yes

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

> Errno | Description
> EINTERNALERROR |  |

volume-get-language | [top]

> Get the given volume's language mapping.

> Input Name | Range | Type | Description
> volume |  | string | Name of the volume for which we want the language mapping.
> Output Name | Range | Type | Description
> language |  | string | Set to the volume's language mapping, in the form "LanguageCode (Full Name)" (e.g. "en_US (English (US))"). For more information on these values, see 'volume-create'.
> language-code |  | string | Set to the volume's language code, suitable for use as an argument to other functions (e.g. "en_US"). For more information on these values, see 'volume-create'.
> nfs-character-set |  | string | 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"
> oem-character-set |  | string | 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 NFS character set is as follows: "cp437|cp437|Thu Oct 1 15:00:53 PDT 1998"

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMENOTONLINE |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-get-root-name | [top]

> Return the name of the "root" volume on the filer. If this request is executed in the context of a vfiler, the "root" volume of the vfiler will be returned. If this request is executed in the context of a vserver the "namespace root" volume of the vserver will be returned. If the "namespace root" volume of the Admin Vserver is requested, EVSERVER_OP_NOT_ALLOWED will be returned.

> Output Name | Range | Type | Description
> volume |  | string | Name of the root volume for the filer.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |

> Vfiler-enabled
> Yes

volume-modify-iter | [top]

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

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

> Errno | Description
> EINTERNALERROR |  |

> License
> Striped_Volume

volume-mount | [top]

> Mount a volume on another volume (parent) with a junction-path.

> Input Name | Range | Type | Description
> activate-junction |  | boolean optional | This field optionally specifies whether the mounted volume is accessible. The default is true. If the mounted path is not accessible, it does not appear in the owning Vserver's namespace.
> export-policy-override |  | boolean optional | This field optionally specifies whether the parent volume's export policy overrides the mounted volume's Export Policy. The default is false.
> junction-path |  | string | The fully-qualified pathname in the owning Vserver's namespace at which this volume is mounted. The pathname is case insensitive and must be unique within a Vserver's context. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames, this string must begin with '/'. In addition, it must not end with '/'. An example of a valid junction path is: '/user/my_volume'. Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If this volume is mounted at a different junction path, or if another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
> volume-name |  | string | The name of the volume.

> Errno | Description
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |
> EVOL_ALREADY_MOUNTED |  |
> EVOL_MOUNT_FAILED |  |
> EJUNCTION_CREATE_FAILED |  |

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

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

volume-offline | [top]

> Take the specified volume or plex offline, making it unavailable for both user-level data access and RAID-level access (unless it's a flexible volume, at which time its containing aggregate is not affected in any way, and will remain fully online). The operation takes effect before the API returns except in maintenance mode, when the current root volume may not be taken offline. A volume marked to become the root cannot be taken offline. Taking a flexible volume offline does not affect its containing aggregate in any way. A number of operations being performed on the given volume (or its containing aggregate) can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files on the volume opened by internal ONTAP processes. The command is aborted if any are found. Plexes are not supported for Cluster-Mode volumes.

> Input Name | Range | Type | Description
> name |  | string | Name of an existing volume or plex. If a volume contains CIFS shares, users should be warned before taking the volume offline. Use "cifs-delay" to specify number of seconds to wait. If a plex is specified, the plex must be part of a mirrored volume, and both plexes must be online. Prior to offlining a plex, the system will flush all internally-buffered data associated with the plex and create a snapshot that is written out to both plexes. The snapshot allows for efficient resynchronization when the plex is subsequently brought back online.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMECIFSTERMINATE |  |
> EVOLUMEBUSY |  |
> EVOLUMEOFFLINE |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-online | [top]

> Bring the specified volume or the plex online. This command takes effect immediately. If there are CIFS shares associated with the volume, they are enabled. Plexes are not supported for Cluster-Mode volumes.

> Input Name | Range | Type | Description
> name |  | string | Name of an existing volume or plex. If a volume is specified, it must be currently offline, restricted, or foreign. If the volume is foreign, it will be made native before being brought online. A ``foreign'' volume is a traditional volume that consists of disks moved from another filer and that has never been brought online on the current filer. Traditional volumes that are not foreign are considered ``native.'' If the volume is inconsistent, but has not lost data, it is advisable to run WAFL_check or wafliron (or do a 'snapmirror initialize' in case of a replica volume) prior to bringing an inconsistent volume online. Bringing an inconsistent volume online increases the risk of further file system corruption. If the volume is inconsistent and has experienced possible loss of data, it cannot be brought online unless WAFL_check or wafliron (or 'snapmirror initialize') has been run on the volume. If a plex is specified, the plex must be part of an online mirrored traditional volume or aggregate. The system will initiate resynchronization of the plex as part of online processing.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEPLEXINVALID |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |
> EVOLUME_UNSUPPORTED_OPTION_VMALIGN |  |

> Vfiler-enabled
> Yes

volume-options-list-info | [top]

> Get the options that have been set for the specified volume.

> Input Name | Range | Type | Description
> volume |  | string | Name of the existing volume for which we want option information.
> Output Name | Range | Type | Description
> options |  | volume-option-info[] | List of options set for this volume.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-rename | [top]

> Renames the specified volume to a new name specified by "new-volume-name". If the volume is referenced in the /etc/exports file, remember to make the name change in /etc/exports also so that the affected file system can be exported by the filer after the filer reboots. The "volume-rename" command does not automatically update the /etc/exports file.

> Input Name | Range | Type | Description
> new-volume-name |  | string | New volume name.
> volume |  | string | Name of an existing volume.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMENAMEINVALID |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-restrict | [top]

> Restrict the specified volume, making it unavailable for user-level data access but leaving it (or its containing aggregate, if it's a flexible volume) available to internal OnTAP RAID-level access.

> Input Name | Range | Type | Description
> name |  | string | Name of the volume to restrict.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMECIFSTERMINATE |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-set-option | [top]

> Set the option named 'option-name' to the value specified by 'option-value' in the specified volume. The change remains effective even after the filer is rebooted. Some options have values that are numbers or strings, and others have values that are 'on' (also expressible as 'yes', 'true', or '1' ) or "off" (also expressible as 'no', 'false', or '0'). A mixture of uppercase and lowercase characters may be used for an option's value. Note that the 'root' option is special in that it does not have an associated value. Also, note that some of these options can NOT be set for a flexible volume, as they relate only to aggregates (either free-standing ones or those embedded in traditional volumes). Other options may only apply for flexible volumes.

> Input Name | Range | Type | Description
> option-name |  | string | Name of the option to be set. Possible values: "convert_ucode" (value: "on" | "off") Setting this option to "on" forces conversion of all directories to UNICODE format when accessed from both NFS and CIFS. By default, it is set to "off", in which case access from CIFS causes conversion of pre-4.0 and 4.0- format directories. Access from NFS causes conversion of 4.0 format directories. This option cannot be set on a Cluster-Mode volume unless it was transitioned from 7-Mode. "snapshot_clone_dependency" (value: "on" | "off") Setting this option "on" will unlock all initial and intermediate backing snapshots for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked. If the option is "off" the backing snapshot will remain locked until all intermediate backing snapshots are deleted. This option is not valid for a Cluster-Mode volume. "create_reserved" This option is no longer supported. "create_ucode" (value: "on" | "off") Setting this option to "on" forces UNICODE format directories to be created by default, both from NFS and CIFS. The default value is "off", in which case all directories are created in pre-4.0 format and only converted to UNICODE format upon the first CIFS access. This option cannot be set on a Cluster-Mode volume. "extent" (value: "on" | "space_optimized" | "off") Setting this option to "on" 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. Using extents may help workloads that perform many small random writes followed by large sequential reads. However, using extents may increase the amount of disk operations performed on the filer, so this option should only be used where applicable. The default value is "off", in which case extents are not used. The value "space_optimized" indicates extent updates will not duplicate snapshot blocks into the active file system, thereby using space conservatively. The "space_optimized" value may result in degraded snapshot read performance; and may only be used for flexible volumes. "fractional_reserve" (value: < number >) This option decreases the amount of space reserved for overwrites of reserved objects (LUNs, files) in a volume. The option is set to 100 by default and indicates that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites. The value can vary from 0 to 100. Using a value of less than 100 indicates what 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. "fs_size_fixed" (value: "on" | "off") Setting this option to "on" causes the file system to remain the same size (and not grow) when a SnapMirror relationship is broken, or when a "vol/aggr add" is performed on it. This option is automatically set to be "on" when a volume becomes a SnapMirrored. It remains "on" after the "snapmirror break" command is issued for the volume. This option allows a volume to be SnapMirrored back to the source without needing grow the source volume. If the volume size is larger than the file system size, turning off this option forces the file system to grow to the size of the volume. "guarantee" (value: "none" | "file" | "volume") Flexible volumes only. Setting this option controls the type of space reservation for the named flexible volume. There are three possible settings. The first, "none", provides no guarantee that there will be enough blocks in the containing aggregate to meet the flexible volume's needs. The second, "file", guarantees there will be enough blocks in the containing aggregate to meet the needs of the specified files in the flexible volume. The third, "volume", is the default setting and guarantees there will be enough blocks available in the containing aggregate to meet the entire flexible volume's needs. An error will be returned if an attempt is made to set this option on a traditional volume. "ignore_inconsistent" (value: "on" | "off") This option can only be set in maintenance mode. If set to "on", then the root volume may be brought online when booting even if it is marked as inconsistent. The user is cautioned that bringing it online prior to running WAFL_check or wafliron may result in further file system inconsistency. "maxdirsize" (value: < number >) Set the maximum size (in KBytes) to which any directory can grow. The default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 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 option's setting. This option 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. "max_write_alloc_blocks" (value: < number >) Set the maximum number of blocks used for write allocation. The default setting, 0, uses the system-wide default number of blocks, which should be optimal for most users. Some sequential read workloads may benefit from increasing this value. On rare occasions, some multi-stream sequential write workloads may benefit from decreasing this value. Range: [0..2048]. "minra" (value: "on" | "off") Setting this option to "on" causes the filer to perform minimal read-ahead on this volume. By default, this option is "off", causing the filer to perform very aggressive read-ahead on the volume. "no_atime_update" (value: "on" | "off") Setting this option to "on" prevents the update of inode access times when a file is read. This option 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. It should be used carefully. That is, use this option when you know in advance that the correct access time for inodes will not be needed for files on that volume. "no_i2p" (value: "on" | "off") Setting this option to "on" disables inode to parent pathname translations on the volume. The default setting is off. "nosnap" (value: "on" | "off") Setting this option to "on" disables automatic snapshots on the volume. This option is not supported for Cluster-Mode volumes. "nosnapdir" (value: "on" | "off") Setting this option to "on" disables the visible .snapshot directory that is normally present at system internal mount points. It also turns off access to all other .snapshot directories in the volume. "nvfail" (value : "on" | "off") If this option is on, the filer performs additional work at boot time if it finds that there has been any potential data loss due to an NVRAM failure. In such situations, 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 filer sends error messages to the console whenever such problems are found. "raid_cv" (value: "on" | "off") Traditional volumes only. Setting the option to "off" disables block checksum protection on the volume. The default is "on". The user is cautioned that turning off the option exposes the filesystem to inconsistency that could be caused by a misbehaving hardware component in the system. "raid_zoned" (value: "on" | "off") Traditional volumes only. Setting the option to "off" disables zoned checksum protection on the volume. The default is "on". The user is cautioned that turning off the option exposes the filesystem to inconsistency that could be caused by a misbehaving hardware component in the system. "raidsize" (value: < number >) Traditional volumes only. The maximum size of a RAID group within the traditional volume. Changing this option doesn't cause existing RAID groups to grow or shrink. Rather, it only affects whether more disks will be added to the last existing RAID group in the future, and how large new RAID groups will be. "raidtype" (value: "raid4" | "raid_dp") Traditional volumes only. The type of RAID group used for this traditional volume. The "raid4" setting provides one parity disk per RAID group, while "raid_dp" provides two. Changing this option immediately changes the RAID group type for all RAID groups in the traditional volume. When upgrading RAID groups from "raid4" to "raid_dp", each RAID group begins reconstruction onto a spare disk allocated for the second "dparity" parity disk. "read_realloc" (value: "on" | "space_optimized" | "off") Setting this option to "on" enables read-reallocation in the volume. This causes application reads to optimize the layout of parts of a file or LUN after the data has been read from disk and is in the appliance memory. The default value is "off", in which case read-reallocate is not used. The value "space_optimized" indicates read-reallocate updates will not duplicate blocks into the active file system, thereby using space conservatively. The "space_optimized" value may result in degraded snapshot read performance; and may only be used for flexible volumes. "resyncsnaptime" (value: < number >) Traditional volumes only. Sets the RAID mirror resynchronization snapshot frequency to be the given number of minutes. The default value is '60' (minutes). "root" (value: < none >) The specified volume is to become the root volume for the filer on the next reboot. This option can be used on only one volume at any given time. The existing root volume will become a non-root volume after the reboot. Until the system is rebooted, the current root volume will continue to show 'root' as one of its options, and the new root volume will show 'diskroot' as an option. In general, the volume that has the 'diskroot' option value is the one that becomes the root volume following the next reboot. The only way to remove the root status of a volume is to set it on another one. "schedsnapname" (value: "create_time" | "ordinal") Setting the option to "ordinal" causes scheduled snapshots to be named in the hourly.n name format. Setting the value to "create_time" causes snapshots to use a hourly.yyyy-mm-dd_hhmm name format instead. The default is "ordinal". "snapmirrored" (value : "off") If SnapMirror is enabled, the filer automatically sets this option to "on". Set this option to "off" if SnapMirror should no longer be used to update the mirror. After setting this option to "off", the mirror becomes a regular writable volume. This option can only be set to "off" with this interface. Only the filer can change this option's value from "off" to "on". This option is not settable in Data ONTAP Cluster-Mode. Use "snapmirror-break" API instead. "try_first" (value : "volume_grow" | "snap_delete") If the flexible volume is configured to automatically reclaim space if the volume is running out of space, then setting this option to "volume_grow" will cause the volume to increase in size before deleting snapshots. If the option was set to "snap_delete", snapshots will be deleted before the volume size is increased. "svo_enable" (value: "on" | "off") Setting this option to "on" enables SnapValidator functionality on this volume. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode. "svo_allow_rman" (value: "on" | "off") Setting this option to "on" enables SnapValidator functionality on this volume to allow this volume to contain Oracle RMAN backup data. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode. "svo_checksum" (value: "on" | "off") Setting this option to "on" enables SnapValidator checksumming of all writes to this volume. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode. "svo_reject_errors" (value: "on" | "off") Setting this option to "on" enables SnapValidator functionality to reject any write to the volume which fails the SnapValidator checks. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode. "thorough_scrub" (value: "on" | "off") Traditional volumes only. Setting the option to "on" enables thorough scrub on a block checksum volume. That means that a scrub will initialize any zeroed checksum entries that it finds. If there are any checksum entries to be initialized, scrub will run slower than normal. "snaplock_autocommit_period" (value: "none" | h|d|m|y) SnapLock volumes only. This option defines the criteria for committing files to WORM on a SnapLock volume by the autocommit scanner. h, d, m, y denote hours, days, months and years respectively. The default value of this option is "none" that corresponds to autocommit being disabled in the SnapLock volume. The minimum autocommit period on a SnapLock volume is 2h. Any valid value other than "none", specified in hours (h), days (d), months (m) or years (y) would trigger the autocommit scanner on the Snaplock volume. "snaplock_default_period" (value : min | max | infinite | s|h|d|m|y) This option can be set only for SnapLock volumes and specifies the default retention period that will be applied to files committed to WORM state without an associated retention period. If this option value is min then snaplock_minimum_period is used as the default retention period. If this option value is max then snaplock_maximum_period is used as the default retention period. If this option value is infinite then infinite retention period will be used as the default retention period. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file "snaplock_maximum_period" (value: infinite | s|h|d|m|y) This option can be set only for SnapLock volumes and specifies the maximum allowed retention period for files committed to WORM state on the volume. Any file committed with a retention period longer than snaplock_maximum_period will be assigned a retention period equal to snaplock_maximum_period. If this option value is infinite then files can be committed for infinite retention period in the volume. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file "snaplock_minimum_period" (value: infinite | s|h|d|m|y) This option can only be set for SnapLock volumes and specifies the minimum allowed retention period for files committed to WORM state on the volume. Any file committed with a retention period shorter than snaplock_minimum_period will be assigned a retention period equal to snaplock_minimum_period. If this option value is infinite then every file committed to the volume will have a infinite retention period. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file
> option-value |  | string | The value to set the named option (except for option 'root', which has no associated value).
> volume |  | string | Name of the volume for which we want to set an option.

> Errno | Description
> EINTERNALERROR |  |
> ESWAPFILENOSPACE |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |
> EONTAPI_EVOLOPNOTSUPP |  |

> Vfiler-enabled
> Yes

volume-set-total-files | [top]

> Set a volume's 'files-total' value to the given quantity. This specifies the maximum number of user-visible files that the given volume can hold, as reported by the 'files-total' value within: - the 'volumes' output parameter of the Data ONTAP 7-Mode 'volume-list-info' API, and - the 'attributes-list' output parameter of the Data ONTAP Cluster-Mode 'volume-get-iter' API. Note that this interface corresponds to the following Data ONTAP 7-Mode 'maxfiles' console command and Data ONTAP Cluster-Mode 'volume modify' console command: 'maxfiles <vol-name> <requested_new_max>' 'volume modify -vserver <vserver-name> -volume <volume-name%gt -files <requested_new_max>'

> Input Name | Range | Type | Description
> force |  | boolean optional | Indicates whether the filer should reject a legal but "unreasonable" (seemingly too large) value for 'requested-total-files', or accept it without question. By default, legal but "unreasonable" values are rejected.
> requested-total-files |  | integer validate | Specifies the new value for the volume's 'files-total' field. This value must be larger than the volume's current 'files-total' value, and can never be larger than the number of 4KB blocks in the volume. The filer may actually choose a smaller value so as to comply with certain internal accounting and alignment requirements. Once this value has been increased for a volume, it cannot be reduced below the value of 'inodefile-public-capacity' for that volume. Range : [0..2^31-1]
> volume |  | string | The name of the volume whose 'files-total' field we wish to set. The chosen volume must be online and not read-only for this operation to succeed.
> Output Name | Range | Type | Description
> resulting-total-files |  | integer | The quantity to which the given volume's 'files-total' field was actually set after all internal requirements and alignments were computed. This quantity will never be larger than 'requested-total-files', and never be smaller than the volume's 'inodefile-public-capacity' value before the request. Range : [0..2^31-1]

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVEROPNOTALLOWED |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-size | [top]

> Given the name of a flexible volume, either return its current size or set the volume's size to the stated amount.

> Input Name | Range | Type | Description
> new-size |  | string optional | Specify the flexible volume's new size using the following format: [+|-]< number > k|m|g|t] If a leading '+' or '-' appears, it indicates that the given flexible volume's size is to be increased or decreased (respectively) by the indicated amount, else the amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of kilobytes desired. The file system size of a readonly replica flexible volume, such as a snapmirror destination, is determined from the replica source. In such cases, the value set using "volume-size" is interpreted as an upper limit on the size. A flexible volume that's not a readonly replica which has the "fs_size_fixed" option set may have its size displayed, but not changed. Attempting to set the volume size in this case will result in failure and a EINTERNALERROR error code. Users must be able to adjust readonly replica flexible volume size in order to maintain enough capacity to accommodate transfers from the replica source. Attempting to set a readonly replica destination size to be less than that of its source will result in a failure indicated by the EONTAPI_ENOSPC error code.
> volume |  | string | The name of the flexible volume for which we want to get or set its size.
> Output Name | Range | Type | Description
> is-fixed-size-flex-volume |  | boolean optional | Is the flexible volume filesystem size fixed?
> is-readonly-flex-volume |  | boolean optional | Is this flexible volume read only?
> is-replica-flex-volume |  | boolean optional | Is this flexible volume a replica volume?
> volume-size |  | string | Either the size we found the given volume to be or the size to which the volume was set (if we're setting its size via the 'new-size' argument above).

> Errno | Description
> EINTERNALERROR |  |
> EONTAPI_ENOSPC |  |
> EVOLUMEBUSY |  |
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EINVALIDINPUTERROR |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |

> Vfiler-enabled
> Yes

volume-unmount | [top]

> Unmount a volume from its parent volume and delete the junction path at which the volume is mounted.

> Input Name | Range | Type | Description
> force |  | boolean optional | This specifies whether the volume unmount operation is forced or not. The default value is false. Under certain circumstances, such as an unexpected reboot while in the middle of unmounting, the unmount operation might find that after the reboot, it is unable to delete the junction path at which the volume is mounted in the file system. In this situation, if the force option is set to false, the unmount operation is failed (EJUNCTIONDELETEFAILED), leaving the junction path information intact in the Volume Management Database. Instead, if the force option is set to true, the unmount operation proceeds to delete the junction path information in the Volume Management Database, irrespective of any failure to delete the junction path in the file system.
> volume-name |  | string | The name of the volume.

> Errno | Description
> EVSERVERNOTFOUND |  |
> EVSERVER_OP_NOT_ALLOWED |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTNOTFOUND |  |
> EMULTIPLEVOLSFOUND |  |
> EVOL_NOT_MOUNTED |  |
> EVOL_UNMOUNT_FAILED |  |
> EJUNCTION_DELETE_FAILED |  |

Element definition: clone-split-detail-info | [top]

> Status information about an active clone split.

> Name | Range | Type | Description
> blocks-scanned |  | integer | Number of the clone's blocks that have been scanned to date by the split.
> blocks-updated |  | integer | Total number of the clone's blocks that have been updated to date by the split.
> inode-percentage-complete |  | integer | Percent of the clone's inodes processed to date by the split.
> inodes-processed |  | integer | Number of the clone's inodes processed to date by the split.
> inodes-total |  | integer | Total number of inodes in the clone.
> name |  | string | Name of the clone being split.

Element definition: clone-split-estimate-info | [top]

> Estimate information about a future clone split.

> Name | Range | Type | Description
> estimate-blocks |  | integer | The estimated number of 4kb blocks required to perform the volume clone split.

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 Anti-Virus On-Access settings for the volume.
> volume-autosize-attributes |  | volume-autosize-attributes optional | This field contains information about the autosize settings of the volume.
> volume-clone-attributes |  | volume-clone-attributes optional | This field contains information applying exclusively to clone volumes.
> volume-directory-attributes |  | volume-directory-attributes optional | This field contains information related to directories in a volume.
> volume-export-attributes |  | volume-export-attributes optional | This field contains information about export settings of the volume.
> volume-flexcache-attributes |  | volume-flexcache-attributes optional | This field contains information applying exclusively to flexcache volumes.
> volume-id-attributes |  | volume-id-attributes optional | This field contains identification information about the volume.
> volume-inode-attributes |  | volume-inode-attributes optional | This field contains information about inodes in a volume.
> volume-language-attributes |  | volume-language-attributes optional | This field contains information about volume language-related settings.
> volume-mirror-attributes |  | volume-mirror-attributes optional | This field contains information applying exclusive to volume mirror.
> volume-performance-attributes |  | volume-performance-attributes optional | This field contains information that relates to the performance of the volume.
> volume-security-attributes |  | volume-security-attributes optional | This field contains information about volume security settings.
> volume-sis-attributes |  | volume-sis-attributes optional | This field contains information about Deduplication, file clone, compression, etc.
> volume-snapshot-attributes |  | volume-snapshot-attributes optional | This field contains information applying exclusively to all the snapshots in the volume. Volume disk space-related settings are excluded.
> volume-snapshot-autodelete-attributes |  | volume-snapshot-autodelete-attributes optional | This field contains information about snapshot autodelete policy settings.
> volume-space-attributes |  | volume-space-attributes optional | This field contains information related to volume disk space management including on-disk layout.
> volume-state-attributes |  | volume-state-attributes optional | This field contains information about the state or status of a volume or its features.
> volume-striping-attributes |  | volume-striping-attributes optional | This field contains information applying exclusively to striped volumes.

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
> size | [0..2^63-1] | integer optional | FlexClone Size Attributes: non-creatable, non-modifiable
> space-guarantee-enabled |  | boolean optional | Space Guarantee In Effect Attributes: non-creatable, non-modifiable
> space-reserve |  | string optional | Space Guarantee Style Attributes: optional-for-create, non-modifiable Possible values: "none" , "volume" , "file"
> split-estimate |  | integer optional | Split Estimate Attributes: non-creatable, non-modifiable
> state |  | string optional | FlexClone Volume State Possible values are: 'online', 'offline', 'restricted'. Attributes: non-creatable, non-modifiable
> used | [0..2^63-1] | integer optional | Used Size Attributes: non-creatable, non-modifiable
> volume |  | string optional | FlexClone Volume Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Vserver Name Attributes: key, non-creatable, non-modifiable

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-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-option-info | [top]

> Option key and value.

> Name | Range | Type | Description
> name |  | string | Option key.
> value |  | string | Option value.

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: 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 Anti-Virus settings for the volume.

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

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 Anti-Virus On-Access settings for the volume.
> volume-autosize-attributes |  | volume-autosize-attributes optional | This field contains information about the autosize settings of the volume.
> volume-clone-attributes |  | volume-clone-attributes optional | This field contains information applying exclusively to clone volumes.
> volume-directory-attributes |  | volume-directory-attributes optional | This field contains information related to directories in a volume.
> volume-export-attributes |  | volume-export-attributes optional | This field contains information about export settings of the volume.
> volume-flexcache-attributes |  | volume-flexcache-attributes optional | This field contains information applying exclusively to flexcache volumes.
> volume-id-attributes |  | volume-id-attributes optional | This field contains identification information about the volume.
> volume-inode-attributes |  | volume-inode-attributes optional | This field contains information about inodes in a volume.
> volume-language-attributes |  | volume-language-attributes optional | This field contains information about volume language-related settings.
> volume-mirror-attributes |  | volume-mirror-attributes optional | This field contains information applying exclusive to volume mirror.
> volume-performance-attributes |  | volume-performance-attributes optional | This field contains information that relates to the performance of the volume.
> volume-security-attributes |  | volume-security-attributes optional | This field contains information about volume security settings.
> volume-sis-attributes |  | volume-sis-attributes optional | This field contains information about Deduplication, file clone, compression, etc.
> volume-snapshot-attributes |  | volume-snapshot-attributes optional | This field contains information applying exclusively to all the snapshots in the volume. Volume disk space-related settings are excluded.
> volume-snapshot-autodelete-attributes |  | volume-snapshot-autodelete-attributes optional | This field contains information about snapshot autodelete policy settings.
> volume-space-attributes |  | volume-space-attributes optional | This field contains information related to volume disk space management including on-disk layout.
> volume-state-attributes |  | volume-state-attributes optional | This field contains information about the state or status of a volume or its features.
> volume-striping-attributes |  | volume-striping-attributes optional | This field contains information applying exclusively to striped volumes.

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

> Information about autosize settings of the volume.

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

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

> Information about volume clones.

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

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

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
> 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-id-attributes | [top]

> Identification information about a volume.

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

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'). Attributes: non-creatable, non-modifiable
> nfs-character-set |  | string optional | The NFS language mapping character set that is currently in effect for the volume. This field is of the following format: '<nfs-character-set>|<display-name>|<asctime>' Note that '|' is not an OR syntax. <asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.' It uses the C Programming Language Printf format: '%.3s %.3s%3d %02d:%02d:%02d %s %d' This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second> <timezone> OR <''>, <year> E.g., If the volume language code is set to 'en_US,' the default NFS character set is as follows: 'iso-8859-1|iso-8859-1|Thu Oct 1 15:00:53 PDT 1998' Attributes: non-creatable, non-modifiable
> oem-character-set |  | string optional | The OEM language mapping character set that is currently in effect for the volume. This field is of the following format: '<oem-code-page>|<display-name>|<asctime>' Note that '|' is not an OR syntax. <asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.' It uses the C Programming Language Printf format: '%.3s %.3s%3d %02d:%02d:%02d %s %d' This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <''>, <year> E.g., If the volume language code is set to 'en_US,' the default OEM character set is as follows: 'cp437|cp437|Thu Oct 1 15:00:53 PDT 1998' Attributes: non-creatable, non-modifiable

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-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
> 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-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, 'unix' ... Unix-style security (default setting) If this field is empty ('') or is not present, this attribute isn't applicable to this volume. For example, security styles don't apply to GX-striped data volumes. Attributes: optional-for-create, modifiable
> volume-security-unix-attributes |  | volume-security-unix-attributes optional | The Unix-oriented security settings associated with this volume.

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

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. On the other hand, all striped volumes are Cluster-Mode volumes. By default, this field is false. Attributes: non-creatable, non-modifiable
> is-inconsistent |  | boolean optional | Whether or not there is known inconsistency in the file system associated with the volume. By default, the value is false. Attributes: non-creatable, non-modifiable
> is-invalid |  | boolean optional | Whether or not this volume is invalid. Volumes typically become invalid as a result of an aborted 'vol copy' or SnapMirror(R) initial transfer. In such a case, a volume is in a half-created state and cannot be recovered. By default, the value is false. Attributes: non-creatable, non-modifiable
> is-junction-active |  | boolean optional | This field indicates whether the mounted volume is accessible. The default is true. If the mounted path is not accessible, the volume does not appear in the owning Vserver's namespace. This field applies only to Cluster-Mode volumes. Attributes: optional-for-create, modifiable
> is-node-root |  | boolean optional | If true, this volume is the root volume of the node in which it resides. Only the node's internal logic can change this option's value from true to false; this happens when some other volume has the value set to true. By default, this field is false. Attributes: non-creatable, non-modifiable
> is-nvfail-enabled |  | boolean optional | If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in this volume due to an NVRAM failure. For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data). It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found. For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume. To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume. By default, this value is false. Attributes: optional-for-create, modifiable
> is-quiesced-in-memory |  | boolean optional | Is the given volume quiesced? If true, this volume is in an (in-memory) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
> is-quiesced-on-disk |  | boolean optional | Is the given volume quiesced? If true, this volume is in an (on-disk) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
> is-unrecoverable |  | boolean optional | Whether or not there is known inconsistency in the associated file system and it is not recoverable. This field is valid only for flexible volumes. By default, this field is false. Attributes: non-creatable, non-modifiable
> is-vserver-root |  | boolean optional | If true, this volume is the namespace root volume of the Vserver which owns this volume. The default value is false. When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable. Attributes: optional-for-create, non-modifiable
> state |  | string optional | Volume State. Possible values: 'online', 'restricted', 'offline' Attributes: optional-for-create, modifiable

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

> Information about the striping attributes of a volume.

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

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 example of a valid junction path is: '/user/my_volume'. 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: 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 Anti-Virus settings for the volume.

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

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 '0700' gives read/write/execute permissions to owner and no permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users. It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group. Attributes: optional-for-create, modifiable
> user-id | [0..2^32-1] | integer optional | The UNIX user ID for the volume. The default value is 0 ('root'). Attributes: optional-for-create, modifiable

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]