APIs in Category: volume
API version 6.1

 
volume-by-aggregate-iter
volume-iter
volume-move-history-list-info-iter-end
volume-move-history-list-info-iter-next
volume-move-history-list-info-iter-start

NetApp Manage ONTAP
 
volume-by-aggregate-iter [top]

Iterate over volumes contained entirely within a single aggregate. Currently returns flexible volumes and infinite volume constituents.
Input Name Range Type Description
max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance.
resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are:
  • cluster
  • cluster-node
  • aggregate
  • volume
If resource-filter identifies a volume, that single volume will be returned. If resource-filter resolves to more than one volume, all of them will be returned. If no resource-filter is provided, all volumes will be listed.
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls.
 
Output Name Range Type Description
next-tag string
optional
Tag for the next call. Not present when there are no more objects to return.
num-records integer
The number of records returned in this call.
records volume-by-aggregate-info[]
optional
The list of records.
 Errno  Description
 EINVALIDTAG

 
volume-iter [top]
Iterate over volumes.
Input Name Range Type Description
max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance.
resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are:
  • cluster
  • vserver
  • volume
If resource-filter identifies a volume, that single volume will be returned. If resource-filter resolves to more than one volume, all of them will be returned. If no resource-filter is provided, all volumes will be listed.
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls.
 
Output Name Range Type Description
next-tag string
optional
Tag for the next call. Not present when there are no more objects to return.
num-records integer
The number of records returned in this call.
records volume-info[]
optional
The list of records.
 Errno  Description
 EINVALIDTAG

 
volume-move-history-list-info-iter-end [top]
Ends the iteration to list the history of volume moves.
Input Name Range Type Description
tag string
Tag from a previous volume-move-history-list-info-iter-start.
 Errno  Description
 EINVALIDTAG

 
volume-move-history-list-info-iter-next [top]
Get next few records in the iteration started by volume-move-history-list-info-iter-start.
Input Name Range Type Description
maximum integer
The maximum number of entries to retrieve.
tag string
Tag from a previous volume-move-history-list-info-iter-start.
 
Output Name Range Type Description
records integer
The number of records actually returned.
volume-move-history volume-move-history-info[]
List of volume move histories.
 Errno  Description
 EINVALIDINPUT
 EINVALIDTAG
 EOBJECTNOTFOUND

 
volume-move-history-list-info-iter-start [top]
Starts the iteration to list the history of volume moves.
Input Name Range Type Description
volume-resource-key resource-key
optional
Name or identifier of a volume to list move histories for. If no volume-resource-key is provided, all volume move histories will be listed.
 
Output Name Range Type Description
records integer
Number which tells you how many items have been saved for future retrieval with volume-move-history-list-info-iter-next.
tag string
An opaque handle used to identify a temporary store. Used in subsequent calls to volume-move-history-list-info-iter-next or volume-move-history-list-info-iter-end.
 Errno  Description
 EINVALIDINPUT
 EOBJECTNOTFOUND

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: volume-by-aggregate-info [top]
Information about an aggregate-based volume.
Name Range Type Description
actual-volume-size integer
optional
Actual size in bytes of the volume. For volumes which are destinations of a Volume SnapMirror relationship, the actual size of the volume may differ from the logical size (reported by the df command). The logical size for such volumes is equal to size of the source volume. For all other volume actual-volume-size will be same as total size.
afs-avail [0..2^63-1] integer
optional
Number of bytes available in active file system. This will be (afs-total - afs-used) or the available space in the aggregate, whichever is lower.
afs-total [0..2^63-1] integer
optional
Total number of bytes in active file system (total volume less snapshot reserve).
afs-used [0..2^63-1] integer
optional
Number of bytes used to hold active file system data. This is what "df" reports as used for the volume. It includes data, hole reserves, overwrite reserves and snapshot overflow.
aggregate-name string
Name of aggregate on which the volume resides.
aggregate-resource-key resource-key
The resource key for the aggregate on which the volume resides.
block-type file-system-block-type
File system block type of the volume.
constituent-volume-by-aggregate-info constituent-volume-by-aggregate-info
optional
This element contains data applicable exclusively to constituent volumes.
is-snapshot-enabled boolean
Specifies whether the Snapshot copies are enabled for the volume.
snapshot-reserve-avail [0..2^63-1] integer
optional
Number of available bytes in snapshot reserve for this volume. If snapshot-reserve-used is greater than snapshot-reserve-total, this value will be zero.
snapshot-reserve-total [0..2^63-1] integer
optional
Total number of bytes of snapshot reserve.
snapshot-reserve-used [0..2^63-1] integer
optional
Total number of bytes used to hold snapshot data. This can be greater than the snapshot reserve size but will not include any space used out of the overwrite reserve.
space-guarantee string
optional
The space reservation style associated with the volume. Possible values:
  • volume - Indicates that the entire size of the volume is pre-allocated.
  • file - Indicates that the space will be pre-allocated for all the space-reserved files and LUNs within the volume. Storage is not pre-allocated for files and LUNs that are not space-reserved. Writes to these can fail if the underlying aggregate has no space available to store the written data.
  • partial - Indicates that a FlexCache volume to reserve some amount of space that is less than its total size
  • none - Indicates that no space will be pre-allocated.
