Input Name	Range	Type	Description
dedupe-request-info		dedupe-request-info	Details of deduplication scan to be run on a volume.
volume-name-or-id		obj-name-or-id	Name or identifier of the volume to dedupe.
Output Name	Range	Type	Description
job-id		integer	Identifier of job started for the deduplication request.

Errno	Description
EACCESSDENIED
EINVALIDINPUT
EDATABASEERROR
EOBJECTNOTFOUND

Destroy a volume.

Input Name	Range	Type	Description
volume-name-or-id		obj-name-or-id	Name or identifier of the volume to destroy.
Output Name	Range	Type	Description
job-id		integer	Identifier of job started for the destroy request.

Errno	Description
EACCESSDENIED
EINVALIDINPUT
EDATABASEERROR
EOBJECTNOTFOUND

Ends iteration to list volumes.

Input Name	Range	Type	Description
tag		string	Tag from a previous volume-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get next few records in the iteration started by volume-list-info-iter-start.

Input Name	Range	Type	Description
maximum		integer validate	The maximum number of entries to retrieve.
tag		string	Tag from a previous volume-list-info-iter-start.
Output Name	Range	Type	Description
records		integer	The number of records actually returned.
volumes		volume-info[]	List of volumes.

Errno	Description
EINVALIDTAG

Starts iteration to list volumes.

Input Name	Range	Type	Description
block-type		file-system-block-type optional	Filter by file system block type of the volume. If no block-type input is supplied, all types of volumes will be listed.
include-is-available		boolean optional	If true, the is-available status is calculated for each volume which may make the call to this zapi take much longer. Default is false.
include-migration-info		boolean optional	If true, is-capable-of-migration information for each volume is returned in volume-list-info-iter-next. If is-capable-of-migration information returned for the volume is false, migration-incompatibility-reasons is returned. Default value: false.
include-next-scheduled-backup-time		boolean optional	If true, return next-scheduled-backup-time for each volume in volume-list-info-iter-next. Default value: false
is-direct-member-only		boolean optional	If true, only return the volumes that are direct members of the specified resource group. Default value is false. This field is meaningful only if a resource group name or id is given for the object-name-or-id field.
is-dp-ignored		boolean optional	If true, only list volumes that have been set to be ignored for purposes of data protection. If false, only list volumes that have not been set to be ignored for purposes of data protection. If not specified, list all volumes without taking into account whether they have been ignored or not.
is-in-dataset		boolean optional	If true, only list volumes which only contain data which is protected by a dataset. If false, only list volumes containing data which is not protected by a dataset. If not specified, list all volumes whether they are in a dataset or not.
is-sis-volume		boolean optional	If true, only list Single Instance Storage (SIS) volumes. A SIS volume is a flexible volume that contains shared blocks. It has the ability to have multiple references to the same data block. Each block has a block reference count stored in the volume metadata. As additional indirect blocks point to it or existing ones stop pointing to it, this value is incremented or decremented accordingly. If false, only list volumes which are not SIS volumes. If not specified, list all volumes whether they are SIS volumes or not.
is-snapmirror-primary-capable		boolean optional validate	If present and true, only list volumes capable of being a primary for a SnapMirror relationship. This means the storage system is licensed for SnapMirror. Meaningless if present and false.
is-snapmirror-secondary-capable		boolean optional validate	If present and true, only list volumes capable of being a secondary for a SnapMirror relationship. This means the storage system is licensed for SnapMirror and the volume is not already a SnapMirror or SnapVault secondary. Meaningless if present and false.
is-snapvault-primary-capable		boolean optional validate	If present and true, only list volumes capable of being the source of a SnapVault transfer. This means the storage system is licensed to be a SnapVault primary. Meaningless if present and false.
is-snapvault-secondary-capable		boolean optional validate	If present and true, only list volumes capable of being the destination of SnapVault transfers. This means the storage system is licensed as a SnapVault secondary and the volume is not a SnapMirror destination. Meaningless if present and false.
is-unprotected		boolean optional	If true, only list volumes that are not protected, which means they are not in any SnapMirror or SnapVault relationship. If false or not set, list all volumes.
object-management-filter		object-management-interface optional	Filter the object based on the Data ONTAP interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all objects will be considered.
object-name-or-id		string optional	Name or identifier of an object to list volumes for. The allowed object types for this argument are: Resource Group Dataset Storage Set Host Aggregate Volume Qtree GenericAppObject If object-name-or-id identifies a volume, that single volume will be returned. If object-name-or-id resolves to more than one volume, all of them will be returned. If no object-name-or-id is provided, all volumes will be listed.
rbac-operation		string optional	Names of an RBAC operation. If specified, only return volumes for which the current admin has permission to perform that operation. For example, caller can ask for only volumes that current admin has DFM.Backupmanager.Backup operation privilege to when want to display list of volume that can be backup by the current admin. When not specified, DFM.Database.Read is a default operation requirement.
snapvault-secondary-schedule-name		string optional	Name of a SnapVault backup schedule. If specified, SnapVault secondary volumes that are using the specified backup schedule are listed.
volume-type		string optional	Filter by type of volume. Possible values are: traditional flexible striped If no volume-type input is supplied, all types of volumes 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-list-info-iter-next.
tag		string	Tag to be used in subsequent calls to volume-list-info-iter-next.

