APIs in Category: Volume | API version 4.0

VolumeListInfoIterEnd VolumeListInfoIterNext VolumeListInfoIterStart VolumeModify | DFM tracks all the Volumes it discovers on storage systems it is monitoring. These APIs give the user access To the information DFM has collected. In addition, this API family will eventually give users the ability To create, modify and Destroy Volumes on storage systems.

NetApp Manage ONTAP API version 4.0

VolumeListInfoIterEnd (supported) | [top]

> Ends iteration To list Volumes.

> Input Name | Type
> VolumeListInfoIterEnd | VolumeListInfoIterEnd
> Output Name | Type
> VolumeListInfoIterEndResult | VolumeListInfoIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

VolumeListInfoIterNext (supported) | [top]

> Get next few Records in the iteration started by VolumeListInfoIterStart.

> Input Name | Type
> VolumeListInfoIterNext | VolumeListInfoIterNext
> Output Name | Type
> VolumeListInfoIterNextResult | VolumeListInfoIterNextResult

> Error Name | Description
> EINVALIDTAG |  |

VolumeListInfoIterStart (supported) | [top]

> Starts iteration To list Volumes.

> Input Name | Type
> VolumeListInfoIterStart | VolumeListInfoIterStart
> Output Name | Type
> VolumeListInfoIterStartResult | VolumeListInfoIterStartResult

> Error Name | Description
> EACCESSDENIED |  |
> EAPIERROR |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

VolumeModify (supported) | [top]

> 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 VolumeNameOrId does not correspond To a Volume. EDATABASEERROR - On database Error.

> Input Name | Type
> VolumeModify | VolumeModify
> Output Name | Type
> VolumeModifyResult | VolumeModifyResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EOBJECTNOTFOUND |  |

Element definition: VolumeListInfoIterEnd | [top]

> Ends iteration To list Volumes.

> Name | Type | Description
> Tag | xsd:string | Tag From a previous VolumeListInfoIterStart.

Element definition: VolumeListInfoIterEndResult | [top]

> [none]

Element definition: VolumeListInfoIterNext | [top]

> Get next few Records in the iteration started by VolumeListInfoIterStart.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve.
> Tag | xsd:string | Tag From a previous VolumeListInfoIterStart.

Element definition: VolumeListInfoIterNextResult | [top]

> Name | Type | Description
> Records | xsd:integer | The number of Records actually returned.
> Volumes | ArrayOfVolumeInfo | List of Volumes.

Element definition: VolumeListInfoIterStart | [top]

> Starts iteration To list Volumes.

> Name | Type | Description
> BlockType | FileSystemBlockType optional | Filter by file system block Type of the Volume. If no BlockType input is supplied, all types of Volumes will be listed.
> IncludeIsAvailable | xsd:boolean optional | If true, the IsAvailable Status is calculated for each Volume which may make the call To this zapi take much longer. Default is false.
> IncludeMigrationInfo | xsd:boolean optional | If true, IsCapableOfMigration information for each Volume is returned in VolumeListInfoIterNext. Default Value: false.
> IncludeNextScheduledBackupTime | xsd:boolean optional | If true, return NextScheduledBackupTime for each Volume in VolumeListInfoIterNext. Default Value: false
> IsDirectMemberOnly | xsd: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 ObjectNameOrId field.
> IsDpIgnored | xsd: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.
> IsInDataset | xsd: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.
> IsSisVolume | xsd: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.
> IsSnapmirrorPrimaryCapable | xsd:boolean optional | 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.
> IsSnapmirrorSecondaryCapable | xsd:boolean optional | 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.
> IsSnapvaultPrimaryCapable | xsd:boolean optional | 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.
> IsSnapvaultSecondaryCapable | xsd:boolean optional | 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.
> IsUnprotected | xsd: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.
> ObjectManagementFilter | ObjectManagementInterface 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.
> ObjectNameOrId | xsd: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 If ObjectNameOrId identifies a Volume, that single Volume will be returned. If ObjectNameOrId resolves To more than one Volume, all of them will be returned. If no ObjectNameOrId is provided, all Volumes will be listed.
> RbacOperation | xsd: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.
> SnapvaultSecondaryScheduleName | xsd:string optional | Name of a SnapVault backup schedule. If specified, SnapVault secondary Volumes that are using the specified backup schedule are listed.
> VolumeType | xsd:string optional | Filter by Type of Volume. Possible Values are: traditional flexible striped If no VolumeType input is supplied, all types of Volumes will be listed.