This field does not appear if volume-state is restricted or offline.
total [0..2^63-1] integer
optional
Total number of bytes in volume. This includes the snapshot reserve.
volume-efficiency-info volume-efficiency-info
optional
Volume efficiency information. This is returned only if deduplication or compression have ever been run on the volume.
volume-name string
Name of the volume.
volume-resource-key resource-key
The resource key for this volume.
volume-state string
State of volume. Possible values are:
  • offline
  • online
  • restricted
  • unknown
volume-type string
Type of volume. Possible values are:
  • rw - read-write
  • ls - load-sharing
  • dp - data-protection
  • dc - data-cache (FlexCache)
  • tmp temporary
vserver-name string
Name of vserver on which the volume resides.
vserver-resource-key resource-key
The resource key for the vserver on which the volume resides.

 
Element definition: volume-info [top]
Information about a volume.
Name Range Type Description
block-type file-system-block-type
File system block type of the volume.
flexible-volume-info flexible-volume-info
optional
This element contains data applicable exclusively to flexible volumes.
infinite-volume-info infinite-volume-info
optional
This element contains data applicable exclusively to infinite volumes.
is-junction-path-active boolean
optional
Whether the junction path of the volume is active. The value will not be set if the junction path is unavailable.
junction-parent-name string
optional
The name of the volume that contains the junction inode of the volume.
junction-parent-resource-key resource-key
optional
The resource key of the volume that contains the junction inode of the volume.
junction-path string
optional
Junction path of the volume.
space-guarantee string
optional
The space reservation style associated with the flexible volume. Possible values:
  • volume - Indicates that the entire size of the volume is pre-allocated.
  • file - Indicates that the space will be pre-allocated for all the space-reserved files and LUNs within the volume. Storage is not pre-allocated for files and LUNs that are not space-reserved. Writes to these can fail if the underlying aggregate has no space available to store the written data.
  • partial - Indicates that a FlexCache volume to reserve some amount of space that is less than its total size
  • none - Indicates that no space will be pre-allocated.
This field does not appear if volume-state is restricted or offline.
volume-efficiency-info volume-efficiency-info
optional
Volume efficiency information. This is returned only if deduplication or compression have ever been run on the volume.
volume-name string
Name of the volume.
volume-resource-key resource-key
The resource key for this volume.
volume-security-info volume-security-info
optional
The Unix-oriented security settings associated with this volume.
volume-size volume-size
Volume size information.
volume-state string
State of volume. Possible values are:
  • offline
  • online
  • restricted
  • unknown
volume-status obj-status
Current status of the volume based on all events
volume-type string
Type of volume. Possible values are:
  • rw - read-write
  • ls - load-sharing
  • dp - data-protection
  • dc - data-cache (FlexCache)
  • tmp temporary