Errno	Description
EAPIERROR
EDATABASEERROR
EACCESSDENIED
EINVALIDINPUT
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS

Modify a volume's information. If modifying of one property fails, nothing will be changed. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Write capability on the specified volume. EINVALIDINPUT - When invalid input specified. EOBJECTNOTFOUND - When the volume-name-or-id does not correspond to a volume. EDATABASEERROR - On database error.

Input Name	Range	Type	Description
is-dp-ignored		boolean optional	True if an administrator has chosen to ignore this object for purposes of data protection.
volume-name-or-id		string	Name or identifier of the volume to modify.

Errno	Description
EACCESSDENIED
EINVALIDINPUT
EDATABASEERROR
EOBJECTNOTFOUND

Resize a volume. The size related charecteristics of a volume like total size, snap reserve or maximum size of a volume can be modified using this API.

Input Name	Range	Type	Description
resize-volume-request-info		resize-volume-request-info	Details of a resize request to be carried out as part of this space management operation. The resize request should be on a volume in the aggregate on which the space management session was opened.
volume-name-or-id		obj-name-or-id	Name or identifier of the volume to resize.
Output Name	Range	Type	Description
job-id		integer	Identifier of job started for the resize request.

Errno	Description
EACCESSDENIED
EINVALIDINPUT
EDATABASEERROR
EOBJECTNOTFOUND

Deduplication request details

Name	Range	Type	Description
full-volume-dedupe		boolean optional	If true, full volume dedupe scan is performed. Otherwise only new data since last deduplication operation is scanned. Default value is false.

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]

Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. In case of application resources from the Host Service, this field can contain unique identifier assigned to the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits from 0 through 9. In that case, you cannot use such identifier as obj-name-or-id input. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

[none]

Specify the management interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible values are: "node" - For objects manageable by node management interface "cluster" - For objects manageable by cluster management interface

[none]

Details of the resize request. Atleast one of new-size, maximum-capacity or snap-reserve needs to be specified.

Name	Range	Type	Description
maximum-capacity		integer optional	Specify the new maximum capacity value for a flexbile volume. The value is specified in bytes. Valid only if the storage syste, to which the volume belongs is of ONTAP version 7.1 or above only and if autosize is enabled on the volume. Range: [1..2^44-1]
new-size		integer optional	Specify the new size of the volume. The value is specified in bytes. Range: [1..2^44-1]
snap-reserve		integer optional	Specifies the percetage of space set aside for snapshots in a volume. The value is specified in percentage of the total size of the volume. Range: [0..100]

Information about a volume.