Element definition: VolumeListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number which tells you how many items have been saved for future retrieval with VolumeListInfoIterNext.
> Tag | xsd:string | Tag To be used in subsequent calls To VolumeListInfoIterNext.

Element definition: VolumeModify | [top]

> 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 VolumeNameOrId does not correspond To a Volume. EDATABASEERROR - On database Error.

> Name | Type | Description
> IsDpIgnored | xsd:boolean optional | True if an administrator has chosen To ignore this object for purposes of data protection.
> VolumeNameOrId | xsd:string | Name or identifier of the Volume To modify.

Element definition: VolumeModifyResult | [top]

> [none]

Element definition: ArrayOfVolumeInfo | [top]

> Name | Type | Description
> VolumeInfo | VolumeInfo[] |

Element definition: FileSystemBlockType | [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 BlockType of 64_bit. For upgraded systems it is possible that this Value may be unknown until the system can determine the BlockType. Possible Values are: 32_bit 64_bit unknown

> [none]

Element definition: ObjectManagementInterface | [top]

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

Element definition: VolumeInfo | [top]

> Information about a Volume.

> Name | Type | Description
> AggregateId | xsd:integer | Identifier of Aggregate on which the Volume resides.
> AggregateName | xsd:string | Name of Aggregate on which the Volume resides.
> BlockType | FileSystemBlockType | File system block Type of the Volume.
> DatasetId | xsd: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.
> DatasetNodes | ArrayOfDatasetNodeInfo optional | Information about the Dataset nodes which contain this Volume as member. If IsInDataset is false, this list will be empty.
> Datasets | ArrayOfDatasetReference | List of Dataset IDs containing this Volume. If IsInDataset is false, this list will be empty.
> HostId | xsd:integer | Identifier of Host on which the Volume resides.
> HostName | xsd:string | Name of Host on which the Volume resides.
> IsAvailable | xsd: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 "IncludeIsAvailable" flag.
> IsCapableOfMigration | xsd:boolean optional | Indicates whether the Volume can be migrated. Returned only when IncludeMigrationInfo is true in VolumeListInfoIterStart call. A Volume is considered as capable of migration in a transparent way (using MigrateVolume 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.
> IsDpIgnored | xsd:boolean optional | True if this Dataset is intentionally ignored.
> IsInDataset | xsd:boolean | Indicate whether this Volume is a member of any Dataset.
> IsReadonlyVolume | xsd:boolean | True if the Volume is readonly.
> IsSnapmirrorPrimaryCapable | xsd:boolean | True if the Volume is capable of being a primary for a SnapMirror relationship. This means the storage system is licensed for SnapMirror.
> IsSnapmirrorPrimaryVolume | xsd:boolean | True if the Volume is a primary Volume for a SnapMirror relationship.
> IsSnapmirrorSecondaryCapable | xsd: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.
> IsSnapmirrorSecondaryVolume | xsd:boolean | True if the Volume is a destination of Qtree or Volume SnapMirror relationship.
> IsSnapvaultPrimaryCapable | xsd: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.
> IsSnapvaultPrimaryVolume | xsd:boolean | True if the Volume contains at least one Qtree which is the Source of a SnapVault backup.
> IsSnapvaultSecondaryCapable | xsd: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.
> IsSnapvaultSecondaryVolume | xsd:boolean | True if the Volume is a secondary Volume for storing SnapVault Backups.
> IsVsmSecondaryVolume | xsd:boolean | True if the Volume is a destination of Volume SnapMirror relationship.
> NextScheduledBackupTime | DpTimestamp 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 IncludeNextScheduledBackupTime is true in VolumeListInfoIterStart 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).
> SnapshotVolumeId | ObjId optional | Identifier of the Snapshot space for the Volume i.e "Volume.Snapshot" This represents the Snapshot reserve in the Volume.
> SnapshotVolumeName | ObjFullName optional | Name of the Snapshot space for the Volume i.e "Volume.Snapshot". This represents the Snapshot reserve in the Volume.
> SnapvaultLagWarningThreshold | xsd:integer optional | Threshold in seconds. DFM generates a warning event when age of the replica for a SnapVault backup relationship exceeds the specified threshold.
> SnapvaultSecondaryScheduleName | xsd:string optional | Name of backup schedule associated with secondary Volume. Not present if there is no schedule.
> SpaceGuarantee | xsd: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 VolumeState of the flexible Volume is restricted or offline.
> VolumeDedupeInfo | VolumeDedupeInfo optional | Volume deduplication information. This is returned only if the Volume is a SIS Volume.
> VolumeFullThreshold | xsd: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 VolumeSpaceStatus. 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 DfmGetOption API with OptionName as "volFullThreshold". Range: [0..1000]
> VolumeId | xsd:integer | Identifier of the Volume.
> VolumeName | xsd:string | Name of the Volume.
> VolumeNearlyFullThreshold | xsd: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 VolumeSpaceStatus. 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 DfmGetOption API with OptionName as "volNearlyFullThreshold". Range: [0..1000]
> VolumePerfStatus | ObjStatus optional | Current Status of the Volume based on performance Events
> VolumeQtree | VolumeQtree optional | Volume Qtree(s) information. If Volume does not have any Qtree, this structure is not returned.
> VolumeSize | VolumeSize | Volume Size information.
> VolumeSpaceStatus | ObjectSpaceStatus | 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 VolumeNearlyFullThreshold and VolumeFullThreshold.
> VolumeState | xsd:string | State of Volume. Possible Values are: initializing failed offline online partial restricted unknown
> VolumeStatus | ObjStatus optional | Current Status of the Volume based on all Events
> VolumeType | xsd:string | Type of Volume. Possible Values are: traditional flexible striped

Element definition: ArrayOfDatasetNodeInfo | [top]

> Name | Type | Description
> DatasetNodeInfo | DatasetNodeInfo[] |

Element definition: ArrayOfDatasetReference | [top]

> Name | Type | Description
> DatasetReference | DatasetReference[] |

Element definition: DpTimestamp | [top]

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

Element definition: ObjFullName | [top]

> 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 ObjName, 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 ObjName and ObjFullName are identical.

> [none]

Element definition: ObjId | [top]

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

Element definition: ObjStatus | [top]

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

Element definition: ObjectSpaceStatus | [top]

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

Element definition: VolumeDedupeInfo | [top]

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

> Name | Type | Description
> DedupeProgress | xsd: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".
> DedupeSpaceSavings | xsd:integer optional | Space savings as a Result of deduplication on the Volume in bytes. Range: [0..2^63-1]
> DedupeSpaceSavingsPercentage | xsd:integer optional | Percentage of space savings generated by the shared space. Range: [0..100]
> DedupeStatus | xsd:string optional | Deduplication Operation Status of the Volume. Possible Values: "idle", "active", "pending", or "undoing".
> IsDedupeEnabled | xsd:boolean | Specifies if deduplication is enabled on the Volume.
> LastDedupeBeginTimestamp | Timestamp optional | Start Timestamp of the last deduplication Operation. The Value is in seconds since January 1, 1970. Range : [0..2^31-1]
> LastDedupeEndTimestamp | 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]
> LastDedupeError | xsd:string optional | A human readable Error message of the last deduplication Operation on the Volume. Returned only when there is a valid Error.
> LastDedupeScannedSize | xsd:integer optional | The Size scanned in bytes of the last deduplication Operation on the Volume. Range : [0..2^63-1].