vserver-name string
Name of vserver on which the volume resides.
vserver-resource-key resource-key
The resource key for the vserver on which the volume resides.

 
Element definition: volume-move-history-info [top]
Information about a volume move.
Name Range Type Description
destination-aggregate-name obj-name
optional
Name of the aggregate where the volume is already moved or being moved to. If the destination aggregate is deleted, this element is not returned.
destination-aggregate-resource-key resource-key
optional
Resource key of the aggregate where the volume is already moved or being moved to. If the destination aggregate is deleted, this element is not returned.
source-aggregate-name obj-name
optional
Name of the aggregate where the volume that is being moved originally resided or is still residing. If the source aggregate is deleted, this element is not returned.
source-aggregate-resource-key resource-key
optional
Resource key of the aggregate where the volume that is being moved originally resided or is still residing. If the source aggregate is deleted, this element is not returned.
volume-move-completion-time timestamp
optional
Timestamp, in seconds, indicating the completion of the volume move operation since Jan 1, 1970 00:00:00 UTC.
volume-move-details string
Provides details about the state of the volume move operation.
volume-move-estimated-completion-time timestamp
optional
Timestamp, indicating the estimated completion time of the volume move operation. Note that this time may keep increasing when the move goes into 'cutover', 'cutover hard deferred', 'cutover soft deferred' phase. In those cases where the input for cutover-action is wait, during data copy phase, estimated time of completion will approximate the time to reach cutover point and wait for user intervention. When the move is in queued phase this element is not returned.
volume-move-percent-complete [0..100] integer
optional
Percentage of volume move completed thus far. When the move is in queued phase this element will show zero percent completion.
volume-move-phase string
Phase of the volume move operation. The possible phases are 'queued', 'initializing', 'replicating', 'cutover', 'cutover hard deferred', 'cutover soft deferred', 'completed', 'cleaning up', 'failed', and 'restarting'.
volume-move-start-time timestamp
Timestamp, in seconds, indicating the start of the volume move operation since Jan 1, 1970 00:00:00 UTC.
volume-move-state string
State of the volume move operation. The possible states are 'in-progress', 'completed', 'failed', and 'paused'. The state 'paused' indicates that the volume move operation is moving into a cutover-deferred phase and is waiting for user intervention in the case of errors.
volume-name obj-name
Name of the volume.
volume-resource-key resource-key
Resource key of the volume.
vserver-name obj-name
Name of vserver on which the volume resides.
vserver-resource-key resource-key
Resource key of the vserver on which the volume resides.

 
Element definition: constituent-volume-by-aggregate-info [top]
Attributes applicable only for constituent volumes.
Name Range Type Description
infinite-volume-name string
Name of the constituent's infinite volume.
infinite-volume-resource-key resource-key
The resource key for constituent's infinite volume.
storage-class-name string
Name of storage class on which the constituent resides.
storage-class-resource-key resource-key
The resource key for the storage class on which the constituent resides.

 
Element definition: file-system-block-type [top]
Block Type of the file system. The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type. Volumes contained in a larger parent agregate may have a block-type of 64_bit. For upgraded systems it is possible that this value may be unknown until the system can determine the block-type. Possible values are:
  • 32_bit
  • 64_bit
  • unknown
[none]

 
Element definition: flexible-volume-info [top]
Attributes applicable only for flexible volumes.
Name Range Type Description
aggregate-name string
Name of aggregate on which the volume resides.
aggregate-resource-key resource-key
The resource key for the aggregate on which the volume resides.
autogrow-increment-size [0..2^63-1] integer
optional
The increment size (in bytes) by which the volume would be grown.
is-autosize-enabled boolean
Indicates whether this volume has autosize feature enabled or not.
is-snapshot-autodelete-enabled boolean
Indicates whether this volume has snapshot autodelete enabled or not.
maximum-size [0..2^63-1] integer
optional
Maximum size in bytes that this volume will be grown up to automatically by Data ONTAP. This is returned only if is-autosize-enabled is true.
volume-clone-info volume-clone-info
optional
Volume FlexClone information.

 
Element definition: infinite-volume-info [top]
Attributes applicable only for infinite volumes.
Name Range Type Description
is-managed-by-service boolean
Specifies whether the infinite volume is managed by GUI services.
is-snapdiff-enabled boolean
Specifies whether Snapdiff is enabled for the infinite volume.
max-data-constituent-size [0..2^63-1] integer
optional
The maximum size (in bytes) of each data constituent in bytes.
max-namespace-constituent-size [0..2^63-1] integer
optional
The maximum size (in bytes) of the namespace constituent.

 
Element definition: obj-name [top]
Name of an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format:
  • It must contain between 1 and 64 characters.
  • It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
  • In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all.