Name	Range	Type	Description
aggregate-id		integer	Identifier of aggregate on which the volume resides.
aggregate-name		string	Name of aggregate on which the volume resides.
block-type		file-system-block-type	File system block type of the volume.
dataset-id		integer optional	ID of dataset where this qtree is in the primary storage set. Range: [1..2^31-1] This field is deprecated in favor of datasets, which lists all datasets the volume belongs to. It is still populated with one of the dataset ids.
dataset-nodes		dataset-node-info[] optional	Information about the dataset nodes which contain this volume as member. If is-in-dataset is false, this list will be empty.
datasets		dataset-reference[]	List of dataset IDs containing this volume. If is-in-dataset is false, this list will be empty.
host-id		integer	Identifier of host on which the volume resides.
host-name		string	Name of host on which the volume resides.
is-available		boolean optional	True if this object and all of it's parents are up or online. Only output if the call to iter-start included the "include-is-available" flag.
is-capable-of-migration		boolean optional	Indicates whether the volume can be migrated. Returned only when include-migration-info is true in volume-list-info-iter-start call. A volume is considered as capable of migration in a transparent way (using migrate-volume API) when the following conditions holds good for the volume. The volume or any of its qtrees has no NFS exports The volume or any of its qtrees has no CIFS shares The volume or any of its qtrees has no LUNs mapped to storage clients. The volume has no child clone volumes. There are no incoming and outgoing protection relationships that are not managed by Protection Manager. The volume is not the root storage of a storage system or vFiler unit. The volume is not of 'Traditional' type. The volume is managed by "node" management interface.
is-dp-ignored		boolean optional	True if this dataset is intentionally ignored.
is-in-dataset		boolean	Indicate whether this volume is a member of any dataset.
is-readonly-volume		boolean	True if the volume is readonly.
is-snapmirror-primary-capable		boolean	True if the volume is capable of being a primary for a SnapMirror relationship. This means the storage system is licensed for SnapMirror.
is-snapmirror-primary-volume		boolean	True if the volume is a primary volume for a SnapMirror relationship.
is-snapmirror-secondary-capable		boolean	True if the volume is capable of being a secondary for a SnapMirror relationship. This means the storage system is licensed for SnapMirror and the volume is not already a SnapMirror or SnapVault secondary.
is-snapmirror-secondary-volume		boolean	True if the volume is a destination of Qtree or Volume SnapMirror relationship.
is-snapvault-primary-capable		boolean	True if the volume is capable of being the source of a SnapVault transfer. This means the storage system is licensed to be a SnapVault primary.
is-snapvault-primary-volume		boolean	True if the volume contains at least one qtree which is the source of a SnapVault backup.
is-snapvault-secondary-capable		boolean	True if the volume is capable of being the destination of SnapVault transfers. This means the storage system is licensed as a SnapVault secondary and the volume is not a SnapMirror destination.
is-snapvault-secondary-volume		boolean	True if the volume is a secondary volume for storing SnapVault backups.
is-vsm-secondary-volume		boolean	True if the volume is a destination of Volume SnapMirror relationship.
junction-path		string optional	Junction path of the volume. Will be present only for volumes on Data ONTAP Cluster-Mode Appliance.
junction-path-active		boolean optional	Junction path status of the volume. Will be present only for volumes on Data ONTAP Cluster-Mode Appliance. Will be true if junction path is active else false.
migration-incompatibility-reasons		migration-incompatibility-reason[] optional	List of reasons the volume is not capable of migration. Returned only when include-migration-info is true in volume-list-info-iter-start call and is-capable-of-migration output is false.
next-scheduled-backup-time		dp-timestamp optional	Time when next scheduled backup job will be run on this volume. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. This is computed and returned only when include-next-scheduled-backup-time is true in volume-list-info-iter-start api. This value is returned only for volumes in datasets that have a protection policy with relevant schedules on the connections and nodes. When the volume is in the primary node of the dataset and if the protection policy assigned to the dataset has a local snapshot schedule associated, this returns the next timestamp when the local snapshot job will run for the dataset. When the volume is in a non-primary node of the dataset and the incoming or outgoing connection of the protection policy has a backup/mirror schedule, this will return the least timestamp when the next backup/mirror job will run for the dataset for those connection(s).
snapshot-volume-id		obj-id optional	Identifier of the Snapshot space for the volume i.e "volume.snapshot" This represents the Snapshot reserve in the volume.
snapshot-volume-name		obj-full-name optional	Name of the Snapshot space for the volume i.e "volume.snapshot". This represents the Snapshot reserve in the volume.
snapvault-lag-warning-threshold		integer optional	Threshold in seconds. DFM generates a warning event when age of the replica for a SnapVault backup relationship exceeds the specified threshold.
snapvault-secondary-schedule-name		string optional	Name of backup schedule associated with secondary volume. Not present if there is no schedule.
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 preallocated. file - Indicates that the space will be preallocated for all the space-reserved files and LUNs within the volume. Storage is not preallocated 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. none - Indicates that no space will be preallocated. file(disabled) - If a volume with file guarantee has been brought online when the aggregate has insufficient free space to preallocate to the volume. volume(disabled) - If a volume with volume guarantee has been brought online when the aggregate has insufficient free space to preallocate to the volume. This field will not be present for traditional volumes. This field does not appear if volume-state of the flexible volume is restricted or offline.
volume-dedupe-info		volume-dedupe-info optional	Volume deduplication information. This is returned only if the volume is a SIS volume.
volume-full-threshold		integer	The value (as an integer percentage) of the fullness threshold used to generate a "volume full" event for this volume and to compute the volume-space-status. The order in which the thresholds are returned is: If a volume is governed by a provisioning policy, then the thresholds in the provisioning policy are returned. If the thresholds are set at volume level, then those thresholds are returned. If the volume is neither governed by a provisioning policy nor if thresholds are set at volume level, then the value returned will be empty. If the value is empty, then the global setting for volume full threshold is considered and this can be obtained from dfm-get-option API with option-name as "volFullThreshold". Range: [0..1000]
volume-id		integer	Identifier of the volume.
volume-name		string	Name of the volume.
volume-nearly-full-threshold		integer	The value (as an integer percentage) of the fullness threshold used to generate a "volume nearly full" event for this volume and to compute the volume-space-status. The order in which the thresholds are returned is: If a volume is governed by a provisioning policy, then the thresholds in the provisioning policy are returned. If the thresholds are set at volume level, then those thresholds are returned. If the volume is neither governed by a provisioning policy nor if the thresholds are set at volume level, then the value returned will be empty. If the value is empty, then the global setting for volume nearly full threshold is considered and this can be obtained from dfm-get-option API with option-name as "volNearlyFullThreshold". Range: [0..1000]
volume-perf-status		obj-status optional	Current status of the volume based on performance events
volume-qtree		volume-qtree optional	Volume qtree(s) information. If volume does not have any qtree, this structure is not returned.
volume-size		volume-size	Volume size information.
volume-space-status		object-space-status	Space status of the volume. This indicates the fullness of the volume in terms of whether the percentage of used space with respect to total size of the volume has reached or crossed the fullness thresholds given in volume-nearly-full-threshold and volume-full-threshold.
volume-state		string	State of volume. Possible values are: initializing failed offline online partial restricted unknown
volume-status		obj-status optional	Current status of the volume based on all events
volume-type		string	Type of volume. Possible values are: traditional flexible striped