Element definition: VolumeQtree | [top]

> Information on Qtrees in the Volume

> Name | Type | Description
> JunctionPath | xsd:string optional | Junction Path of the Volume. Will be present only for Volumes on cluster systems.
> JunctionPathActive | xsd:boolean optional | Junction Path Status of the Volume. Will be present only for Volumes on cluster systems. TRUE if junction Path active else FALSE.
> ProtectedDataSize | xsd:integer | Summation of Total Size of protected Qtrees.
> ProtectedQtreeCount | xsd:integer | Total number of Qtrees that are in Datasets.
> TotalQtreeCount | xsd:integer | Total number of Qtrees in the Volume.
> UnprotectedDataSize | xsd:integer | Summation of Total Size of unprotected Qtrees.
> UnprotectedQtreeCount | xsd:integer | Total number of Qtrees that are not in any Dataset.

Element definition: VolumeSize | [top]

> Collected Size information about a Volume. Optional items will not be returned if DFM does not know the Value.

> Name | Type | Description
> ActualVolumeSize | xsd: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 ActualVolumeSize will be same as Total Size.
> AfsAvail | xsd:integer optional | Number of bytes available in active file system. This will be (AfsTotal - AfsUsed) or the available space in the Aggregate, whichever is lower. Range: [0..2^63-1]
> AfsData | xsd: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]
> AfsTotal | xsd:integer optional | Total number of bytes in active file system (Total Volume less Snapshot reserve). Range: [0..2^63-1]
> AfsUsed | xsd: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]
> AfsUsedPerDay | xsd: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]
> HoleReserve | xsd:integer optional | Number of bytes available in LUNs. Range: [0..2^44-1]
> IsAutosizeEnabled | xsd:boolean | Indicates whether this Volume has autosize Feature enabled or not.
> MaximumSize | xsd:integer optional | Maximum Size in bytes that this Volume will be grown up To automatically by ONTAP. This is returned only if IsAutosizeEnabled is true. Range: [0..2^63-1]
> OverwriteReserveAvail | xsd:integer optional | Number of bytes available reserved space for data overwrites. Range: [0..2^63-1]
> OverwriteReserveTotal | xsd: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 AfsAvail is zero. Range: [0..2^63-1]
> OverwriteReserveUsed | xsd:integer optional | Number of bytes used in overwrite reserve space. Range: [0..2^63-1]
> SnapshotReserveAvail | xsd:integer optional | Number of available bytes in Snapshot reserve for this Volume. If SnapshotReserveUsed is greater than SnapshotReserveTotal, this Value will be zero. Range: [0..2^63-1]
> SnapshotReserveTotal | xsd:integer optional | Total number of bytes of Snapshot reserve. Range: [0..2^63-1]
> SnapshotReserveUsed | xsd: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]
> SpaceAllocatedFromAggr | xsd:integer | Bytes allocated To the Volume From the Aggregate. In case of Volumes with SpaceGuarantee 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 | xsd:integer optional | Total number of bytes in Volume. This includes the Snapshot reserve. Range: [0..2^63-1]

Element definition: DatasetNodeInfo | [top]

> Information about a Dataset node.

> Name | Type | Description
> DatasetId | ObjId | ID of the Dataset. Range: [1..2^31-1]
> DatasetName | ObjName | Name or the Dataset.
> DpNodeId | xsd: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]
> DpNodeName | DpPolicyNodeName | 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.
> IsDpNodeEffectivePrimary | xsd:boolean | This Value will be true when the node in the Dataset is the effective primary node of the Dataset.

Element definition: DatasetReference | [top]

> The Name and Id of a Dataset.

> Name | Type | Description
> DatasetId | ObjId | Identifier for the Dataset. Range: [1..2^31-1]
> DatasetName | ObjName | Name of the Dataset.

Element definition: Timestamp | [top]

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

> [none]

Element definition: DpPolicyNodeName | [top]

> 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 DpPolicyListIterNext returns its Name as "Backup". Note that a node Name has the same format as an ObjName, and has similar Properties such as case-insensitivity. However, a node Name is not a kind of ObjName because a DP Policy node is a part of a DP Policy object, but is not itself a first-class DFM object.

> [none]

Element definition: ObjName | [top]

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