The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules:
  • If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUT. Note that because EINVALIDINPUT is such a common error code, ZAPI specifications are not required to document cases when they may return it.
  • If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code.
A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior.

If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats.

Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name.

[none]

 
Element definition: obj-status [top]
A status value which can be associated with an object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type.

Possible values are: 'normal', 'warning', 'error', 'critical'.

  • normal: An object has normal status when it is working within the thresholds specified.
  • warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption.
  • error: An object has error status when it does not cause any service disruption, but it may affect performance.
  • critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately.
In some contexts, it is important that severities are ordered (as above). For example, an alert might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.
[none]

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: timestamp [top]
Seconds since 1/1/1970 in UTC.
[none]

 
Element definition: volume-efficiency-info [top]
Volume efficiency information. Optional fields will not be returned if deduplication or compression have never run on the volume.
Name Range Type Description
compression-space-savings [0..2^63-1] integer
optional
Space savings as a result of compression on the volume in bytes.
compression-space-savings-percentage [0..100] integer
optional
Percentage of space savings generated by the compression.
dedupe-progress string
optional
The progress of the current deduplication operation on the volume with information as to which stage of de-duplication is currently in progress and how much data is processed for that stage. For eg: "25 MB Scanned, 20MB Searched, 40MB (20%) Done , 30MB Verified".
dedupe-schedule string
optional
Schedule for the deduplication operation on the volume. The field is returned if deduplication operation is scheduled.
dedupe-space-savings [0..2^63-1] integer
optional
Space savings as a result of deduplication on the volume in bytes.
dedupe-space-savings-percentage [0..100] integer
optional
Percentage of space savings generated by the shared space.
dedupe-status string
optional
Deduplication operation status of the volume. Possible values: "idle", "active", "pending", or "undoing".
dedupe-type string
optional
Type of the volume depending on whether it has a Snapvault qtree in it or not. Possible values: "regular", or "snapvault".
efficiency-policy string
optional
Policy for the deduplication operation on the volume. The field is returned if an efficiency policy is applied on the volume.
is-compression-enabled boolean
Specifies if compression is enabled on the volume.
is-dedupe-enabled boolean
Specifies if deduplication is enabled on the volume.
last-dedupe-begin-timestamp timestamp
optional
Start timestamp of the last deduplication operation.
last-dedupe-end-timestamp timestamp
optional
End timestamp of the last deduplication operation on the volume.
last-dedupe-error string
optional
A human readable error message of the last deduplication operation on the volume. Returned only when there is a valid error.
last-dedupe-scanned-size [0..2^63-1] integer
optional
The size scanned in bytes of the last deduplication operation on the volume.
last-dedupe-status string
optional
Indicates the completion status of the last deduplication operation performed on the volume. Possible values: "success", or "failure".

 
Element definition: volume-security-info [top]
Unix oriented security settings associated with this volume.
Name Range Type Description
group-id string
optional
Unix group ID for the volume. The default value is 0 ('root').
permissions string
optional
Unix permission bits in octal string format. It is 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 Clustered Data ONTAP, for security stype 'mixed' or 'unix', the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); The third selects permissions for other users in the same group; The fourth for other users not in the group.
user-id string
optional
Unix user ID for the volume. The default value is 0 ('root').

 
Element definition: volume-size [top]
Collected size information about a volume.
Name Range Type Description
actual-volume-size integer
optional
Actual size in bytes of the volume. For volumes which are destinations of a Volume SnapMirror relationship, the actual size of the volume may differ from the logical size (reported by the df command). The logical size for such volumes is equal to size of the source volume. For all other volume actual-volume-size will be same as total size.
afs-avail [0..2^63-1] integer
optional
Number of bytes available in active file system. This will be (afs-total - afs-used) or the available space in the aggregate, whichever is lower.
afs-daily-growth-rate [0..100] integer
optional
Percentage of volume used on a daily basis.
afs-total [0..2^63-1] integer
optional
Total number of bytes in active file system (total volume less snapshot reserve).
afs-used [0..2^63-1] integer
optional
Number of bytes used to hold active file system data. This is what "df" reports as used for the volume. It includes data, hole reserves, overwrite reserves and snapshot overflow.
afs-used-per-day [-2^44-1..2^44-1] integer
Number of bytes used per day in the active file system of the volume. This can be either positive or negative depending on the growth of used space in the volume.
is-snapshot-enabled boolean
Specifies whether the Snapshot copies are enabled for the volume.
overwrite-reserve-avail [0..2^63-1] integer
optional
Number of bytes available reserved space for data overwrites.
overwrite-reserve-total [0..2^63-1] integer
optional
Total number of bytes reserved for data overwrites. This is the space reserved for overwriting LUNs and other space-reserved files when the volume has snapshots and afs-avail is zero.
overwrite-reserve-used [0..2^63-1] integer
optional
Number of bytes used in overwrite reserve space.
quota-committed-space [0..2^63-1] integer
optional
Number of bytes committed for quotas within the volume.
snapshot-reserve-avail [0..2^63-1] integer
optional
Number of available bytes in snapshot reserve for this volume. If snapshot-reserve-used is greater than snapshot-reserve-total, this value will be zero.
snapshot-reserve-days-until-full [0..2^63-1] integer
optional
Number of days until the volume snapshot reserve becomes full. This is returned only if volume snapshot reserve is defined and 'snapshot-reserve-used-per-day' is positive.
snapshot-reserve-total [0..2^63-1] integer
optional
Total number of bytes of snapshot reserve.
snapshot-reserve-used [0..2^63-1] integer
optional
Total number of bytes used to hold snapshot data. This can be greater than the snapshot reserve size but will not include any space used out of the overwrite reserve.
snapshot-reserve-used-per-day [-2^44-1..2^44-1] integer
optional
Number of bytes used per day in the volume snapshot reserve. This can be either positive or negative depending on the growth of used space in the volume snapshot reserve. The information is based on the regression slope of the volume snapshot reserve usage history data. This is returned only if volume snapshot reserve is defined.
total [0..2^63-1] integer
optional
Total number of bytes in volume. This includes the snapshot reserve.

 
Element definition: timestamp [top]
Seconds since 1/1/1970 in UTC.
[none]

 
Element definition: volume-clone-info [top]
Volume FlexClone information. Based on the volume type the following fields are displayed:

For a FlexClone volume, the fields displayed are "clone-space-savings", "clone-space-savings-percentage", "is-clone-present", "is-clone", "parent-volume-resource-key" and "parent-volume-name".

For a parent volume containing FlexClone volumes, the fields displayed are "is-clone-present", "is-clone", and "clone-child-count".

For a volume that is both a FlexClone and parent volume, the fields displayed are "clone-space-savings", "clone-space-savings-percentage", "is-clone-present", "is-clone", "parent-volume-resource-key", "parent-volume-name", and "clone-child-count".

If the volume is neither a FlexClone volume nor a parent volume, then the "is-clone-present" and "is-clone" fields are displayed.

Name Range Type Description
clone-child-count [1..2^32-1] integer
optional
Number of FlexClone volumes for which this volume is parent.
clone-space-savings [0..2^63-1] integer
optional
For a FlexClone volume this contains space savings as a result of sharing space with its FlexClone parent.

For a Parent volume, the space savings is the sum of space savings realised by all its FlexClone volumes.

clone-space-savings-percentage [0..100] integer
optional
Percentage of space savings generated by the shared FlexClone space.
is-clone boolean
Specifies if the volume is a FlexClone volume.
is-clone-present boolean
Specifies if the volume has one or more FlexClone volumes.
parent-volume-name string
optional
Name of the FlexClone parent volume.
parent-volume-resource-key resource-key
optional
Resource key of the FlexClone parent volume.

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]