Information about a dataset node.

Name	Range	Type	Description
dataset-id		obj-id	ID of the dataset. Range: [1..2^31-1]
dataset-name		obj-name	Name or the dataset.
dp-node-id		integer	ID of the node in the data protection policy associated with the dataset. If there is no protection policy assigned to the dataset, then the value 1 is returned. Range:[1..2^31-1]
dp-node-name		dp-policy-node-name	Name of the node in the data protection policy associated with the dataset. If there is no data protection policy assigned to the dataset, then the name of the dataset is returned as the node name.
is-dp-node-effective-primary		boolean	This value will be true when the node in the dataset is the effective primary node of the dataset.

The name and id of a dataset.

Name	Range	Type	Description
dataset-id		obj-id	Identifier for the dataset. Range: [1..2^31-1]
dataset-name		obj-name	Name of the dataset.

Seconds since 1/1/1970 in UTC. Range: [0..2^31-1]. This runs out in 2036, so update the API some time before then.

[none]

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]

A reason the volume is not capable of migration. Possible values are: 'vol_has_nfs_exports': The volume or any of its qtrees has NFS exports. 'vol_has_cifs_shares': The volume or any of its qtrees has CIFS shares. 'vol_has_mapped_luns': The volume or any of its qtrees has LUNs. 'vol_has_flex_clones': The volume has child clone volumes. 'vol_has_unmanaged_snapmirror_rels': There are incoming or outgoing SnapMirror relationships that are not managed by ProtectionManager. 'vol_has_unmanaged_snapvault_rels': There are incoming or outgoing SnapVault relationships that are not managed by Protection Manager. 'vol_is_storage_root': The volume is the root volume of a storage system or vFiler unit. 'vol_has_qtree_storage_root': The volume has at least one qtree which is the root storage of a vFiler unit. 'vol_is_traditional': The volume is 'Traditional' volume, not a Flexible volume. 'vol_is_cmode': The volume is on a Data ONTAP Cluster-Mode appliance. 'vol_is_offline': The volume is offline.

[none]

Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

[none]

Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

[none]

A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the storage system or agent. 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. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

[none]

Space status of the object. This indicates the fullness of the object in terms of whether the percentage of used space with respect to total size of the object has reached the fullness thresholds. Possible values: ok - when the percentage of used space of the object is within the nearly full and full threshold of the object. nearly_full - when the percentage of used space of the object is within the full threshold of the object but has reached or crossed the nearly full threshold. full - when the percentage of used space of the object has reached or crossed the full threshold of the object.

[none]

Volume deduplication information. Optional fields will not be returned if deduplication has never run on the volume.

Name	Range	Type	Description
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-space-savings		integer optional	Space savings as a result of deduplication on the volume in bytes. Range: [0..2^63-1]
dedupe-space-savings-percentage		integer optional	Percentage of space savings generated by the shared space. Range: [0..100]
dedupe-status		string optional	Deduplication operation status of the volume. Possible values: "idle", "active", "pending", or "undoing".
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. The value is in seconds since January 1, 1970. Range : [0..2^31-1]
last-dedupe-end-timestamp		timestamp optional	End timestamp of the last deduplication operation on the volume. The value is in seconds since January 1, 1970. Range : [0..2^31-1]
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		integer optional	The size scanned in bytes of the last deduplication operation on the volume. Range : [0..2^63-1].

Information on qtrees in the volume

Name	Range	Type	Description
protected-data-size		integer	Summation of total size of protected qtrees.
protected-qtree-count		integer	Total number of qtrees that are in datasets.
total-qtree-count		integer	Total number of qtrees in the volume.
unprotected-data-size		integer	Summation of total size of unprotected qtrees.
unprotected-qtree-count		integer	Total number of qtrees that are not in any dataset.

Collected size information about a volume. Optional items will not be returned if DFM does not know the value.

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		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. Range: [0..2^63-1]
afs-data		integer optional	Number of bytes used to hold user data in active file system. This should match what you'd get if you added up the file sizes. This includes data and hole reserves, if any. Range: [0..2^63-1]
afs-total		integer optional	Total number of bytes in active file system (total volume less snapshot reserve). Range: [0..2^63-1]
afs-used		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. Range: [0..2^63-1]
afs-used-per-day		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. Range: [-2^44-1..2^44-1]
hole-reserve		integer optional	Number of bytes available in LUNs. Range: [0..2^44-1]
is-autosize-enabled		boolean	Indicates whether this volume has autosize feature enabled or not.
maximum-size		integer optional	Maximum size in bytes that this volume will be grown up to automatically by ONTAP. This is returned only if is-autosize-enabled is true. Range: [0..2^63-1]
overwrite-reserve-avail		integer optional	Number of bytes available reserved space for data overwrites. Range: [0..2^63-1]
overwrite-reserve-total		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. Range: [0..2^63-1]
overwrite-reserve-used		integer optional	Number of bytes used in overwrite reserve space. Range: [0..2^63-1]
snapshot-reserve-avail		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. Range: [0..2^63-1]
snapshot-reserve-total		integer optional	Total number of bytes of snapshot reserve. Range: [0..2^63-1]
snapshot-reserve-used		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. Range: [0..2^63-1]
space-allocated-from-aggr		integer	Bytes allocated to the volume from the aggregate. In case of volumes with space-guarantee as "volume", it would be the total size of the volume, where as in case of volumes with "file" or "none" guarantee volumes, it would be the used space from the aggregate. Range [0..2^44-1]
total		integer optional	Total number of bytes in volume. This includes the snapshot reserve. Range: [0..2^63-1]

Name of a node in a DP policy graph. This typedef is an alias for the builtin ZAPI type string. A node name may contain from 1 to 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'). The name of each node in a DP policy must be unique, but nodes in different policies may share the same name. Node names are always compared in a case-insensitive manner. This means that, for example, "a" and "A" are considered to be the same name for purposes of: creating new nodes for a new policy, renaming nodes of an existing policy, or looking up a policy's nodes by name. On the other hand, ZAPIs that return node names do not change the capitalization at all. For example, if a node's name has been set to "Backup", then dp-policy-list-iter-next returns its name as "Backup". Note that a node name has the same format as an obj-name, and has similar properties such as case-insensitivity. However, a node name is not a kind of obj-name because a DP policy node is a part of a DP policy object, but is not itself a first-class DFM object.

[none]

Name of a DFM 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 EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR 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 DFM object type (e.g. data set, host, DP policy, 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. For example, this constraint applies to datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

[none]

Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].

[none]