APIs in Category: Dataset
 API version 4.0

 
DatasetAddMember
DatasetAddMemberByDynamicReference
DatasetAddResourcepool
DatasetBeginFailover
DatasetBeginFailoverScriptTest
DatasetChangeDrState
DatasetConformBegin
DatasetCreate
DatasetDestroy
DatasetDynamicReferenceListInfoIterEnd
DatasetDynamicReferenceListInfoIterNext
DatasetDynamicReferenceListInfoIterStart
DatasetEditBegin
DatasetEditCommit
DatasetEditRollback
DatasetListInfoIterEnd
DatasetListInfoIterNext
DatasetListInfoIterStart
DatasetMemberDedupeAbort
DatasetMemberDedupeStart
DatasetMemberDeleteSnapshots
DatasetMemberListInfoIterEnd
DatasetMemberListInfoIterNext
DatasetMemberListInfoIterStart
DatasetMemberUndedupeStart
DatasetMissingMemberListInfoIterEnd
DatasetMissingMemberListInfoIterNext
DatasetMissingMemberListInfoIterStart
DatasetModify
DatasetModifyNode
DatasetProvisionMember
DatasetRemoveMember
DatasetRemoveMemberByDynamicReference
DatasetRemoveResourcepool
DatasetReplacePrimaryMembers
DatasetResizeMember
DatasetSet
DatasetSetStorageset
DatasetUpdateDrStatus
DatasetUpdateProtectionStatus
At the highest level, a Dataset is a logical collection of data, optionally associated with one or more policies. This collection of data resides on storage containers which should be thought of as transient in nature. That is, the storage containers holding the data may change over time and the data should be treated independently From the storage it happens To reside on.

Datasets typically describe data that has been provisioned From Resource pools according To a Policy. A Dataset may also be created by populating it with legacy storage containers such as existing Data ONTAP Volumes or non-NetApp containers such as OSSV Directories.

In concrete terms, a Dataset is a collection of Volumes, Qtrees, Luns, or possibly Host based containers such as OSSV Directories, with the addition of policies that are associated with it. The Dataset provides virtualization of the physical storage used To hold the data.

Currently, Datasets can not contain LUNs, Datasets can be associated only with data protection policies and their primary data can be either provisioned based on a provisioning Policy or can be populated with legacy storage containers. Secondary storage can be automatically provisioned From a Resource pool or added explicitly.

NetApp Manage ONTAP API version 4.0
 
DatasetAddMember (supported) [top]

Add Members To an existing Dataset.

This API is for adding direct member Objects To one or more storage sets in the Dataset. Each storage set is identified by the data protection Policy node associated with it.

The types of storage Objects allowed To be added vary:

  • Volumes, Qtrees and OSSV Directories are allowed in the storage set attached To a primary Policy node.
  • Only Volumes are allowed in a storage sets attached To secondary/destination nodes.
It is legal To add storage Objects To multiple storage sets in a single call.
Input Name Type
DatasetAddMember DatasetAddMember
 
Output Name Type
DatasetAddMemberResult DatasetAddMemberResult
 Error Name  Description
 EACCESSDENIED
 EALREADYINDATASET
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTMEMBERVFILERMISMATCH
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EDSCONFLICTWITHANOTHERDATASET
 EEDITSESSIONNOTFOUND
 EINVALIDOBJECTTYPE
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetAddMemberByDynamicReference (supported) [top]
Add dynamic reference To an existing Dataset.

By adding a dynamic reference, the Volumes, Qtrees, and ossv Directories referred To by the dynamic reference become implicit (indirect) Members of the Dataset. A dynamic reference can be added To a particular storage set in the Dataset by specifying the data protection Policy node associated with it. If necessary a new storage set is first created automatically before adding storage Objects To it.

The types of storage Objects allowed To be added vary:

  • Storage systems, vFiler units, Aggregates and OSSV Hosts can be attached To a primary Policy node.
  • Storage systems, vFiler units and Aggregates are allowed in storage sets attached To secondary/destination nodes.
It is legal To add storage Objects To multiple storage sets in a single call.
Input Name Type
DatasetAddMemberByDynamicReference DatasetAddMemberByDynamicReference
 
Output Name Type
DatasetAddMemberByDynamicReferenceResult DatasetAddMemberByDynamicReferenceResult
 Error Name  Description
 EACCESSDENIED
 EALREADYINDATASET
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTMEMBERVFILERMISMATCH
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EINVALIDOBJECTTYPE
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetAddResourcepool (supported) [top]
Add Resource pool To a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the Policy node that maps To it.

Within the same edit session in which you call DatasetAddResourcepool, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's protection Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set or does not have DFM.ResourcePool.Provision on the specified Resource pool.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
Input Name Type
DatasetAddResourcepool DatasetAddResourcepool
 
Output Name Type
DatasetAddResourcepoolResult DatasetAddResourcepoolResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND
 ESERVICEISATTACHED
 ESTORAGESETNOTINDATASET

 
DatasetBeginFailover (supported) [top]
Begin failover of a Dataset.

This API begins the process of failing over a Dataset To its disaster recovery storage. The failover process will break any mirror relationships between the primary and DR storage Objects and make the secondary storage available for use.

This API may only be invoked if the DR state of the data set is "ready".

Specifically, when the ZAPI runs, the following actions will take place:

  1. The DR state of the Dataset will immediately change To "failing_over".
  2. Any pending conformance tasks will be cancelled.
  3. Any Jobs running against this Dataset will be aborted.
  4. A failover job will be started To break any mirrors between the primary storage set and the DR storage set
  5. Finally, the DR state of the Dataset will be updated To either "failed_over" or "failover_error" based on whether the failover job succeeded or not.
Input Name Type
DatasetBeginFailover DatasetBeginFailover
 
Output Name Type
DatasetBeginFailoverResult DatasetBeginFailoverResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETDRSTATEUNCHANGED
 EDATASETFAILOVERNOTREADY
 EDATASETWRONGDRSTATE
 EINVALIDINPUT
 EOBJECTNOTFOUND

 
DatasetBeginFailoverScriptTest (supported) [top]
Begin test failover of a Dataset that only runs the the failover scripts and does not dequeue tasks, abort Jobs or change the DrState.
Input Name Type
DatasetBeginFailoverScriptTest DatasetBeginFailoverScriptTest
 
Output Name Type
DatasetBeginFailoverScriptTestResult DatasetBeginFailoverScriptTestResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETFAILOVERNOTREADY
 EDATASETWRONGDRSTATE
 EINVALIDINPUT
 EOBJECTNOTFOUND

 
DatasetChangeDrState (supported) [top]
Change the disaster recovery state of a Dataset.

This API sets the DR state of a Dataset To a new Value. Users may perform the following DR state transitions using this ZAPI:

  • From "failover_error" To "failed_over".
  • From "failover_error" To "ready".
  • From "failed_over" To "ready".

If the "AllowInternalTransitions" element is present and true, the caller may make additional state transitions:

  • From "ready" To "failing_over"
  • From "failing_over" To "failed_over"
  • From "failing_over" To "failover_error"
These state transitions are intended To be used by Protection Manager server processes as part of a failover or failback sequence. Any attempt To perform other state transition will fail with an Error code of EDATASETWRONGDRSTATE.

The DR state of a Dataset will also change in one special case:

  • The Dataset is in a "failed_over" DR state
  • The caller changes the data protection Policy
  • The caller maps the storage set for the DR node of the old Policy To the root node of the new Policy (using DatasetSetStorageset)
When the edit session with these modifications is committed, the DR state will be set back To "ready".
Input Name Type
DatasetChangeDrState DatasetChangeDrState
 
Output Name Type
DatasetChangeDrStateResult DatasetChangeDrStateResult
 Error Name  Description
 EACCESSDENIED
 EAPIAUTHENTICATION
 EAPIERROR
 EDATABASEERROR
 EDATASETWRONGDRSTATE
 EINTERNALERROR
 EINVALIDINPUT
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetConformBegin (supported) [top]
Begin a conformance run on a Dataset, To attempt To bring it into conformance with its data protection Policy and provisioning Policy. A conformance run consists of two main steps:
  • Perform a conformance check To determine both the Dataset's current conformance Status, and the set of actions needed To bring the Dataset into conformance.
  • Perform the conformance actions needed To bring the Dataset into conformance.
In addition, the Dataset's conformance Status is updated at various points during the conformance run. Whenever the conformance Status is updated, an event of Type "Dataset.conformance" is generated.

Successful completion of this ZAPI indicates that: the conformance check has completed successfully, the Dataset's conformance Status has been updated based on the Results of the conformance check, and the system has begun To take any needed conformance actions.

After the ZAPI returns, the system continues To perform conformance actions in the background, until all actions complete. Once all actions have completed, the Dataset's conformance Status is again updated. Note that at present, there is no ZAPI Interface for determining when all actions have completed.

If no Policy has been assigned To the Dataset, the conformance run completes immediately and performs no conformance actions.

Error conditions:
  • EACCESSDENIED - User does not have privileges To access the Dataset.
  • EOBJECTNOTFOUND - No Dataset was found that has the given Name or ID.
  • EDATABASEERROR - A database Error occurred while processing the Request.
Input Name Type
DatasetConformBegin DatasetConformBegin
 
Output Name Type
DatasetConformBeginResult DatasetConformBeginResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETMIGRATING
 EOBJECTNOTFOUND

 
DatasetCreate (supported) [top]
Create a new, empty Dataset.
Input Name Type
DatasetCreate DatasetCreate
 
Output Name Type
DatasetCreateResult DatasetCreateResult
 Error Name  Description
 EACCESSDENIED
 EAPILICENSE
 EDATABASEERROR
 EDATASETEXISTS
 EDSCONFLICTNDRESTORE
 EINTERNALERROR
 EINVALIDMEMBER
 EINVALIDTIMEZONE
 EMEMBERALREADYINGROUP
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetDestroy (supported) [top]
Destroy a Dataset. The Dataset must be empty unless the "Force" Option is used.
Input Name Type
DatasetDestroy DatasetDestroy
 
Output Name Type
DatasetDestroyResult DatasetDestroyResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETFAILINGOVER
 EDATASETMIGRATING
 EDATASETNOTEMPTY
 EEDITSESSIONINPROGRESS
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetDynamicReferenceListInfoIterEnd (supported) [top]
Ends iteration of the dynamic references in the Dataset.
Input Name Type
DatasetDynamicReferenceListInfoIterEnd DatasetDynamicReferenceListInfoIterEnd
 
Output Name Type
DatasetDynamicReferenceListInfoIterEndResult DatasetDynamicReferenceListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
DatasetDynamicReferenceListInfoIterNext (supported) [top]
Get next Records in the iteration started by DatasetDynamicReferenceListInfoIterStart
Input Name Type
DatasetDynamicReferenceListInfoIterNext DatasetDynamicReferenceListInfoIterNext
 
Output Name Type
DatasetDynamicReferenceListInfoIterNextResult DatasetDynamicReferenceListInfoIterNextResult
 Error Name  Description
 EINVALIDTAG

 
DatasetDynamicReferenceListInfoIterStart (supported) [top]
Starts iteration To list the dynamic references in the Dataset. Volumes are not considered dynamic references because they are Members. (even though they can contain Qtrees)
Input Name Type
DatasetDynamicReferenceListInfoIterStart DatasetDynamicReferenceListInfoIterStart
 
Output Name Type
DatasetDynamicReferenceListInfoIterStartResult DatasetDynamicReferenceListInfoIterStartResult
 Error Name  Description
 EACCESSDENIED
 EDPPOLICYNODENOTFOUND
 EOBJECTNOTFOUND
 ESTORAGESETNOTINDATASET

 
DatasetEditBegin (supported) [top]
Obtain an edit lock To start modifying a Dataset.

Besides locking the Dataset itself, all storage sets in the Dataset are locked, as well as the data protection Policy if one is assigned.

An edit lock must be obtained before invoking the following ZAPIs:

  • DatasetAddMember
  • DatasetRemoveMember
  • DatasetAddMemberByDynamicReference
  • DatasetRemoveMemberByDynamicReference
  • DatasetSetStorageset
  • DatasetModify
  • DatasetModifyNode
  • DatasetAddResourcepool
  • DatasetRemoveResourcepool
  • DatasetProvisionMember
  • DatasetResizeMember
  • DatasetMemberDeleteSnapshots
Use DatasetEditCommit To commit the changes To the database.

Use DatasetEditRollback To undo the changes made To the Dataset.

After 24 hours, the lock can be taken by another client without the Force Option. This will cause any edits pending on the aborted session To be lost.
Input Name Type
DatasetEditBegin DatasetEditBegin
 
Output Name Type
DatasetEditBeginResult DatasetEditBeginResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETFAILINGOVER
 EDATASETMIGRATING
 EEDITSESSIONINPROGRESS
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetEditCommit (supported) [top]
Commit changes made To a Dataset into the database.

The edit lock on the Dataset will be released after the changes have been successfully committed.

Use the DryRun Option To test the commit. It invokes the conformance checker To return a list of actions that would be taken should the changes be actually committed. The DryRun Option also returns a list of high level alerts To notify the user of rebaseline operations or system level issues related To successful conformance.

If DryRun is false, then before the call returns, the system begins a conformance run on the Dataset. (See DatasetConformBegin for a Description of conformance runs.) If the system is To perform a conformance run on the Dataset it will be done with the current Dataset edit session Value for AssumeConfirmation. The default Value for AssumeConfirmation is initially true when the edit session begins, but may be altered by certain changes To the Dataset made through the use of DatasetModify. The optional AssumeConfirmation Option may be used To specify if user confirmation is To be assumed or not for this DatasetEditCommit. One Key, and sometimes undesirable, resolvable Action that requires user confirmation is the possible re-baseline of a relationship.
Input Name Type
DatasetEditCommit DatasetEditCommit
 
Output Name Type
DatasetEditCommitResult DatasetEditCommitResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETFAILINGOVER
 EDATASETMIGRATING
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONNOTFOUND

 
DatasetEditRollback (supported) [top]
Roll back changes made To a Dataset. The edit lock on the Dataset will be released after the rollback.
Input Name Type
DatasetEditRollback DatasetEditRollback
 
Output Name Type
DatasetEditRollbackResult DatasetEditRollbackResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EEDITSESSIONNOTFOUND

 
DatasetListInfoIterEnd (supported) [top]
Ends iteration To list Datasets.
Input Name Type
DatasetListInfoIterEnd DatasetListInfoIterEnd
 
Output Name Type
DatasetListInfoIterEndResult DatasetListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
DatasetListInfoIterNext (supported) [top]
Get next few Records in the iteration started by DatasetListInfoIterStart.

If a Dataset has a data protection Policy assigned To it, the HasProtectionPolicy field will be true. If the client has suspended the Dataset, HasProtectionPolicy is still true, but IsDpSuspended and IsSuspended fields are also set To true To reflect this. When the client sets IsDpIgnored To true, nothing changes, except that, when the client requests the list of Datasets which are not ignored, the ignored Datasets will not be returned.
Input Name Type
DatasetListInfoIterNext DatasetListInfoIterNext
 
Output Name Type
DatasetListInfoIterNextResult DatasetListInfoIterNextResult
 Error Name  Description
 EINVALIDTAG

 
DatasetListInfoIterStart (supported) [top]
Starts iteration To list Datasets.
Input Name Type
DatasetListInfoIterStart DatasetListInfoIterStart
 
Output Name Type
DatasetListInfoIterStartResult DatasetListInfoIterStartResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetMemberDedupeAbort (supported) [top]
Abort in-progress dedupe Operation on the given Volume member of the Dataset.
Input Name Type
DatasetMemberDedupeAbort DatasetMemberDedupeAbort
 
Output Name Type
DatasetMemberDedupeAbortResult DatasetMemberDedupeAbortResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDEDUPEABORTNOTSUPPORTED
 EDEDUPENOTRUNNING
 EINTERNALERROR
 EINVALIDINPUT
 EJOBALREADYABORTED
 EJOBALREADYCOMPLETED
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetMemberDedupeStart (supported) [top]
Start deduplication Operation on specified Volume member of the given Dataset.
Input Name Type
DatasetMemberDedupeStart DatasetMemberDedupeStart
 
Output Name Type
DatasetMemberDedupeStartResult DatasetMemberDedupeStartResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDEDUPEALREADYRUNNING
 EDEDUPENOTSUPPORTED
 EINTERNALERROR
 EINVALIDINPUT
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetMemberDeleteSnapshots (supported) [top]
Delete Snapshot copies of a Volume which is a member of the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the root node of the Dataset. The effective primary of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The deletion of Snapshot copies happens in the background.

A provisioning job Id is returned in DatasetEditCommit zapi that represents the job which will delete the specified Snapshot copies. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId. Error conditions:

  • EACCESSDENIED - User does not have privileges To delete Snapshot copies of the member.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EOBJECTNOTFOUND - No Volume by the given Name or identifier was found.
  • ENOTINDATASET - Member is not in the primary node of the specified Dataset.
  • EOBJECTAMBIGUOUS - The specified member Name could refer To two or more Objects. Try again with the object identifier or object full Name.
  • EINVALIDINPUT - No Snapshot copies are specified for deletion or both VolumeId and VolumeName are not given in input or at least one of the Snapshot copies specified for deletion is marked busy.
  • ESNAPSHOTNOTFOUND - At least one of the Snapshot copy specified is not found on the Volume.
  • EEDITSESSIONNOTFOUND - If the edit session specified in input is not found
  • EEDITSESSIONOBJECTALREADYLOCKED - If the object being tried To lock in this Operation is already locked by some other edit session
  • EEDITSESSIONCONFLICTINGOP - If this Snapshot deletion Operation is conflicting with some other edit Operation in the same edit session
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Input Name Type
DatasetMemberDeleteSnapshots DatasetMemberDeleteSnapshots
 
Output Name Type
DatasetMemberDeleteSnapshotsResult DatasetMemberDeleteSnapshotsResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETNOTINSTABLEDRSTATE
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EEDITSESSIONOBJECTALREADYLOCKED
 EINVALIDINPUT
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetMemberListInfoIterEnd (supported) [top]
Ends iteration of Dataset Members.
Input Name Type
DatasetMemberListInfoIterEnd DatasetMemberListInfoIterEnd
 
Output Name Type
DatasetMemberListInfoIterEndResult DatasetMemberListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
DatasetMemberListInfoIterNext (supported) [top]
Get next Records in the iteration started by DatasetMemberListInfoIterStart
Input Name Type
DatasetMemberListInfoIterNext DatasetMemberListInfoIterNext
 
Output Name Type
DatasetMemberListInfoIterNextResult DatasetMemberListInfoIterNextResult
 Error Name  Description
 EINVALIDTAG

 
DatasetMemberListInfoIterStart (supported) [top]
Starts iteration To list Members of the Dataset. Dynamic references are not returned by this API, nor are Objects only associated with the Dataset by their inclusion in a dynamic reference.
Input Name Type
DatasetMemberListInfoIterStart DatasetMemberListInfoIterStart
 
Output Name Type
DatasetMemberListInfoIterStartResult DatasetMemberListInfoIterStartResult
 Error Name  Description
 EACCESSDENIED
 EDPPOLICYNODENOTFOUND
 EOBJECTNOTFOUND
 ESTORAGESETNOTINDATASET

 
DatasetMemberUndedupeStart (supported) [top]
Start undeduplication Operation on specified Volume member of the given Dataset.
Input Name Type
DatasetMemberUndedupeStart DatasetMemberUndedupeStart
 
Output Name Type
DatasetMemberUndedupeStartResult DatasetMemberUndedupeStartResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EINTERNALERROR
 EINVALIDINPUT
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND
 EUNDEDUPENOTSUPPORTED

 
DatasetMissingMemberListInfoIterEnd (supported) [top]
Ends iteration of missing Dataset Members.
Input Name Type
DatasetMissingMemberListInfoIterEnd DatasetMissingMemberListInfoIterEnd
 
Output Name Type
DatasetMissingMemberListInfoIterEndResult DatasetMissingMemberListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
DatasetMissingMemberListInfoIterNext (supported) [top]
Get next Records in the iteration started by DatasetMemberListInfoIterStart
Input Name Type
DatasetMissingMemberListInfoIterNext DatasetMissingMemberListInfoIterNext
 
Output Name Type
DatasetMissingMemberListInfoIterNextResult DatasetMissingMemberListInfoIterNextResult
 Error Name  Description
 EINVALIDTAG

 
DatasetMissingMemberListInfoIterStart (supported) [top]
Starts iteration To list Members of the Dataset that have gone missing. The way the server determines if an object was not intentionally removed From the Dataset is:
  1. The object is still a Dataset member.
  2. The object's objDeleted flag is set.
Input Name Type
DatasetMissingMemberListInfoIterStart DatasetMissingMemberListInfoIterStart
 
Output Name Type
DatasetMissingMemberListInfoIterStartResult DatasetMissingMemberListInfoIterStartResult
 Error Name  Description
 EACCESSDENIED
 EOBJECTNOTFOUND

 
DatasetModify (supported) [top]
Modify Attributes for a Dataset.
Input Name Type
DatasetModify DatasetModify
 
Output Name Type
DatasetModifyResult DatasetModifyResult
 Error Name  Description
 EAPILICENSE
 EDATABASEERROR
 EDATASETEXISTS
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTNDRESTORE
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EEDITSESSIONOBJECTALREADYLOCKED
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND
 ESERVICEISATTACHED

 
DatasetModifyNode (supported) [top]
Modify Attributes of a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the data protection Policy node that maps To it. You may change the storage set's Resource pool and Timezone using this call, but not its Name or Description.

Within the same edit session in which you call DatasetModifyNode, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was foundthat has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EINVALIDTIMEZONE - The given Timezone Name is not valid.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
  • EDSCONFLICTCANTMIRROROSSV - OSSV is not allowed in mirror Source node.
  • EDSCONFLICTCANTSNAPSHOTOSSV - Cannot apply Snapshot schedule To OSSV.
  • EDSCONFLICTINCOMPATIBLEPOLICY - Policy is not compatible with application Dataset.
  • EDSCONFLICTOSSVNOTALLOWED - OSSV is not allowed in the Dataset.
  • EDSCONFLICTNOSMLICENSE - There is no SnapMirror License installed.
  • EDSCONFLICTNOSMSVLICENSE - There is no SnapMirror or SnapVault License installed. Need To have at least one of them installed.
  • EDSCONFLICTROOTNODE - Operation cannot be performed on root node of Dataset.
  • EDSCONFLICTNOTROOTNODE - Operation cannot be performed on non-root node of Dataset.
  • EDSCONFLICTNOTLEAFNODE - Operation cannot be performed on non-leaf node of Dataset.
  • EDSCONFLICTINVALIDVFILER - Dataset node has Members that do not belong To the vFiler being attached.
  • EDSCONFLICTDEDUPLICATION - A deduplication schedule enabled provisioning Policy cannot be associated with SnapVault destinations.
Input Name Type
DatasetModifyNode DatasetModifyNode
 
Output Name Type
DatasetModifyNodeResult DatasetModifyNodeResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTINVALIDVFILER
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EINVALIDINPUT
 EINVALIDTIMEZONE
 ENODENOTDRCAPABLE
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND
 ESERVICEISATTACHED
 ESTORAGESETNOTINDATASET

 
DatasetProvisionMember (supported) [top]
Provision a new member into the effective primary node of a Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary node of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

Error conditions:

  • EINVALIDINPUT - If the inputs specified are not valid.
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To provision a member.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Input Name Type
DatasetProvisionMember DatasetProvisionMember
 
Output Name Type
DatasetProvisionMemberResult DatasetProvisionMemberResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETNOTINSTABLEDRSTATE
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EINVALIDINPUT
 ESTORAGESETNOTINDATASET

 
DatasetRemoveMember (supported) [top]
Remove member From a Dataset. Only Members explicitly added To the Dataset (direct Members) can be removed.

If "Destroy" is true, even indirect Members can be destroyed on the storage system and removed From the Dataset.

If "Destroy" is true, then it is applicable only on Members of the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary node of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The Destroy Operation happens in the background.

A provisioning job Id is returned in DatasetEditCommit api that represents the job which will resize the member as specified. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId.
Input Name Type
DatasetRemoveMember DatasetRemoveMember
 
Output Name Type
DatasetRemoveMemberResult DatasetRemoveMemberResult
 Error Name  Description
 EACCESSDENIED
 ECANNOTDESTROYSTORAGE
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EINVALIDOBJECTTYPE
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetRemoveMemberByDynamicReference (supported) [top]
Remove dynamic references From a Dataset. Only dynamic_references explicitly added To the Dataset can be removed.
Input Name Type
DatasetRemoveMemberByDynamicReference DatasetRemoveMemberByDynamicReference
 
Output Name Type
DatasetRemoveMemberByDynamicReferenceResult DatasetRemoveMemberByDynamicReferenceResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetRemoveResourcepool (supported) [top]
Remove Resource pool From a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the Policy node that maps To it.

Within the same edit session in which you call DatasetRemoveResourcepool, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's protection Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
Input Name Type
DatasetRemoveResourcepool DatasetRemoveResourcepool
 
Output Name Type
DatasetRemoveResourcepoolResult DatasetRemoveResourcepoolResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND
 ESERVICEISATTACHED
 ESTORAGESETNOTINDATASET

 
DatasetReplacePrimaryMembers (supported) [top]
Replace primary Members and relationships after a failover.

If a secondary Volume or Qtree is specified, it replaces the primary member for just that secondary Volume or Qtree. If neither are specified, it replaces all primary Members that need To be replaced.

If DryRun is specified, it returns the Results of the Operation that would be taken should the Operation be committed.
Input Name Type
DatasetReplacePrimaryMembers DatasetReplacePrimaryMembers
 
Output Name Type
DatasetReplacePrimaryMembersResult DatasetReplacePrimaryMembersResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETFAILINGOVER
 EDATASETNOTDRCAPABLE
 EDATASETNOTINFAILEDOVERSTATE
 EEDITSESSIONINPROGRESS
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetResizeMember (supported) [top]
Resize, change Maximum capacity and change snap reserve for a Dataset member on the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary of a disaster recovery data set in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The resize Operation happens in the background.

A provisioning job Id is returned in DatasetEditCommit zapi that represents the job which will resize the member as specified. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId. Error conditions:

  • EACCESSDENIED - User does not have the Capability DFM.ResourcePool.Provision on the containing Resource pool for a Volume that is being resized.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EOBJECTNOTFOUND - No Volume or Qtree member by the given Name or identifier was found.
  • ENOTINDATASET - Member is not in the primary node of the specified Dataset.
  • EOBJECTAMBIGUOUS - The specified member Name could refer To two or more Objects. Try again with the object identifier or object full Name.
  • EINVALIDINPUT - Both MemberId and MemberName are not specified, inputs other than NewSize are specified for a Qtree member, Size parameters are being changed for traditional Volumes.
  • EEDITSESSIONNOTFOUND - If the edit session specified in input is not found
  • EEDITSESSIONOBJECTALREADYLOCKED - If the object being tried To lock in this Operation is already locked by some other edit session
  • EEDITSESSIONCONFLICTINGOP - If this resize Operation is conflicting with some other edit Operation in the same edit session
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Input Name Type
DatasetResizeMember DatasetResizeMember
 
Output Name Type
DatasetResizeMemberResult DatasetResizeMemberResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EDATASETNOTINSTABLEDRSTATE
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EEDITSESSIONOBJECTALREADYLOCKED
 EINVALIDINPUT
 ENOTINDATASET
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
DatasetSet (supported) [top]
Set Dataset Options.
Input Name Type
DatasetSet DatasetSet
 
Output Name Type
DatasetSetResult DatasetSetResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EOBJECTNOTFOUND

 
DatasetSetStorageset (supported) [top]
Change the storage sets associated with Policy nodes. It is legal To change many storage set/node mappings in an edit session.
Input Name Type
DatasetSetStorageset DatasetSetStorageset
 
Output Name Type
DatasetSetStoragesetResult DatasetSetStoragesetResult
 Error Name  Description
 EACCESSDENIED
 EDPPOLICYNODENOTFOUND
 EDSCONFLICTALREADYINDATASET
 EDSCONFLICTALREADYINRESPOOL
 EDSCONFLICTCANTMIRROROSSV
 EDSCONFLICTCANTSNAPSHOTOSSV
 EDSCONFLICTINCOMPATIBLEPOLICY
 EDSCONFLICTNOSMLICENSE
 EDSCONFLICTNOSMSVLICENSE
 EDSCONFLICTNOTLEAFNODE
 EDSCONFLICTNOTROOTNODE
 EDSCONFLICTOSSVNOTALLOWED
 EDSCONFLICTROOTNODE
 EDSCONFLICTSRCDESTINSAMEAGGR
 EEDITSESSIONCONFLICTINGOP
 EEDITSESSIONNOTFOUND
 EEDITSESSIONOBJECTALREADYLOCKED
 EOBJECTNOTFOUND
 ESERVICEISATTACHED

 
DatasetUpdateDrStatus (supported) [top]
Update disaster recovery Status for a Dataset.
Input Name Type
DatasetUpdateDrStatus DatasetUpdateDrStatus
 
Output Name Type
DatasetUpdateDrStatusResult DatasetUpdateDrStatusResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EOBJECTNOTFOUND

 
DatasetUpdateProtectionStatus (supported) [top]
Update protection Status for a Dataset.
Input Name Type
DatasetUpdateProtectionStatus DatasetUpdateProtectionStatus
 
Output Name Type
DatasetUpdateProtectionStatusResult DatasetUpdateProtectionStatusResult
 Error Name  Description
 EACCESSDENIED
 EDATABASEERROR
 EOBJECTNOTFOUND

 
Element definition: DatasetAddMember [top]
Add Members To an existing Dataset.

This API is for adding direct member Objects To one or more storage sets in the Dataset. Each storage set is identified by the data protection Policy node associated with it.

The types of storage Objects allowed To be added vary:

  • Volumes, Qtrees and OSSV Directories are allowed in the storage set attached To a primary Policy node.
  • Only Volumes are allowed in a storage sets attached To secondary/destination nodes.
It is legal To add storage Objects To multiple storage sets in a single call.
Name Type Description
DatasetMemberParameters ArrayOfDatasetMemberParameter
List of Members To add To the Dataset.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]
IsExistingMemberOk xsd:boolean
optional
If specified, the call will not return an Error if one or more Objects being added is already a member of the specified node. If an ancestor or child of an object is already a member, an Error will still be returned. By default, IsExistingMemberOk is false.

 
Element definition: DatasetAddMemberByDynamicReference [top]
Add dynamic reference To an existing Dataset.

By adding a dynamic reference, the Volumes, Qtrees, and ossv Directories referred To by the dynamic reference become implicit (indirect) Members of the Dataset. A dynamic reference can be added To a particular storage set in the Dataset by specifying the data protection Policy node associated with it. If necessary a new storage set is first created automatically before adding storage Objects To it.

The types of storage Objects allowed To be added vary:

  • Storage systems, vFiler units, Aggregates and OSSV Hosts can be attached To a primary Policy node.
  • Storage systems, vFiler units and Aggregates are allowed in storage sets attached To secondary/destination nodes.
It is legal To add storage Objects To multiple storage sets in a single call.
Name Type Description
DatasetDynamicReferenceParameters ArrayOfDatasetDynamicReferenceParameter
List of dynamic-references To add To the Dataset.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]

 
Element definition: DatasetAddMemberByDynamicReferenceResult [top]
[none]

 
Element definition: DatasetAddMemberResult [top]
[none]

 
Element definition: DatasetAddResourcepool [top]
Add Resource pool To a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the Policy node that maps To it.

Within the same edit session in which you call DatasetAddResourcepool, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's protection Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set or does not have DFM.ResourcePool.Provision on the specified Resource pool.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the node in the data protection Policy that maps To the storage set. DpNodeName must Match exactly the Name of one of the nodes in the data protection Policy that is currently assigned To the data set.

If DpNodeName is not specified, then the storage set associated with the root node is modified.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset that was obtained by an earlier call To DatasetEditBegin. Range: [1..2^31-1]
ResourcepoolNameOrId ObjNameOrId
Name or object identifier of a Resource pool To add To the storage set.

 
Element definition: DatasetAddResourcepoolResult [top]
[none]

 
Element definition: DatasetBeginFailover [top]
Begin failover of a Dataset.

This API begins the process of failing over a Dataset To its disaster recovery storage. The failover process will break any mirror relationships between the primary and DR storage Objects and make the secondary storage available for use.

This API may only be invoked if the DR state of the data set is "ready".

Specifically, when the ZAPI runs, the following actions will take place:

  1. The DR state of the Dataset will immediately change To "failing_over".
  2. Any pending conformance tasks will be cancelled.
  3. Any Jobs running against this Dataset will be aborted.
  4. A failover job will be started To break any mirrors between the primary storage set and the DR storage set
  5. Finally, the DR state of the Dataset will be updated To either "failed_over" or "failover_error" based on whether the failover job succeeded or not.
Name Type Description
DatasetNameOrId xsd:string
Name or ID of Dataset.

 
Element definition: DatasetBeginFailoverResult [top]
Name Type Description
JobId xsd:integer
Identifier of the failover job that is failing the Dataset over To its DR secondary. If there was an Error, the job Id will be 0. Range: [1..2^31-1]

 
Element definition: DatasetBeginFailoverScriptTest [top]
Begin test failover of a Dataset that only runs the the failover scripts and does not dequeue tasks, abort Jobs or change the DrState.
Name Type Description
DatasetNameOrId xsd:string
Name or ID of Dataset.

 
Element definition: DatasetBeginFailoverScriptTestResult [top]
Name Type Description
JobId xsd:integer
Identifier of the failover job that is just running the DR scripts for the Dataset. If there was an Error, the job Id will be 0. Range: [1..2^31-1]

 
Element definition: DatasetChangeDrState [top]
Change the disaster recovery state of a Dataset.

This API sets the DR state of a Dataset To a new Value. Users may perform the following DR state transitions using this ZAPI:

  • From "failover_error" To "failed_over".
  • From "failover_error" To "ready".
  • From "failed_over" To "ready".

If the "AllowInternalTransitions" element is present and true, the caller may make additional state transitions:

  • From "ready" To "failing_over"
  • From "failing_over" To "failed_over"
  • From "failing_over" To "failover_error"
These state transitions are intended To be used by Protection Manager server processes as part of a failover or failback sequence. Any attempt To perform other state transition will fail with an Error code of EDATASETWRONGDRSTATE.

The DR state of a Dataset will also change in one special case:

  • The Dataset is in a "failed_over" DR state
  • The caller changes the data protection Policy
  • The caller maps the storage set for the DR node of the old Policy To the root node of the new Policy (using DatasetSetStorageset)
When the edit session with these modifications is committed, the DR state will be set back To "ready".
Name Type Description
AllowInternalTransitions xsd:boolean
optional
If present and true, allow server-only state transitions (e.g. From "failing_over" To "failed_over"). If not present or false, only allow user-initiated state transitions.
DatasetNameOrId ObjNameOrId
Name or ID of Dataset.
DrState DrState
Desired DR state of Dataset.

 
Element definition: DatasetChangeDrStateResult [top]
[none]

 
Element definition: DatasetConformBegin [top]
Begin a conformance run on a Dataset, To attempt To bring it into conformance with its data protection Policy and provisioning Policy. A conformance run consists of two main steps:
  • Perform a conformance check To determine both the Dataset's current conformance Status, and the set of actions needed To bring the Dataset into conformance.
  • Perform the conformance actions needed To bring the Dataset into conformance.
In addition, the Dataset's conformance Status is updated at various points during the conformance run. Whenever the conformance Status is updated, an event of Type "Dataset.conformance" is generated.

Successful completion of this ZAPI indicates that: the conformance check has completed successfully, the Dataset's conformance Status has been updated based on the Results of the conformance check, and the system has begun To take any needed conformance actions.

After the ZAPI returns, the system continues To perform conformance actions in the background, until all actions complete. Once all actions have completed, the Dataset's conformance Status is again updated. Note that at present, there is no ZAPI Interface for determining when all actions have completed.

If no Policy has been assigned To the Dataset, the conformance run completes immediately and performs no conformance actions.

Error conditions:
  • EACCESSDENIED - User does not have privileges To access the Dataset.
  • EOBJECTNOTFOUND - No Dataset was found that has the given Name or ID.
  • EDATABASEERROR - A database Error occurred while processing the Request.
Name Type Description
AssumeConfirmation xsd:boolean
optional
Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. One Key and sometimes undesirable resolvable conformance Action is the possible re-baseline of one or more relationships. If the Value is true, all conformance actions which require user confirmation will be executed as if confirmation is already granted. If the Value is false, all conformance actions which require user confirmation will not be executed. Default Value is false.
DatasetNameOrId ObjNameOrId
Name or object ID for the Dataset.

 
Element definition: DatasetConformBeginResult [top]
[none]

 
Element definition: DatasetCreate [top]
Create a new, empty Dataset.
Name Type Description
ApplicationInfo ApplicationInfo
optional
If IsApplicationData is true, then this element will contain information about the application which manages this Dataset.
DatasetAccessDetails DatasetAccessDetails
optional
Data access details for a Dataset that needs To be configured and provisioned in a way that it is capable of transparent migration. This enables all the storage in the primary node of the Dataset To be migrated To a different physical Resource without having To reconfigure the clients accessing this storage.
DatasetContact EmailAddressList
optional
Contact for the Dataset, such as the owner's e-mail Address.
DatasetDescription xsd:string
optional
Description of the new Dataset, up To 255 characters long.
DatasetMetadata ArrayOfDfmMetadataField
optional
Opaque metadata for Dataset. Metadata is usually set and interpreted by an application that is using the Dataset. DFM does not look into the contents of the metadata.
DatasetName ObjName
Name of the new Dataset. It cannot be all numeric. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned.
DatasetOwner xsd:string
optional
Name of the owner of the Dataset, up To 255 characters long.
GroupNameOrId ObjNameOrId
optional
Resource Group To which the newly created Dataset should be added To. User should have DFM.Dataset.Write Capability on the specified Group. Default Value: Global Group.
IsApplicationData xsd:boolean
optional
If true, the Dataset is an application Dataset managed by an external application. The default Value is false.
IsDpSuspended xsd:boolean
optional
Flag indicating whether or not the Dataset should be protected. This also indicates whether conformance checking of the Dataset is To be done or not. Default is False.

Deprecated field. Retained for backward compatibility. This field is deprecated in favour of IsSuspended, which suspends the Dataset for all automated actions (data protection and conformance check of the Dataset).
IsSuspended xsd:boolean
optional
True if an administrator has chosen To suspend this Dataset for all automated actions (data protection and conformance check of the Dataset). Default is False. If present, this field takes precedence over IsDpSuspended.
OnlineMigration xsd:boolean
optional
Indicates, that the Dataset will be capable of non-disruptive migration. By default the migration will be disruptive. Default: false.
ProtectionPolicyId ObjId
optional
Identifier of the protection Policy To associate with this Dataset. This legacy parameter is only used if ProtectionPolicyNameOrId is not supplied. The dataprotection License is required for this input.
ProtectionPolicyNameOrId ObjNameOrId
optional
Name or identifier of the protection Policy To associate with this Dataset. This input is preferred over ProtectionPolicyId and if supplied then do not supply ProtectionPolicyId because ProtectionPolicyId will be ignored. The dataprotection License is required for this input.
ProvisioningPolicyNameOrId ObjNameOrId
optional
Name or identifier of the provisioning Policy To be associated with the primary node of the Dataset. The Members of the primary node are provisioned based on this Policy. Once the provisioning Policy is associated with the Dataset node, the storage in the node is periodically monitored for conformance with the Policy.
RequiresNonDisruptiveRestore RequiresNonDisruptiveRestore
optional
Specifies whether the Dataset should be configured To enable non-disruptive restores From backup destinations.

Default Value is false.
TimezoneName xsd:string
optional
Timezone To assign To the root node. If specified, the Value must be a TimezoneName returned by TimezoneListInfoIterNext. If no Timezone is assigned, then the default system Timezone will be used.
VfilerNameOrId ObjNameOrId
optional
Name or identifier of the vFiler Unit To be attached To the primary node of the Dataset. If a vFiler Unit is attached, then all Members provisioned into this node will be exported over this vFiler Unit.
VolumeQtreeNamePrefix xsd:string
optional
Prefix for Volume and Qtree names, up To 60 characters long. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned.

 
Element definition: DatasetCreateResult [top]
Name Type Description
DatasetId ObjId
Identifier of the new Dataset.

 
Element definition: DatasetDestroy [top]
Destroy a Dataset. The Dataset must be empty unless the "Force" Option is used.
Name Type Description
CancelEditSessions xsd:boolean
optional
Specifies if edit operations in progress on the Dataset should be cancelled.

If true, any edit operations in progress on the Dataset are rolled back before destroying the Dataset.

If CancelEditSessions is false, Dataset with pending edit operations cannot be destroyed.

Default is false.
DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset To Destroy.
Force xsd:boolean
optional
If true, allows destroying a Dataset that has Members or dynamic references. By default, only empty Datasets can be destroyed.

 
Element definition: DatasetDestroyResult [top]
[none]

 
Element definition: DatasetDynamicReferenceListInfoIterEnd [top]
Ends iteration of the dynamic references in the Dataset.
Name Type Description
Tag xsd:string
Tag From a previous DatasetDynamicReferenceListInfoIterStart.

 
Element definition: DatasetDynamicReferenceListInfoIterEndResult [top]
[none]

 
Element definition: DatasetDynamicReferenceListInfoIterNext [top]
Get next Records in the iteration started by DatasetDynamicReferenceListInfoIterStart
Name Type Description
Maximum xsd:integer
The Maximum number of Records To retrieve.
Tag xsd:string
Tag From a previous DatasetDynamicReferenceListInfoIterStart.

 
Element definition: DatasetDynamicReferenceListInfoIterNextResult [top]
Name Type Description
DatasetDynamicReferences ArrayOfDatasetDynamicReferenceInfo
List of the dynamic references in the Dataset.
Records xsd:integer
The number of Records actually returned.

 
Element definition: DatasetDynamicReferenceListInfoIterStart [top]
Starts iteration To list the dynamic references in the Dataset. Volumes are not considered dynamic references because they are Members. (even though they can contain Qtrees)
Name Type Description
DatasetNameOrId ObjNameOrId
Name or identifier of Dataset whose dynamic references will be listed.
DpNodeName DpPolicyNodeName
optional
List only the Members in this Policy node. If none is specified, then list Members in all Policy nodes. If both DpNodeName and StoragesetNameOrId are specified, then the Value of DpNodeName is ignored.
IncludeDeleted xsd:boolean
optional
If present and true, dynamic references which are marked as deleted in the database are also returned. Otherwise, deleted dynamic references are not returned.
IncludeIsAvailable xsd:boolean
optional
If true, the IsAvailable Status is calculated for each member which may make the call To this zapi take much longer. Default is false.
StoragesetNameOrId ObjNameOrId
optional
List only the Members in this storage set. If none is specified, then list Members in all storagesets mapped To this Dataset's nodes. If both DpNodeName and StoragesetNameOrId are specified, then the Value of DpNodeName is ignored.
SuppressStatusRefresh xsd:boolean
optional
If true, do not refresh the dynamic_reference Status. If false or omitted, the Status of all dynamic references will be refreshed before being returned.

 
Element definition: DatasetDynamicReferenceListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of items that have been saved for future retrieval with DatasetDynamicReferenceListInfoIterNext.
Tag xsd:string
Tag To be used in subsequent calls To DatasetDynamicReferenceListInfoIterNext.

 
Element definition: DatasetEditBegin [top]
Obtain an edit lock To start modifying a Dataset.

Besides locking the Dataset itself, all storage sets in the Dataset are locked, as well as the data protection Policy if one is assigned.

An edit lock must be obtained before invoking the following ZAPIs:

  • DatasetAddMember
  • DatasetRemoveMember
  • DatasetAddMemberByDynamicReference
  • DatasetRemoveMemberByDynamicReference
  • DatasetSetStorageset
  • DatasetModify
  • DatasetModifyNode
  • DatasetAddResourcepool
  • DatasetRemoveResourcepool
  • DatasetProvisionMember
  • DatasetResizeMember
  • DatasetMemberDeleteSnapshots
Use DatasetEditCommit To commit the changes To the database.

Use DatasetEditRollback To undo the changes made To the Dataset.

After 24 hours, the lock can be taken by another client without the Force Option. This will cause any edits pending on the aborted session To be lost.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset To edit.
Force xsd:boolean
optional
By default, Force is false. If true, and an edit is already in progress on the specified Dataset or an object the Dataset is dependent on (such as a data protection Policy), the previous edit session is rolled back and a new edit session is begun.

 
Element definition: DatasetEditBeginResult [top]
Name Type Description
EditLockId xsd:integer
Identifier of the edit lock on the Dataset. Range: [1..2^31-1]

 
Element definition: DatasetEditCommit [top]
Commit changes made To a Dataset into the database.

The edit lock on the Dataset will be released after the changes have been successfully committed.

Use the DryRun Option To test the commit. It invokes the conformance checker To return a list of actions that would be taken should the changes be actually committed. The DryRun Option also returns a list of high level alerts To notify the user of rebaseline operations or system level issues related To successful conformance.

If DryRun is false, then before the call returns, the system begins a conformance run on the Dataset. (See DatasetConformBegin for a Description of conformance runs.) If the system is To perform a conformance run on the Dataset it will be done with the current Dataset edit session Value for AssumeConfirmation. The default Value for AssumeConfirmation is initially true when the edit session begins, but may be altered by certain changes To the Dataset made through the use of DatasetModify. The optional AssumeConfirmation Option may be used To specify if user confirmation is To be assumed or not for this DatasetEditCommit. One Key, and sometimes undesirable, resolvable Action that requires user confirmation is the possible re-baseline of a relationship.
Name Type Description
AssumeConfirmation xsd:boolean
optional
Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. If the Value is true, all conformance actions which require user confirmation will be executed as if confirmation is already granted. If the Value is false, all conformance actions which require user confirmation will not be executed. The default Value is initially true when the edit session begins, but may be altered by certain changes To the Dataset made through the use of DatasetModify. One Key, and sometimes undesirable, resolvable Action that requires user confirmation is the possible re-baseline of a relationship.
DryRun xsd:boolean
optional
If true, return the DryRunResults list as well as the ConformanceAlerts list. The DryRunResults list contains actions that would be taken should the changes be committed without actually committing the changes. The ConformanceAlerts list contains high level alerts To notify a user of conditions that will impact any attempt To commit the changes. A conformance alert may warn that if the changes are committed, one or more rebaseline operations may be done. The conformance alerts may also warn of conditions that exist that may prevent the succesful conformance of Datasets. The edit lock is not released after a dry run. By default, DryRun is false.
EditLockId xsd:integer
Identifier of the edit lock on the Dataset. Range: [1..2^31-1]
IncludeDryRunReasonDetails xsd:boolean
optional
If true or omitted, then include any possible DryRunReasonDetails along with the associated DryRunResult element. Default Value is true. If false, the DryRunReasonDetails will not be returned.

 
Element definition: DatasetEditCommitResult [top]
Name Type Description
ConformanceAlerts ArrayOfConformanceAlert
optional
Alerts that apply To the conformance check. Each alert describes one Type of Condition that a user should be aware of before attempting To conform any more Datasets. Only returned if DryRun is true.
DryRunResults ArrayOfDryRunResult
optional
Results of a dry run. Each Result describes one Action the system would take and the predicted effects of that Action. Only returned if DryRun is true.
IsProvisioningFailure xsd:boolean
optional
This element is returned only if DryRun is true and only when there was a provisioning Request issued in the edit session. If the dry run shows Errors for the provisioning Request its Value is TRUE, else FALSE. This element can be used by clients To distinguish the case where provisioning job will succeed, but the dry run contains Dataset conformance related Errors.
JobIds ArrayOfJobInfo
optional
Job identifiers of provisioning requests or Dataset reexport Jobs. This output element is present only if
  • 1. There were any provisioning requests issued in the edit session.
  • 2. The Dataset is reexported due To change in provisioning Policy.
This is returned only if DryRun is false.

 
Element definition: DatasetEditRollback [top]
Roll back changes made To a Dataset. The edit lock on the Dataset will be released after the rollback.
Name Type Description
EditLockId xsd:integer
Identifier of the edit lock on the Dataset. Range: [1..2^31-1]

 
Element definition: DatasetEditRollbackResult [top]
[none]

 
Element definition: DatasetListInfoIterEnd [top]
Ends iteration To list Datasets.
Name Type Description
Tag xsd:string
Tag From a previous DatasetListInfoIterStart.

 
Element definition: DatasetListInfoIterEndResult [top]
[none]

 
Element definition: DatasetListInfoIterNext [top]
Get next few Records in the iteration started by DatasetListInfoIterStart.

If a Dataset has a data protection Policy assigned To it, the HasProtectionPolicy field will be true. If the client has suspended the Dataset, HasProtectionPolicy is still true, but IsDpSuspended and IsSuspended fields are also set To true To reflect this. When the client sets IsDpIgnored To true, nothing changes, except that, when the client requests the list of Datasets which are not ignored, the ignored Datasets will not be returned.
Name Type Description
Maximum xsd:integer
The Maximum number of entries To retrieve.
Tag xsd:string
Tag From a previous DatasetListInfoIterStart.

 
Element definition: DatasetListInfoIterNextResult [top]
Name Type Description
Datasets ArrayOfDatasetInfo
List of Datasets.
Records xsd:integer
The number of Records actually returned.

 
Element definition: DatasetListInfoIterStart [top]
Starts iteration To list Datasets.
Name Type Description
ApplicationName xsd:string
optional
Return only application Datasets managed by a particular Type of application. Up To 255 characters long.
ApplicationServerName xsd:string
optional
Return only application Datasets managed by an application running on a particular server. Up To 255 characters long.
DrState DrState
optional
Filter by DrState Value. If no DrState input is supplied, all Datasets will be listed.
HasProtection xsd:boolean
optional
If true, only list Datasets which have a data protection Policy and at least 1 relationship associated with them or the Policy has only 1 node. If false, only list Datasets which do not have any associated Policy or Datasets which have Policy with more than 1 node but do not have any associated relationship. If not set, list all Datasets.
HasProtectionPolicy xsd:boolean
optional
If true, only list Datasets which have a data protection Policy assigned To them. If false, only list Datasets which do not have any data protection Policy assigned. If not set, list all Datasets.
IncludeConformanceCheckResults xsd:boolean
optional
If true, return the detailed conformance check Results. If false or omitted, the conformance check Results, which are expensive To retrieve, will not be returned.
IncludeConformanceRunReasonDetails xsd:boolean
optional
If true or omitted and IncludeConformanceCheckResults is also true, then include any possible ConformanceRunReasonDetails along with the associated ConformanceRunResult element. Default Value is true. If false, the ConformanceRunReasonDetails, will not be returned.
IncludeExportSettings xsd:boolean
optional
If true, the export settings for the Dataset nodes will be present in the output of DatasetListInfoIterNext. Default Value is false.
IncludeMetadata xsd:boolean
optional
If true, returns Dataset's metadata. If false, metadata, which can be large in Size, is not returned. Default is false.
IncludeMigrationInfo xsd:boolean
optional
If true, the migration information for the Dataset is returned in DatasetListInfoIterNext. Default is false.
IncludeProtectionStatusProblems xsd:boolean
optional
If true, return the detailed ProtectionStatusProblems if the Dataset does not have protection Status as "protected". Setting IncludeProtectionStatusProblems To true will generate an Error unless only one Dataset is specified From the other input parameters. If false or omitted, ProtectionStatusProblems, which can be expensive To retrieve, will not be returned.
IsApplicationData xsd:boolean
optional
If true, return only Datasets managed by an application. If false, return only Datasets which are not managed by an application. By default, return all Datasets.
IsDpIgnored xsd:boolean
optional
If true, only list Datasets that have been set To be ignored for purposes of data protection. If false, only list Datasets that have been not set To be ignored for purposes of data protection. If not specified, list all Datasets without taking into account whether they have been ignored or not.
IsDrCapable xsd:boolean
optional
If true, return only Datasets with dp policies that are disaster recovery capable. If false, return only Datasets with policies that are not disaster recovery capable. By default, return all Datasets.
IsProtected xsd:boolean
optional
If true, only list Datasets which have a data protection Policy assigned To them. If false, only list Datasets which do not have any data protection Policy assigned. If not set, list all Datasets.

Deprecated field. Retained for backward compatibility. This field is deprecated and To be replaced by HasProtectionPolicy.
ObjectNameOrId ObjNameOrId
optional
Name or identifier of a Dataset or Resource Group or provisioning Policy or storage Service. If a Resource Group is given, only the Datasets which are direct Members of the Group are returned. If a provisioning Policy is given, only those Datasets where one or more of its nodes is associated with the provisioning Policy are returned. If storage Service is given, only those Datasets which are associated with the storage Service are are returned.
RequiresNonDisruptiveRestore RequiresNonDisruptiveRestore
optional
If true, return only Datasets requiring non-disruptive restore. If false, return only Datasets which do not require non-disruptive restore. By default, return all Datasets.
SuppressStatusRefresh xsd:boolean
optional
If true, do not refresh the Dataset Status. If false or omitted, the Status of all queried Datasets will be re-calculated before being returned.
VolumeQtreeNamePrefix xsd:string
optional
Return only Datasets with a particular Type of custom Name prefix. Up To 60 characters long.

 
Element definition: DatasetListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of Records that have been saved for future retrieval with DatasetListInfoIterNext.
Tag xsd:string
Tag To be used in subsequent calls To DatasetListInfoIterNext.

 
Element definition: DatasetMemberDedupeAbort [top]
Abort in-progress dedupe Operation on the given Volume member of the Dataset.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or identifier of Dataset.
VolumeNameOrId ObjNameOrId
Name or identifier of a Volume member of the Dataset.

 
Element definition: DatasetMemberDedupeAbortResult [top]
Name Type Description
JobId xsd:integer
optional
Id of the job that handles the deduplication Operation. This is returned only if there is an on-demand deduplication job running and will not be present if the deduplication Operation was triggered by the storage system.
Range: [1..2^31-1]

 
Element definition: DatasetMemberDedupeStart [top]
Start deduplication Operation on specified Volume member of the given Dataset.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or Identifier of the Dataset.
DedupeMemberRequestInfo DedupeMemberRequestInfo
Details on member To be deduplicated.

 
Element definition: DatasetMemberDedupeStartResult [top]
Name Type Description
JobId xsd:integer
Id of the job that handles the deduplication Operation.
Range: [1..2^31-1]

 
Element definition: DatasetMemberDeleteSnapshots [top]
Delete Snapshot copies of a Volume which is a member of the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the root node of the Dataset. The effective primary of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The deletion of Snapshot copies happens in the background.

A provisioning job Id is returned in DatasetEditCommit zapi that represents the job which will delete the specified Snapshot copies. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId. Error conditions:

  • EACCESSDENIED - User does not have privileges To delete Snapshot copies of the member.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EOBJECTNOTFOUND - No Volume by the given Name or identifier was found.
  • ENOTINDATASET - Member is not in the primary node of the specified Dataset.
  • EOBJECTAMBIGUOUS - The specified member Name could refer To two or more Objects. Try again with the object identifier or object full Name.
  • EINVALIDINPUT - No Snapshot copies are specified for deletion or both VolumeId and VolumeName are not given in input or at least one of the Snapshot copies specified for deletion is marked busy.
  • ESNAPSHOTNOTFOUND - At least one of the Snapshot copy specified is not found on the Volume.
  • EEDITSESSIONNOTFOUND - If the edit session specified in input is not found
  • EEDITSESSIONOBJECTALREADYLOCKED - If the object being tried To lock in this Operation is already locked by some other edit session
  • EEDITSESSIONCONFLICTINGOP - If this Snapshot deletion Operation is conflicting with some other edit Operation in the same edit session
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Name Type Description
DeleteSnapshotsRequestInfo DeleteSnapshotsRequestInfo
Details on the Volume and Snapshot copies To be deleted.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]

 
Element definition: DatasetMemberDeleteSnapshotsResult [top]
[none]

 
Element definition: DatasetMemberListInfoIterEnd [top]
Ends iteration of Dataset Members.
Name Type Description
Tag xsd:string
Tag From a previous DatasetMemberListInfoIterStart.

 
Element definition: DatasetMemberListInfoIterEndResult [top]
[none]

 
Element definition: DatasetMemberListInfoIterNext [top]
Get next Records in the iteration started by DatasetMemberListInfoIterStart
Name Type Description
Maximum xsd:integer
The Maximum number of Records To retrieve.
Tag xsd:string
Tag From a previous DatasetMemberListInfoIterStart.

 
Element definition: DatasetMemberListInfoIterNextResult [top]
Name Type Description
DatasetMembers ArrayOfDatasetMemberInfo
List of the Members of the Dataset.
Records xsd:integer
The number of Records actually returned.

 
Element definition: DatasetMemberListInfoIterStart [top]
Starts iteration To list Members of the Dataset. Dynamic references are not returned by this API, nor are Objects only associated with the Dataset by their inclusion in a dynamic reference.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset whose Members will be listed.
DpNodeName DpPolicyNodeName
optional
List only the Members in this Policy node. If none is specified, then list Members in all Policy nodes. If both DpNodeName and StoragesetNameOrId are specified, then the Value of DpNodeName is ignored.
IncludeDeleted xsd:boolean
optional
If present and true, Members which are marked as deleted in the database are also returned. Otherwise, deleted Members are not returned.
IncludeExportsInfo xsd:boolean
optional
If true, the export information of Members is included in output. If the member is exported over NFS, the NFS export Name is retuned in NfsExportName element in DatasetMemberInfo. If the member is exported over CIFS, the share names are returned in CifsShareNames array in DatasetMemberInfo. In case the Members are accessed using both NFS and CIFS (i.e Mixed mode) then both NFS export Name and CIFS share names are returned. Default Value is false.
IncludeIndirect xsd:boolean
optional
If true, indirect Members are included. By default they are not included. An example of an indirect member is a Qtree in a Volume which is a direct member of the Dataset.
IncludeIsAvailable xsd:boolean
optional
If true, the IsAvailable Status is calculated for each member which may make the call To this zapi take much longer. Default is false.
IncludeSpaceInfo xsd:boolean
optional
If true, the space Status is computed for all Members, the space Status and detailed space conditions of every data set member is returned if the space Status of the member is "warning" or "Error". Default Value is false.
MemberId ObjId
optional
Id, in the DFM database, of a specific member of the Dataset. If specified, details of only this object will be returned.
MemberNameOrId ObjNameOrId
optional
Name or Id in the DFM database, of a specific member of the Dataset. If specified, details of only this object will be returned. If both MemberId and MemberNameOrId is specified, then MemberId will take precedence over MemberNameOrId.
StoragesetNameOrId ObjNameOrId
optional
List only the Members in this storage set. If none is specified, then list Members in all storagesets mapped To this Dataset's nodes. If both DpNodeName and StoragesetNameOrId are specified, then the Value of DpNodeName is ignored.
SuppressStatusRefresh xsd:boolean
optional
If true, do not refresh the member Status. If false or omitted, the Status of all Members will be refreshed before being returned.

 
Element definition: DatasetMemberListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of Records that have been saved for future retieval with DatasetMemberListInfoIterNext.
Tag xsd:string
Tag To be used in subsequent calls To DatasetMemberListInfoIterNext.

 
Element definition: DatasetMemberUndedupeStart [top]
Start undeduplication Operation on specified Volume member of the given Dataset.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or Identifier of the Dataset.
UndedupeMemberRequestInfo UndedupeMemberRequestInfo
Details on member To be undeduplicated.

 
Element definition: DatasetMemberUndedupeStartResult [top]
Name Type Description
JobId xsd:integer
Id of the job that handles the undeduplication Operation.
Range: [1..2^31-1]

 
Element definition: DatasetMissingMemberListInfoIterEnd [top]
Ends iteration of missing Dataset Members.
Name Type Description
Tag xsd:string
Tag From a previous DatasetMissingMemberListInfoIterStart.

 
Element definition: DatasetMissingMemberListInfoIterEndResult [top]
[none]

 
Element definition: DatasetMissingMemberListInfoIterNext [top]
Get next Records in the iteration started by DatasetMemberListInfoIterStart
Name Type Description
Maximum xsd:integer
The Maximum number of Records To retrieve.
Tag xsd:string
Tag From a previous DatasetMemberListInfoIterStart.

 
Element definition: DatasetMissingMemberListInfoIterNextResult [top]
Name Type Description
MissingMembers ArrayOfMissingMemberInfo
List of the missing Members of the Dataset.
Records xsd:integer
The number of Records actually returned.

 
Element definition: DatasetMissingMemberListInfoIterStart [top]
Starts iteration To list Members of the Dataset that have gone missing. The way the server determines if an object was not intentionally removed From the Dataset is:
  1. The object is still a Dataset member.
  2. The object's objDeleted flag is set.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset whose Members will be listed.

 
Element definition: DatasetMissingMemberListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of Records that have been saved for future retieval with DatasetMemberListInfoIterNext.
Tag xsd:string
Tag To be used in subsequent calls To DatasetMemberListInfoIterNext.

 
Element definition: DatasetModify [top]
Modify Attributes for a Dataset.
Name Type Description
ApplicationInfo ApplicationInfo
optional
This input is used only if IsApplicationData is true. It contains information about the application which manages this Dataset.
CheckProtectionPolicyOnCommit xsd:boolean
optional
In the default case for a protection Policy change, we immediately check the Dataset's membership configuration. However, in the case where we are changing the Policy and the storage set assignments in the same edit session, the caller can set this flag To true To Request that the server postpone the check of the protection Policy configuration and root node membership until the call To edit-commit. Default Value is false.
DatasetContact EmailAddressList
optional
Contact for the Dataset, such as the owner's e-mail Address.
DatasetDescription xsd:string
optional
Description of the Dataset, up To 255 character long.
DatasetMetadata ArrayOfDfmMetadataField
optional
Opaque metadata for Dataset. Metadata is usually set and interpreted by an application that is using the Dataset. DFM does not look into the contents of the metadata.
DatasetName ObjName
optional
Name of the Dataset. It cannot be all numeric. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned.
DatasetOwner xsd:string
optional
Name of the owner of the Dataset, up To 255 characters long.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]
IsApplicationData xsd:boolean
optional
If true, the Dataset is an application Dataset managed by an external application. Conversion of a non-application Dataset To an application Dataset is not allowed. The default Value is false.
IsDpIgnored xsd:boolean
optional
True if an administrator has chosen To ignore this Dataset for purposes of data protection. Data sets with this attribute set To true are not returned when the client requests Datasets which are not ignored. This attribute has no other significance To the system.
IsDpSuspended xsd:boolean
optional
Flag indicating whether or not the Dataset should be protected. This also indicates whether conformance checking of the Dataset is To be done or not. Default is False.

Should IsDpSuspended go From TRUE To FALSE the edit session AssumeConfirmation default setting will be be set To FALSE for this Dataset. (See DatasetEditCommit for details)

Deprecated field. Retained for backward compatibility. This field is deprecated in favour of IsSuspended, which suspends the Dataset for all automated actions (data protection and conformance check of the Dataset).
IsSuspended xsd:boolean
optional
True if an administrator has chosen To suspend this Dataset for all automated actions (data protection and conformance check of the Dataset). Default is False. If present, this field takes precedence over IsDpSuspended.

Should IsSuspended go From TRUE To FALSE the edit session AssumeConfirmation default setting will be be set To FALSE for this Dataset. (See DatasetEditCommit for details)
ProtectionPolicyId ObjId
optional
Identifier of the protection Policy To associate with this Dataset. This legacy parameter is only used if ProtectionPolicyNameOrId is not supplied. The dataprotection License is required for this input.
ProtectionPolicyNameOrId ObjNameOrId
optional
Name or identifier of the protection Policy To associate with this Dataset. This input is preferred over ProtectionPolicyId and if supplied then do not supply ProtectionPolicyId because ProtectionPolicyId will be ignored. The dataprotection License is required for this input.
RequiresNonDisruptiveRestore RequiresNonDisruptiveRestore
optional
Specifies whether the Dataset requires a non-disruptive restore of LUNs so that the Host need not get detached From the LUN. Default Value is false.
VolumeQtreeNamePrefix xsd:string
optional
Prefix for Volume and Qtree names, up To 60 character long. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned.

 
Element definition: DatasetModifyNode [top]
Modify Attributes of a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the data protection Policy node that maps To it. You may change the storage set's Resource pool and Timezone using this call, but not its Name or Description.

Within the same edit session in which you call DatasetModifyNode, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was foundthat has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EINVALIDTIMEZONE - The given Timezone Name is not valid.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
  • EDSCONFLICTCANTMIRROROSSV - OSSV is not allowed in mirror Source node.
  • EDSCONFLICTCANTSNAPSHOTOSSV - Cannot apply Snapshot schedule To OSSV.
  • EDSCONFLICTINCOMPATIBLEPOLICY - Policy is not compatible with application Dataset.
  • EDSCONFLICTOSSVNOTALLOWED - OSSV is not allowed in the Dataset.
  • EDSCONFLICTNOSMLICENSE - There is no SnapMirror License installed.
  • EDSCONFLICTNOSMSVLICENSE - There is no SnapMirror or SnapVault License installed. Need To have at least one of them installed.
  • EDSCONFLICTROOTNODE - Operation cannot be performed on root node of Dataset.
  • EDSCONFLICTNOTROOTNODE - Operation cannot be performed on non-root node of Dataset.
  • EDSCONFLICTNOTLEAFNODE - Operation cannot be performed on non-leaf node of Dataset.
  • EDSCONFLICTINVALIDVFILER - Dataset node has Members that do not belong To the vFiler being attached.
  • EDSCONFLICTDEDUPLICATION - A deduplication schedule enabled provisioning Policy cannot be associated with SnapVault destinations.
Name Type Description
DatasetAccessDetails DatasetAccessDetails
optional
Data access details for a Dataset that needs To be configured and provisioned in a way that it is capable of transparent migration. This enables all the storage in the primary node of the Dataset To be migrated To a different physical Resource without having To reconfigure the clients accessing this storage. This input is valid only when: - There are no Members in the Dataset. - There is no vFiler Unit attached To the Dataset. - The node being edited is the primary node of the Dataset.
DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for Members provisioned in this node of the Dataset.
DpNodeName DpPolicyNodeName
optional
Name of the node in the data protection Policy that maps To the storage set. DpNodeName must Match exactly the Name of one of the nodes in the data protection Policy that is currently assigned To the data set.

If DpNodeName is not specified, then the storage set associated with the root node is modified.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset that was obtained by an earlier call To DatasetEditBegin.
OnlineMigration xsd:boolean
optional
Indicates, that this Dataset is capable of non-disruptive migration. This field is valid only when either DatasetAccessDetails or VfilerId is not empty. By default the migration will be assumed To be disruptive. Default: false.
ProvisioningPolicyNameOrId ObjNameOrId
optional
Name or object identifier of the provisioning Policy To be attached To the node. The implications of this are:
  • Members of the storage set associated with node are checked for conformance with the provisioning Policy.
  • Any new Members provisioned into the storage set will be based on this provisioning Policy.
RelinquishVfiler xsd:boolean
optional
If true, relinquish the vFiler Unit associated with the Dataset. This will Destroy the vFiler Unit, move all the storage owned by the vFiler Unit To the hosting storage system and re-export the Dataset over the storage system. This Option can be specified only when:
  • The vFiler Unit associated with the root node of the Dataset has been created for transparent migration by Provisioning Manager. In this case IsVfilerCreatedForMigration will be true in DatasetInfo returned by DatasetListInfoIterStart APIs.
  • All storage of the vFiler Unit belongs To the primary node of the Dataset, except for the root storage.
Default Value is false.
ResourcepoolNameOrId ObjNameOrId
optional
Name or object identifier of a Resource pool To assign To the storage set. If other Resource pool(s) are already assigned To the storage set, then this one will replace it. This will delete all the attached Resource pools and add the new one. If the input Value is the empty string "", then no Resource pool will be assigned To the storage set i.e. all the attached Resource pools will be removed. If this parameter is not supplied, then the storage set's Resource pool assignment will not be changed.

This is a legacy parameter. DatasetAddResourcepool and DatasetRemoveResourcepool are preferred APIs for adding and removing Resource pools to/from Dataset nodes.
TimezoneName xsd:string
optional
Timezone To assign To the storage set. The Value must be either a TimezoneName returned by TimezoneListInfoIterNext, or the empty string "". If the Value is "", no Timezone is assigned To the storage set. Storage sets with no Timezone assignment use the Timezone of the Resource pool assigned To them, or the system default if no Timezone is assigned To the Resource pool.
VfilerNameOrId ObjNameOrId
optional
Name or object identifier of the vFiler Unit To be attached To the node. If there are any Members currently in the node, they should belong To this vFiler Unit. Any new member provisioned for this node, will be exported over this vFiler Unit.

 
Element definition: DatasetModifyNodeResult [top]
[none]

 
Element definition: DatasetModifyResult [top]
[none]

 
Element definition: DatasetProvisionMember [top]
Provision a new member into the effective primary node of a Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary node of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

Error conditions:

  • EINVALIDINPUT - If the inputs specified are not valid.
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To provision a member.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Name Type Description
EditLockId xsd:integer
Identifier of the edit lock for a Dataset that was obtained by an earlier call To DatasetEditBegin. Range: [1..2^31-1]
ProvisionMemberRequestInfo ProvisionMemberRequestInfo
Information of the provisioning Request.

 
Element definition: DatasetProvisionMemberResult [top]
[none]

 
Element definition: DatasetRemoveMember [top]
Remove member From a Dataset. Only Members explicitly added To the Dataset (direct Members) can be removed.

If "Destroy" is true, even indirect Members can be destroyed on the storage system and removed From the Dataset.

If "Destroy" is true, then it is applicable only on Members of the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary node of a disaster recovery Dataset in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The Destroy Operation happens in the background.

A provisioning job Id is returned in DatasetEditCommit api that represents the job which will resize the member as specified. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId.
Name Type Description
DatasetMemberParameters ArrayOfDatasetMemberParameter
List of Members To remove From the Dataset.
Destroy xsd:boolean
optional
Specifies whether the member should be destroyed on the Filer. If not specified or false, the member will not be destroyed on the Filer. "Destroy" flag can be true, only when the Members given in input are of Type Volume, Qtree or Lun. Also, when "Destroy" is true, the Volume, Qtree or Lun given can be indirect Members of the Dataset.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]

 
Element definition: DatasetRemoveMemberByDynamicReference [top]
Remove dynamic references From a Dataset. Only dynamic_references explicitly added To the Dataset can be removed.
Name Type Description
DatasetDynamicReferenceParameters ArrayOfDatasetDynamicReferenceParameter
List of dynamic-references To remove From the Dataset.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]

 
Element definition: DatasetRemoveMemberByDynamicReferenceResult [top]
[none]

 
Element definition: DatasetRemoveMemberResult [top]
[none]

 
Element definition: DatasetRemoveResourcepool [top]
Remove Resource pool From a single storage set that is part of a Dataset. The storage set is specified implicitly by the Name of the Policy node that maps To it.

Within the same edit session in which you call DatasetRemoveResourcepool, you may also add or remove Members or dynamic references, or change the Dataset's Name, Description, IsDpIgnored, IsDpSuspended, or IsSuspended. You may not change the data set's protection Policy or storage sets within the same edit session.

Error conditions:
  • EEDITSESSIONNOTFOUND - No edit lock was found that has the given identifier.
  • EACCESSDENIED - User does not have Permission To modify the storage set.
  • EOBJECTAMBIGUOUS - The Name given for the storage set or Resource pool matches multiple storage sets or Resource pools.
  • EOBJECTNOTFOUND - No storage set or Resource pool was found that has the given Name or identifier.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • ESTORAGESETNOTINDATASET - The specified storage set is not a part of the Dataset being edited.
  • EDPPOLICYNODENOTFOUND - No DP Policy node was found that has the given Name.
  • EEDITSESSIONCONFLICTINGOP - The requested modification conflicts with other changes performed during the edit session.
  • EDSCONFLICTALREADYINDATASET - Object, its ancestor or descendent is already in Dataset.
  • EDSCONFLICTSRCDESTINSAMEAGGR - Source data and destination data are in the same Aggregate.
  • EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in Resource pool.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the node in the data protection Policy that maps To the storage set. DpNodeName must Match exactly the Name of one of the nodes in the data protection Policy that is currently assigned To the data set.

If DpNodeName is not specified, then the storage set associated with the root node is modified.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset that was obtained by an earlier call To DatasetEditBegin. Range: [1..2^31-1]
ResourcepoolNameOrId ObjNameOrId
Name or object identifier of a Resource pool To remove From the storage set.

 
Element definition: DatasetRemoveResourcepoolResult [top]
[none]

 
Element definition: DatasetReplacePrimaryMembers [top]
Replace primary Members and relationships after a failover.

If a secondary Volume or Qtree is specified, it replaces the primary member for just that secondary Volume or Qtree. If neither are specified, it replaces all primary Members that need To be replaced.

If DryRun is specified, it returns the Results of the Operation that would be taken should the Operation be committed.
Name Type Description
CancelEditSessions xsd:boolean
optional
If true, any edit operations in progress on the data set are rolled back before replacing any primary Members. If it is false and there are edit operations in progress on the Dataset, EEDITSESSIONINPROGRESS is returned and no primary Members will be replaced. By default, CancelEditSessions is false. If DryRun is true, canel-edit-sessions is ignored.
DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset whose primary Members need To be replaced.
DryRun xsd:boolean
optional
If true, return a list of actions that would be taken should the Operation be committed without actually committing them. Dry run does not affect any edit session in progress. By default, DryRun is false.
ObjectNameOrId ObjNameOrId
optional
Name or identifier of the secondary Volume or Qtree whose primary needs To be replaced. If ObjectNameOrId is not specified, it replaces all primary Members in the Dataset that need To be replaced.

 
Element definition: DatasetReplacePrimaryMembersResult [top]
Name Type Description
ReplaceResults ArrayOfReplaceResult
optional
Results of the replace Operation. Each Result describes one Action that was taken. If DryRun is true, it describes one Action that would be taken should the Operation be committed.

 
Element definition: DatasetResizeMember [top]
Resize, change Maximum capacity and change snap reserve for a Dataset member on the effective primary node of the Dataset.

The effective primary node for a non disaster recovery capable Dataset or a disaster recovery capable Dataset not in the DR state of "failed_over" is the Dataset root node. The effective primary of a disaster recovery data set in the DR state of "failed_over" is the disaster recovery capable node of the Dataset.

The resize Operation happens in the background.

A provisioning job Id is returned in DatasetEditCommit zapi that represents the job which will resize the member as specified. The Status of the job can be checked using DpJobListIterStart ZAPIs with the given JobId. Error conditions:

  • EACCESSDENIED - User does not have the Capability DFM.ResourcePool.Provision on the containing Resource pool for a Volume that is being resized.
  • EDATABASEERROR - A database Error occurred while processing the Request.
  • EOBJECTNOTFOUND - No Volume or Qtree member by the given Name or identifier was found.
  • ENOTINDATASET - Member is not in the primary node of the specified Dataset.
  • EOBJECTAMBIGUOUS - The specified member Name could refer To two or more Objects. Try again with the object identifier or object full Name.
  • EINVALIDINPUT - Both MemberId and MemberName are not specified, inputs other than NewSize are specified for a Qtree member, Size parameters are being changed for traditional Volumes.
  • EEDITSESSIONNOTFOUND - If the edit session specified in input is not found
  • EEDITSESSIONOBJECTALREADYLOCKED - If the object being tried To lock in this Operation is already locked by some other edit session
  • EEDITSESSIONCONFLICTINGOP - If this resize Operation is conflicting with some other edit Operation in the same edit session
  • EDATASETNOTINSTABLEDRSTATE - The Dataset is not in a stable disaster recovery state.
Name Type Description
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]
ResizeMemberRequestInfo ResizeMemberRequestInfo
Details on member To be resized.

 
Element definition: DatasetResizeMemberResult [top]
[none]

 
Element definition: DatasetSet [top]
Set Dataset Options.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or object identifier for the Dataset whose Options need To be set.
IsAllowCustomSettings xsd:boolean
optional
If true, conformance check of some Volume Options is disabled for the Dataset. These Volume Options include, fractional-reserve, autodelete commitment and autodelete trigger Attributes only. This Option is applicable only for Datasets which have san thin provisioning Policy associated. For other Datasets the Option is ignored. default Value is false.
IsEnableWriteGuaranteeChecks xsd:boolean
optional
If true, periodic write guarantee checks are enabled for the Dataset. This Option is applicable only for Datasets which have SAN thin provisioning Policy associated. Presence of lun-clones, flex-clones, SFSR operations in the Volume may Effect write guarantees in SAN thin provisioning configurations. Periodic write guarantee checks detect such Condition and generate alerts. For other Datasets the Option is ignored. default Value is true.
MaximumLunsPerVolume xsd:integer
optional
Maximum Luns To be provisioned From a Volume in this Dataset. If the Value is empty, then the Dataset level Value of the global Option maxLUNsPerVolume is applicable for the Dataset.
MaximumQtreesPerVolume xsd:integer
optional
Maximum Qtrees To be provisioned From a Volume in this Dataset. If the Value is empty, then the Dataset level Value of the global Option maxQtreesPerVolume is applicable for the Dataset.

 
Element definition: DatasetSetResult [top]
[none]

 
Element definition: DatasetSetStorageset [top]
Change the storage sets associated with Policy nodes. It is legal To change many storage set/node mappings in an edit session.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the data protection Policy node To associate the storage set To. If this input is not present the root node is used as the default.

If DpNodeName is the root node,

  • Dataset must have a disaster recovery capable protection Policy
  • Dataset must be in a "failed_over" DR state
  • ObjectNameOrId specified must be the storage set mapped To the DR-capable node of the old protection Policy.
Mapping the DR storage set To the root node of a new protection Policy will have the side Effect of changing the DR state To "ready" when the edit session is committed.
EditLockId xsd:integer
Identifier of the edit lock for a Dataset obtained by calling DatasetEditBegin. Range: [1..2^31-1]
ObjectNameOrId ObjNameOrId
Name or identifier of the storage set To add.

 
Element definition: DatasetSetStoragesetResult [top]
[none]

 
Element definition: DatasetUpdateDrStatus [top]
Update disaster recovery Status for a Dataset.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or object identifier for the Dataset.

 
Element definition: DatasetUpdateDrStatusResult [top]
[none]

 
Element definition: DatasetUpdateProtectionStatus [top]
Update protection Status for a Dataset.
Name Type Description
DatasetNameOrId ObjNameOrId
Name or object identifier for the Dataset.

 
Element definition: DatasetUpdateProtectionStatusResult [top]
[none]

 
Element definition: ApplicationInfo [top]
Information about an application.
Name Type Description
ApplicationName xsd:string
Name of an application, up To 255 characters long. For example: "SnapManager for Oracle"
ApplicationServerName xsd:string
The Name of the server the application is running on, up To 255 characters long. This is the Name of the Host server, rather than the Name of the client application.
ApplicationVersion xsd:string
Version of an application, up To 255 characters long. For example: "2.1"
CarryPrimaryBackupRetention xsd:boolean
optional
If this input is true, Retention Type of the primary backup is assigned To its replicas on the other nodes of the Dataset. An exception is made if the DpBackupStart API with RetentionType specified, starts the replication. In that case, the Retention Type specified in DpBackupStart is assigned To the replicas thereby overriding the Retention Type of the primary backup. If a scheduled event starts the replication, Retention Type specified in the schedule event is ignored.

If this input is false, Retention Type of the primary backup is ignored when assigning Retention Type To its replicas. Depending on how the backup transfer job was started, the Retention Type specified either in DpBackupStart API or the one specified in the schedule is assigned To the replica of the primary backup.

When this input is false, replicas of the primary backup may get an undesired Retention Type if the schedules are not configured very carefully. Therefore, it is recommended that any new users of the API should always set this input To true.

Note that even if the Retention Type of primary and secondary Backups is the same, the Retention Duration may be different for them. The Retention Duration is specified for each node in the data protection Policy. See DpPolicyNodeInfo for more details.

Always present in the output.

Default is true.
IsApplicationManagingPrimaryBackupRetention xsd:boolean
optional
If this input is true, Protection Manager does not enforce Retention settings in the Policy on the primary Backups. Application is responsible for deleting primary Backups, possibly by invoking DpBackupVersionDelete API.

If this input is false, Protection Manager deletes the primary Backups according To the Retention settings specified in the Policy.

Always present in the output.

Default is false.
IsApplicationResponsibleForPrimaryBackup xsd:boolean
DFM creates primary backup versions only if this Option is false.

 
Element definition: ArrayOfConformanceAlert [top]
Name Type Description
ConformanceAlert ConformanceAlert[]

 
Element definition: ArrayOfDatasetDynamicReferenceInfo [top]
Name Type Description
DatasetDynamicReferenceInfo DatasetDynamicReferenceInfo[]

 
Element definition: ArrayOfDatasetDynamicReferenceParameter [top]
Name Type Description
DatasetDynamicReferenceParameter DatasetDynamicReferenceParameter[]

 
Element definition: ArrayOfDatasetInfo [top]
Name Type Description
DatasetInfo DatasetInfo[]

 
Element definition: ArrayOfDatasetMemberInfo [top]
Name Type Description
DatasetMemberInfo DatasetMemberInfo[]

 
Element definition: ArrayOfDatasetMemberParameter [top]
Name Type Description
DatasetMemberParameter DatasetMemberParameter[]

 
Element definition: ArrayOfDfmMetadataField [top]
Name Type Description
DfmMetadataField DfmMetadataField[]

 
Element definition: ArrayOfDryRunResult [top]
Name Type Description
DryRunResult DryRunResult[]

 
Element definition: ArrayOfJobInfo [top]
Name Type Description
JobInfo JobInfo[]

 
Element definition: ArrayOfMissingMemberInfo [top]
Name Type Description
MissingMemberInfo MissingMemberInfo[]

 
Element definition: ArrayOfReplaceResult [top]
Name Type Description
ReplaceResult ReplaceResult[]

 
Element definition: DatasetAccessDetails [top]
The data access details of a Dataset. Currently, this is used To configure a Dataset in a way that it is capable of transparent migration. A Dataset can be configured and provisioned in a way that it is capable of transparent migration. IP Address and Netmask has To be configured on the Dataset in order To make the Dataset capable of transparent migration. Provisioning Manager will create a vFiler Unit with this IP Address and all the storage provisioned for this Dataset will be accessed From this vFiler Unit or this IP Address. As input, it is valid only when: - There are no Members in the Dataset. - There is no vFiler Unit attached To the Dataset.
Name Type Description
IpAddress xsd:string
IP Address in dotted decimal format. (for example, "192.168.11.12"). The Length of this string cannot be more than 16 characters.
Netmask xsd:string
Netmask for the IP Address in dotted decimal notation. As input, this is valid only when IpAddress is also provided in DatasetAccessDetails. Provisioning Manager will create a vFiler Unit whose IP Address will be the one configured as IpAddress and it will be bound To an Interface with this Netmask.

 
Element definition: DatasetExportInfo [top]
Specifies the NAS or SAN export settings for a Dataset node.
Name Type Description
DatasetCifsExportSetting DatasetCifsExportSetting
optional
The CIFS export settings for storage exported over CIFS. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'.
DatasetExportProtocol DatasetExportProtocol
optional
Specifies the Protocol over which Members of the Dataset node will be exported. This Value is always returned. If omitted during a modify Operation, the existing Value is not changed. If specified as 'none' in a modify Operation, the existing settings will be cleared. Default Value is 'none'. Depending on the export Protocol, dataset-lun-mapping, or a combination of DatasetNfsExportSetting and DatasetCifsSharePermissions, should be specified in a modify Operation, and will be returned in the iterator output.
DatasetLunMappingInfo DatasetLunMappingInfo
optional
Specifies the Hosts and/or Initiators To which LUNs in this Dataset node will be mapped, and the igroup OS Type. This field may be present only if the DatasetExportProtocol is 'fcp' or 'iscsi'.
DatasetNfsExportSetting DatasetNfsExportSetting
optional
The NFS export settings for storage exported over NFS. This field may be present only if the DatasetExportProtocol is 'nfs' or 'mixed'.

 
Element definition: DedupeMemberRequestInfo [top]
Details of the dedupe member Request.
Name Type Description
FullVolumeDedupe xsd:boolean
optional
If true, full Volume dedupe scan is performed. Otherwise only new data since last deduplication Operation is scanned. Default Value is false.
VolumeId ObjId
optional
Identifier of a Volume member of a Dataset.
VolumeName ObjName
optional
Name of a Volume member of the Dataset. Either VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

 
Element definition: DeleteSnapshotsRequestInfo [top]
Details on which Snapshot copies are To be deleted.
Name Type Description
Snapshots ArrayOfSnapshot
List of Snapshot copies To be deleted From the Volume. A minimum of 1 and a Maximum of 255 Snapshot copies can be listed for deletion.
VolumeId ObjId
optional
Identifier of the Volume whose Snapshot copies are To be deleted. This Volume should be a member of the effective primary node of the Dataset either through direct or indirect membership.
VolumeName ObjName
optional
Name of the Volume whose Snapshot copies are To be deleted. This Volume should be a member of the effective primary node of the Dataset either through direct or indirect membership. Either VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

 
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: DrState [top]
Disaster recovery states of a Dataset. Possible Values are:
  • "ready": The Dataset is prepared To fail over.
  • "failing_over": The Dataset is in the process of failing over. Eventually, the state of the Dataset will change To either "failed_over" or "failover_error".
  • "failed_over": The Dataset has failed over. The primary data is now considered unavailable and the mirror relationships From the primary To the DR node have been broken.
  • "failover_error": The Dataset attempted To fail over but encountered an Error. User intervention is required To change the state To either "failed_over" or "ready".
[none]

 
Element definition: EmailAddressList [top]
A list of email addresses. If more than one email Address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up To 255 characters.
[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: 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]

 
Element definition: ObjNameOrId [top]
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats:
  • It must have the format of an ObjName, or
  • It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
Elements of Type ObjNameOrId 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 ObjNameOrId 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]

 
Element definition: ProvisionMemberRequestInfo [top]
Details specific To the 'provision_member' Request.
Name Type Description
Comments ArrayOfProvisionMemberComment
optional
Comment Values To assign To the newly provisioned storage object.
CreateNewVfiler xsd:boolean
optional
True, if new vFiler Unit needs To be created during provisioning. The provisioned storage container is then moved To the vFiler Unit. This input is applicable only in the context of ResourcepoolMemberListInfoIterStart zapi and RunProvisioningChecks is specified as 'true'. This input is ignored in DatasetProvisionMember and StorageServiceDatasetProvision zapi. The default Value is 'false'.
DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for the the provisioning member. Member level export settings cannot be specified, if export settings have been configured at node level.
Description xsd:string
optional
Description of the provisioning Request. The Length of this string cannot be more than 255 characters.
InitialSnapshotSpace xsd:integer
optional
Applicable when provisioning Members in SAN data sets (i.e. Datasets associated with provisioning Policy of Type 'san'). Specify the initial disk space in bytes that needs To be allocated upfront for Snapshot copies of the member. Range: [1..2^63-1]
MaximumDataSize xsd:integer
optional
Maximum storage space for the Dataset member. Applicable when provisioning Members in NFS data sets (i.e. Datasets associated with provisioning Policy of Type 'nas' and export over 'NFS' Protocol). Storage clients can write data up To this limit if the containing Aggregate has space. The Value is specified in bytes. Range: [1..2^63-1]
MaximumSnapshotSpace xsd:integer
optional
Applicable when provisioning Members in SAN data sets (i.e. Datasets associated with provisioning Policy of Type 'san'). Specify the Maximum disk space in bytes for the Snapshot copies of the member. Once the space consumed by Snapshot copies reaches this Value, further Snapshot copies will fail. Range: [1..2^63-1]
Name xsd:string
Name of the storage container. If this is a NAS Dataset, i.e the provisioning Policy associated with the primary node of the Dataset is of Type 'nas', then this Name corresponds To the Qtree created. If this is a SAN Dataset, i.e the provisioning Policy associated with the primary node of the Dataset is of Type 'san', then this Name corresponds To the LUN or Volume that will be provisioned as part of this Request. The Length of this string cannot be more than 255 characters.
OnlineMigration xsd:boolean
optional
Indicates whether pre checks related To online migration has To be performed on the storage system during provisioning. This input is applicable only in the context of ResourcepoolMemberListInfoIterStart API and RunProvisioningChecks is specified as true and either CreateNewVfiler is true or VfilerNameOrId is specified. This input is ignored in StorageServiceDatasetProvision and DatasetProvisionMember APIs.
ProvisioningPolicyId ObjId
optional
Name or identifier of the provisioning Policy used with this Request. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs.
ProvisioningPolicyName ObjFullName
optional
Name of the provisioning Policy used with this Request. Present only if the Request Type is 'provision_member'. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs.
ResourceNameOrId ObjNameOrId
optional
Name or identifier of the Resource object From which storage space will be provisioned. valid types of Objects are:-
  • Filer
  • Aggregate
The Filer or Aggregate specified should belong To the Resource pool(s) associated with primary node of the Dataset.
Size xsd:integer
Amount of storage space for data. Whether this space has To allocated on demand or reserved upfront From an Aggregate in Resource pool is decided based on the provisioning Policy settings. The Value is specified in bytes. Range: [1..2^63-1]
VfilerNameOrId ObjNameOrId
optional
Name or Id of the vFiler Unit, if specified the newly provisioned Dataset member will be moved To the specified vFiler Unit and accessed via the vFiler Unit's IP addresses. Ignored for StorageServiceDatasetProvision.

 
Element definition: RequiresNonDisruptiveRestore [top]
When this attribute is set, the Dataset is configured To allow LUNs To be restored From Backups in such a way that the Host need not detach From the LUN.

Configuring the Dataset for non-disruptive restore does not guarantee that all backup Instances may be restored non-disruptively. It only applies To backup Instances reached through a Backup connection. The caller must check the SupportsNonDisruptiveRestore output element returned by dp-backup-list-info-next To tell whether a given backup Instance can be restored non-disruptively.

Specifically, when this attribute is set:

  • All storage systems must be running ONTAP 7.3 or later.
  • Protection Manager must have working ZAPI credentials for all storage systems in use by this Dataset.
  • All Backup connections will be implemented using SnapVault, not Qtree SnapMirror.
  • All non-primary storage systems used by the data set must have a SnapVault Secondary License.

If any of these constraints is not met when adding a member To the Dataset, the Dataset will not be in conformance and the addition will generate conformance Errors. Addition of Members with ONTAP Version less than 7.3 To the primary node of the Dataset will fail with Errors.

requires-nondisruptive-restore may only be specified if:

  • No Backup connection in the protection Policy used by the Dataset is DR capable (i.e. the IsDrCapable attribute may not be set for any Backup connection of the Policy).
  • The Dataset must be an application Dataset.
Thus, if RequiresNonDisruptiveRestore is specified as true, IsApplicationData must also be present and true. Callers may check the non-disruptive-restore-compatible output element of the dp-policy-list-info-iter-next API To tell which policies may be applied To Datasets requiring non-disruptive restores.
[none]

 
Element definition: ResizeMemberRequestInfo [top]
Details of the resize Request.
Name Type Description
MaximumCapacity xsd:integer
optional
Specify the new Maximum capacity Value for a flexbile Volume. The Value is specified in bytes. Valid only if the Filer To which the Volume belongs is of ONTAP Version 7.1 or above only. This input is valid only if MemberId or MemberName refers To a flexible Volume. Range: [1..2^63-1]
MemberId ObjId
optional
Identifier of the Dataset member on which the resize Operation has To be carried out. This member can be either a flexible Volume or a Qtree which is a member of the effective primary node of the Dataset either through direct or indirect membership.
MemberName ObjName
optional
Name of the Dataset member on which the resize Operation has To be carried out. This member can be either a flexible Volume or a Qtree which is a member of the effective primary node of the Dataset either through direct or indirect membership. Either MemberId or MemberName has To be specified. If MemberId is specified then MemberName is ignored.
NewSize xsd:integer
optional
Specify the new Size of the Dataset member. The Value is specified in bytes. If the member is a Volume, this corresponds To the Size of the Volume. If the member is a Qtree, this corresponds To hard disk quota limit for the Qtree. Range: [1..2^63-1]
SnapReserve xsd: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. This input is valid only if MemberId or MemberName refers To a flexible Volume. Range: [0..100]

 
Element definition: UndedupeMemberRequestInfo [top]
Details of the undedupe member Request.
Name Type Description
VolumeId ObjId
optional
Identifier of a Volume member of a Dataset.
VolumeName ObjName
optional
Name of a Volume member of the Dataset. Either VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

 
Element definition: ArrayOfProvisionMemberComment [top]
Name Type Description
ProvisionMemberComment ProvisionMemberComment[]

 
Element definition: ArrayOfSnapshot [top]
Name Type Description
Snapshot Snapshot[]

 
Element definition: ConformanceAlert [top]
A Description of one conformance check alert that should be noted by a user.
Name Type Description
ConformanceAlertEffect xsd:string
optional
The predicted Effect of the alert. If there is no Effect, this element will not be present
ConformanceAlertReason xsd:string
Specifies possible reasons for alert.
ConformanceAlertSeverity ObjStatus
Severity of the alert. Possible Values are "information", "Error" or "warning".
ConformanceAlertSuggestion xsd:string
optional
Present only if Severity is Error or warning. Specifies any suggestions To rectify the warnings, Errors. If there are no suggestions To specify, this element will not be present.
ConformanceAlertType ConformanceAlertType
Indicates the Type for this alert

 
Element definition: DatasetCifsExportSetting [top]
If storage inside this Dataset node is exported over CIFS, this specifies some of the common Properties that will be applied To all such provisioned storage.
Name Type Description
CifsDomain xsd:string
optional
Name of the CIFS domain. If present, then only filers or vFilers belonging To this CIFS domain is considered for provisioning. If not present, then any Filer is picked. Up To 255 characters.
DatasetCifsSharePermissions ArrayOfDatasetCifsSharePermission
optional
Specifies the permissions granted To users on storage provisioned in this Dataset node. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'.

 
Element definition: DatasetDynamicReferenceInfo [top]
Information about one dynamic reference in a Dataset.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the Policy node To which the dynamic reference is attached. This element is only included if a data protection Policy is associated with the Dataset.
DynamicReferenceId ObjId
Identifier of the dynamic reference.
DynamicReferenceName ObjName
Name of the dynamic reference.
DynamicReferenceStatus ObjStatus
Current Status of the dynamic reference.
DynamicReferenceType xsd:string
Type of the dynamic reference. Possible Values are 'Filer', 'Vfiler', 'Aggregate' or 'ossv_host'.
IsAvailable xsd:boolean
optional
True if this member and all of it's parents are up or online. Only valid for Members of Type "ossv-host," "ossv-dir," "Filer," "Vfiler," "Aggregate," "Volume," or "Qtree".
StoragesetId ObjId
Identifier of the storage set To which the dynamic reference belongs.
StoragesetName ObjName
Name of the storage set To which the dynamic reference belongs.

 
Element definition: DatasetDynamicReferenceParameter [top]
Information about one dynamic reference in a Dataset.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the data protection Policy node associated with the dynamic reference. If DpNodeName is not specified, the root data protection Policy node is assumed.
ObjectNameOrId ObjNameOrId
Name or identifier of the dynamic reference To add To or remove From the Dataset.

 
Element definition: DatasetExportProtocol [top]
Specifies the export protocols that Members in this Dataset node will be exported over. Possible Values are 'nfs', 'cifs', 'mixed', 'fcp', 'iscsi' and 'none'. Specifying 'mixed' implies that the storage in the Dataset should be exported over both NFS and CIFS.
[none]

 
Element definition: DatasetInfo [top]
Information about a Dataset.
Name Type Description
ApplicationInfo ApplicationInfo
optional
If IsApplicationData is true, then this element must be present and it will contain information about the application which manages this Dataset.
DatasetAccessDetails DatasetAccessDetails
optional
Data access details for a Dataset. This is returned only when a Dataset is configured To be capable of transparent migration.
DatasetContact EmailAddressList
optional
Contact information for the Dataset, such as the owner's e-mail Address.
DatasetDescription xsd:string
Description of the Dataset, up To 255 characters long.
DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for the root node of the Dataset. This field is present only if the IncludeExportSettings field was set To true in DatasetListInfoIterStart for this iteration.
DatasetId ObjId
Identifier of Dataset.
DatasetMap ArrayOfDatasetMapEntry
optional
List the Policy node To storage set mapping. This shows how the storage set are wired together based on the Policy topology for the Dataset.
DatasetMetadata ArrayOfDfmMetadataField
optional
Opaque metadata for Dataset. Metadata is usually set and interpreted by an application that is using the Dataset. DFM does not look into the contents of the metadata.
DatasetMigrationInfo DatasetMigrationInfo
optional
Dataset's migration information. This will be present only if IncludeMigrationInfo is set To true in DatasetListInfoIterStart api. If the Dataset is not migrating this element will not be present.
DatasetName ObjName
Name of Dataset.
DatasetOwner xsd:string
optional
Name of the owner of the Dataset, up To 255 characters long.
DatasetStatus DatasetStatus
The complex Status of the Dataset at the time it was last calculated. If suppress-dataset-status was not set To true, then the Resource Status will be re-calculated as part of the iteration. The Resource Status is the only aspect of DatasetStatus that is ever refreshed when iterated.
DrState DrState
optional
Disaster recovery state of the Dataset.

If the Dataset list iteration's output element IsDrCapable is true, then this element appears in the output. Otherwise, if IsDrCapable is false, this element does not appear in the output.
DynamicReferenceCount xsd:integer
The Count of dynamic references To Members in the Dataset. Range: [0..2^31-1]
HasProtection xsd:boolean
True if this Dataset has a data protection Policy and it has at least 1 relationship associated with it, or if the Policy has only 1 node.
HasProtectionPolicy xsd:boolean
True if this Dataset has a data protection Policy associated with it.
IsAllowCustomSettings xsd:boolean
optional
If true, conformance check of some Volume Options is disabled for the Dataset. These Volume Options include, fractional-reserve, autodelete commitment and autodelete trigger Attributes only. This Option is applicable only for Datasets which have san thin provisioning Policy associated. For other Datasets the Option is ignored. default Value is false.
IsApplicationData xsd:boolean
If true, the Dataset is an application Dataset managed by an external application. ApplicationInfo element is required if this element is true.
IsDpIgnored xsd:boolean
True if an administrator has chosen To ignore this Dataset for purposes of data protection. Data sets with this attribute set To true are not returned when the client requests Datasets which are not ignored. This attribute has no other significance To the system.
IsDpSuspended xsd:boolean
True if an administrator has chosen To suspend data protection of this Dataset.

Deprecated field. Retained for backward compatibility. This field is deprecated in favour of IsSuspended, which suspends the Dataset for all automated actions (data protection and conformance check of the Dataset).
IsDrCapable xsd:boolean
True if this Dataset has a data protection Policy associated with it that is disaster recovery capable.
IsEnableWriteGuaranteeChecks xsd:boolean
optional
If true, periodic write guarantee checks are enabled for the Dataset. This Option is applicable only for Datasets which have SAN thin provisioning Policy associated. Presence of lun-clones, flex-clones, SFSR operations in the Volume may Effect write guarantees in SAN thin provisioning configurations. Periodic write guarantee checks detect such Condition and generate alerts. For other Datasets the Option is ignored. default Value is true.
IsProtected xsd:boolean
True if this Dataset has a data protection Policy associated with it.

Deprecated field. Retained for backward compatibility. This field is deprecated and To be replaced by HasProtectionPolicy.
IsSuspended xsd:boolean
True if an administrator has chosen To suspend this Dataset for all automated actions (data protection and conformance check of the Dataset).
IsVfilerCreatedForMigration xsd:boolean
optional
Indicates whether the vFiler Unit attached To the Dataset node was created by Provisioning Manager for migration. This element is present only when VfilerId element is present. Default: false.
MaximumLunsPerVolume xsd:integer
optional
Dataset level Option that specifies the Maximum number of Luns that can be provisioned in a Volume. If the Value is empty, then the Value of the global Option maxLUNsPerVolume is applicable for the Dataset.
MaximumQtreesPerVolume xsd:integer
optional
Dataset level Option that specifies the Maximum number of Qtrees that can be provisioned in a Volume. If the Value is empty, then the Value of the global Option maxQtreesPerVolume is applicable for the Dataset.
MemberCount xsd:integer
The Count of direct Members in the Dataset. Range: [0..2^31-1]
OnlineMigration xsd:boolean
optional
Indicates, that this Dataset is capable of non-disruptive migration. This field is valid only when either DatasetAccessDetails or VfilerId is not empty. By default the migration will be assumed To be disruptive. Default: false.
ProtectionPolicyId ObjId
optional
Identifier of the protection Policy governing this Dataset.
ProtectionPolicyName ObjName
optional
Name of the protection Policy governing this Dataset.
ProvisioningPolicyId ObjId
optional
Identifier of the provisioning Policy associated with primary node of the Dataset.
ProvisioningPolicyName ObjName
optional
Name of the provisioning Policy associated with the primary node of the Dataset.
RequiresNonDisruptiveRestore RequiresNonDisruptiveRestore
Specifies whether the Dataset is configured To enable non-disruptive restores.
ResourcepoolId ObjId
optional
Identifier of the Resource pool assigned To the root storage set. The output element is omitted if no resouce pool has been assigned To the root storage set.

If more than one Resource pool is assigned To the Dataset node, then the Resource pool with the least valued identifier is returned in this field.

This is a legacy parameter and Resourcepools field should be used instead To get the list of all Resource pools assigned To the Dataset node.
ResourcepoolName ObjName
optional
Name of the Resource pool assigned To the root storage set. The output element is omitted if no Resource pool has been assigned To the root storage set.

If more than one Resource pool is assigned To the Dataset node, then the Name of the Resource pool with the least valued identifier is returned in this field.

This is a legacy parameter and Resourcepools field should be used instead To get the list of all Resource pools assigned To the Dataset node.
Resourcepools ArrayOfDatasetResourcepoolInfo
optional
Information of the Resource pool(s) assigned To the root storage set. The output element is omitted if no Resource pool(s) has been assigned To the root storage set.
StorageServiceId ObjId
optional
Identifier of the storage Service To which this Dataset is attached. This will not be present if the Dataset is not attached To a storage Service.
StorageServiceName ObjName
optional
Name of the storage Service To which this Dataset is attached. This will not be present if the Dataset is not attached To a storage Service.
StoragesetId ObjId
Identifier of the storage set representing the primary data, or "root," of the Dataset.
StoragesetName ObjName
Name of the storage set representing the primary data, or "root," of the Dataset.
StoragesetTimezone xsd:string
Time zone, if any, of the root storage set. Return an empty string if no time zone has been assigned To the root storage set. Currently valid time zones can be listed by TimezoneListInfoIterStart.
VfilerId ObjId
optional
Identifier of the vFiler Unit attached To the primary node of the Dataset.
VfilerName ObjFullName
optional
Name of the vFiler Unit attached To the primary node of the Dataset.
VolumeQtreeNamePrefix xsd:string
Prefix for Volume and Qtree names, up To 60 characters long.

 
Element definition: DatasetLunMappingInfo [top]
Specifies the Hosts and/or Initiators To which LUNs in this Dataset node will be mapped, and the igroup OS Type.
Name Type Description
IgroupOsType xsd:string
Specifies the OS Type for Initiators To map LUNs in the Dataset node To. Possible Values are: 'windows', 'windows_gpt', 'windows_2008', 'hpux', 'aix, 'linux, 'solaris', 'vmware' and 'netware'. Here "windows_gpt" refers To Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers To Windows Longhorn systems.
LunMappingInitiators ArrayOfLunMappingInitiator
Specifies the Initiators To map LUNs in the Dataset node To, and, optionally, the Host To which they belong.

 
Element definition: DatasetMemberInfo [top]
Information about one member of a Dataset.
Name Type Description
CifsShareNames ArrayOfCifsShareName
optional
List of share names for accesing the storage container (volume/qtree) when access Protocol of storage set is "CIFS" or "Mixed".
CifsSharesInfo ArrayOfCifsShareInfo
CIFS share settings of a Dataset member. Applicable is the Dataset member (volume/qtree) is exported over CIFS Protocol.
DpNodeName DpPolicyNodeName
optional
Display Name of the Policy node To which the member is attached. This element is only included if a data protection Policy is associated with the Dataset.
IsAvailable xsd:boolean
optional
True if this object and all of its parents are up or online. Only valid for Members of Type "ossv-host," "ossv-dir," "Filer," "Vfiler," "Aggregate," "Volume," or "Qtree".
LunIgroupsInfo ArrayOfLunIgroupInfo
optional
If the LUN has been mapped To any igroups or Hosts, this field contains information relevant To the same. This field is present only for LUNs, and absent if the LUN is not mapped To any initiator Groups.
MemberId ObjId
Identifier of the member.
MemberName ObjName
Display Name of the member.
MemberPerfStatus ObjStatus
Current Status of the member based on the worst performance event.
MemberStatus ObjStatus
Current Status of the member.
MemberType xsd:string
Type of the member. Possible Values for direct Members are: "Volume", "Qtree" or "ossv_directory". When IncludeExportsInfo is true in DatasetMemberListInfoIterStart, this can also be "lun_path".
NfsExportName xsd:string
optional
Name by which the storage container(volume/qtree) has been exported. The Volume or Qtree can be exported with a different Path From its physical Path on the Filer (with -actual Option in the NFS export rule. Example: "/vol/myvol/myqtree" can be exported as "myexport") if not this will be same as full Path of the container.
NfsExportRules NfsExportRules
NFS export rule information of a Dataset member. Applicatble if the Dataset member (volume/qtree) is exported over NFS Protocol.
SpaceInfo SpaceInfo
optional
Space related information of a Dataset member. Included in the output only if IncludeSpaceInfo was true in the call To DatasetMemberListInfoIterStart. Note that some Members will not have space related information. Those Type of Members are:
  • Non Qtree data
  • Qtrees without hard disk quota limit.
In these cases, it is considered that the space Status of such Members is unknown.
StoragesetId ObjId
Identifier of the storage set To which the member belongs.
StoragesetName ObjName
Name of the storage set To which the member belongs.

 
Element definition: DatasetMemberParameter [top]
Information about one member of a Dataset.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the data protection Policy node associated with the object. If DpNodeName is not specified, the object is added To the root data protection Policy node.
ObjectNameOrId ObjNameOrId
Identifier of the object To add To or remove From the Dataset.

 
Element definition: DatasetNfsExportSetting [top]
If storage inside this Dataset node is exported over NFS, this specifies some of the common Properties that will be applied To all such provisioned storage.
Name Type Description
AnonymousAccessUser xsd:integer
optional
If the client accessing the export is not present in the root access list for the export, the effective user for root is the Value specified for this field. Default Value is 65534 which maps To user nobody. It could be an integer Range: [0..65534] or a user Name not more than 255 characters.
DisableSetuid xsd:boolean
optional
If true, causes the server file system To ignore attempts To enable the setuid or setgid mode bits. Default Value is true.
IsReadonlyForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-only permissions on nfs exports in this Dataset node. Equivalent To specifying "ro" on the Filer. Default Value is false. If true, IsReadwriteForAllHosts must be false.
IsReadwriteForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-write permissions on nfs exports in this Dataset node. Equivalent To specifying "rw" on the Filer. Default Value is false. If true, IsReadonlyForAllHosts must be false.
NfsExportRoHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-only permissions on exports in this Dataset node. If a non empty list of NfsExportRoHosts is present along with IsReadonlyForAllHosts as true, then ZAPI will throw an Error.
NfsExportRootHosts ArrayOfNfsExportHost
optional
A list of Hosts with the root user having read-only or read-write permissions on exports in this Dataset node.
NfsExportRwHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-write permissions on exports in this Dataset node. If a non empty list of NfsExportRwHosts is present along with IsReadwriteForAllHosts as true, then ZAPI will throw an Error.
NfsProtocolVersion xsd:string
optional
NFS Protocol Version, valid Values are "v2", "v3" and "v4". Default Value is "v3". If set, the storage systems that have the given Version enabled will be selected To provision storage for the Dataset.
NfsSecurityFlavors ArrayOfNfsSecurityFlavor
optional
List of strings specifying the security flavors supported on exports in this Dataset node. If this field is not specified, the default Value of 'sys' is assumed.

 
Element definition: DfmMetadataField [top]
Named field in the metadata.
Name Type Description
FieldName xsd:string
Name of the metadata field. Field names are up To 255 characters in Length and are case- insensitive.
FieldValue xsd:string
Arbitrary, user-defined data expressed as a string. The string is opaque To the server and must not exceed 16384 (16k) characters in Length.

 
Element definition: DryRunResult [top]
A Description of one Action and the predicted effects of taking that Action.
Name Type Description
DryRunAction xsd:string
An Action the system would take.
DryRunEffect xsd:string
The predicted Effect of the Action.
DryRunReason xsd:string
optional
Present only if Severity is Error or warning. Specifies possible reasons for the Error, warning. If there are no reasons To specify, this element will not be present.
DryRunReasonDetails ArrayOfResultDetail
optional
These details apply To the associated DryRunReason within the same DryRunResult. These offer additional information such as the reasons individual reasources may not have been selected for the DryRunAction in this same DryRunResult.
DryRunSeverity ObjStatus
Severity of the DryRun Result. Possible Values are "information", "Error" or "warning".
DryRunSuggestion xsd:string
Present only if Severity is Error or warning. Specifies any suggestions To rectify the warnings, Errors. If there are no suggestions To specify, this element will not be present.

 
Element definition: JobInfo [top]
Job information of provisioning Request.
Name Type Description
JobId xsd:integer
Identifier of job started for the provisioning Request.

 
Element definition: MissingMemberInfo [top]
Information about one missing member of a Dataset.
Name Type Description
AggregateId ObjId
Identifier of the Aggregate To which the member belongs.
AggregateName ObjName
Name of the Aggregate To which the member belongs.
CifsShareNames ArrayOfCifsShareName
optional
List of share names for accesing the storage container (volume/qtree) when access Protocol of storage set is "CIFS" or "Mixed". Example \\server\sharename.
DeletedTimestamp DpTimestamp
The time and date when the object was deleted.
HostId ObjId
Identifier of the Host To which the member belongs.
Hostname ObjName
Name of the Host To which the member belongs.
MemberId ObjId
Identifier of the missing member.
MemberName ObjName
Display Name of the missing member.
MemberType xsd:string
Type of the missing member. Possible Values are 'Volume', 'Qtree'.
NfsExportName xsd:string
optional
Name by which the storage container(volume/qtree) has been exported, when access Protocol of storage set is "NFS" or "Mixed". The Volume or Qtree can be exported with a different Path From its physical Path on the Filer (with -actual Option in the NFS export rule. Ex "/vol/myvol/myqtree" can be exported as "myexport") if not this will be same as full Path of the container.
QuotaHardLimit xsd:integer
optional
The hard limit on the amount of space a user can use in kilobytes. Range: [1..2^63-1] Valid only for Qtree Members.
QuotaSoftLimit xsd:integer
optional
The soft limit on the amount of space a user can use in kilobytes. Range: [1..2^63-1] Valid only for Qtree Members.
SpaceGuarantee xsd:string
optional
The space guarantee setting for a Volume member. Possible Values are "none," "file," or "Volume." Valid only for Volume Members.
TotalSpace xsd:integer
optional
Specifies the Total capacity of the Dataset member, in kilobytes. Range: [1..2^63-1] Valid only for Volume Members.

 
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: ReplaceResult [top]
A Description of one replace Action.
Name Type Description
DpNodeName DpPolicyNodeName
optional
Name of the data protection Policy node associated with the secondary Volume or Qtree.
MemberType xsd:string
Type of the object replaced. Possible Values are "Volume", or "Qtree".
NewPrimaryMemberId ObjId
optional
Identifier of the new primary member replacing the old. NewPrimaryMemberId is omitted if the ReplaceStatus is "not_found".
NewPrimaryMemberName ObjName
optional
Display Name of the new primary member replacing the old. NewPrimaryMemberName is omitted if the ReplaceStatus is "not_found".
OldPrimaryMemberId ObjId
optional
Identifier of the primary member that needs To be replaced. OldPrimaryMemberId is omitted if the ReplaceStatus is "not_required".
OldPrimaryMemberName ObjName
optional
Display Name of the primary member that was replaced. OldPrimaryMemberName is omitted if the ReplaceStatus is "not_required".
ReplaceStatus xsd:string
Possible Values are "not_found", "not_required", or "replaced". "not_found" is returned if a replacement primary was not found. "not_required" is returned if the primary did not need To be replaced. "replaced" is returned if the primary was successfully replaced.
SecondaryMemberId ObjId
Identifier of the secondary member whose primary member needs To be replaced.
SecondaryMemberName ObjName
Displayed Name of the secondary member whose primary member needs To be replaced.

 
Element definition: ArrayOfCifsShareInfo [top]
Name Type Description
CifsShareInfo CifsShareInfo[]

 
Element definition: ArrayOfCifsShareName [top]
Name Type Description
CifsShareName CifsShareName[]

 
Element definition: ArrayOfDatasetCifsSharePermission [top]
Name Type Description
DatasetCifsSharePermission DatasetCifsSharePermission[]

 
Element definition: ArrayOfDatasetMapEntry [top]
Name Type Description
DatasetMapEntry DatasetMapEntry[]

 
Element definition: ArrayOfDatasetResourcepoolInfo [top]
Name Type Description
DatasetResourcepoolInfo DatasetResourcepoolInfo[]

 
Element definition: ArrayOfLunIgroupInfo [top]
Name Type Description
LunIgroupInfo LunIgroupInfo[]

 
Element definition: ArrayOfLunMappingInitiator [top]
Name Type Description
LunMappingInitiator LunMappingInitiator[]

 
Element definition: ArrayOfNfsExportHost [top]
Name Type Description
NfsExportHost NfsExportHost[]

 
Element definition: ArrayOfNfsSecurityFlavor [top]
Name Type Description
NfsSecurityFlavor NfsSecurityFlavor[]

 
Element definition: ArrayOfResultDetail [top]
Name Type Description
ResultDetail ResultDetail[]

 
Element definition: ConformanceAlertType [top]
The Type of alert that is being issued is indicated by a field of this Type. The alert-type may apply To the ConformanceAlerts.

Possible Values are: 'diskspace' and 'rebaseline'.

  • diskspace: An alert can be issued for when DFM station disk space is so low as To impact the Operation of DFM.
  • rebaseline: When the system detects that existing relationships are in need of migration an alert of this Type may be issued To warn that a rebaseline may be done should the user confirm conformance for non-conformant Datasets.
Please see ConformanceAlerts where the above Values may be used for additional information.
[none]

 
Element definition: DatasetMigrationInfo [top]
Dataset's migration information.
Name Type Description
Description xsd:string
optional
Description associated with the migration task
DestinationFilerId ObjId
Database ID of the destination storage system
DestinationFilerName ObjFullName
Full Name of the destination storage system
DestinationVfilerId ObjId
optional
Database ID of the destination Vfiler. If the migration Status is 'migrate_failed' and the destination Vfiler has been destroyed as a Result of rollback activity. this field will not be present.
DestinationVfilerName ObjFullName
optional
Full Name of the destination Vfiler. If the migration Status is 'migrate_failed' and the destination Vfiler has been destroyed as a Result of rollback activity. this field will not be present.
MigrationStatus MigrationStatus
Migration Status of the Dataset
ProvisioningPolicyId ObjId
optional
Provisioning Policy used To provision the migration destination
ProvisioningPolicyName ObjFullName
optional
Name of the provisioning Policy used To provision the migration destination.
SourceFilerId ObjId
Database ID of the Source storage system
SourceFilerName ObjFullName
Full Name of the Source storage system
SourceVfilerId ObjId
Database ID of the Source Vfiler
SourceVfilerName ObjFullName
Full Name of the Source Vfiler

 
Element definition: DatasetStatus [top]
The complex Status of the Dataset at the time it was last re-calculated.
Name Type Description
ConformanceCheckResults ArrayOfConformanceRunResult
optional
Results of the most recent conformance check. If the Dataset does not have a data protection Policy assigned To it, this element will not be present.
ConformanceStatus xsd:string
A Dataset is in conformance if it is configured according To Policy. For example, a data protection Policy might require provisioned secondary and tertiary Volumes and the creation of backup and mirroring relationships. If they are properly configured, then the Dataset is conformant.

If the Dataset is not conformant, but the system is currently in the process of bringing the data set into conformance, then the Dataset is conforming. If the system is unable To satisfy one or more Policy requirements, then the Dataset is nonconformant.

Possible Values are: 'conformant', 'conforming', 'nonconformant'.
DrProtectionStatus xsd:string
optional
The DR protection Status only applies To Datasets with data protection policies and only To protection Policy connections which are disaster recovery capable.

A system may be up and running and properly configured, yet not protecting data. For example, if the Lag Thresholds specified by the Policy are exceeded, then the data is not being sufficiently protected.

Possible Values are

  • protected : Dataset has complete backup versions on all nodes of the Dataset that are To retain Backups as per Policy. This is a normal Condition.
  • uninitialized : Dataset is missing some data protection relationships. This is a warning Condition.
  • protection_suspended : Dataset has been suspended as administrator requested and is not performing data protection or conformance operations. This is a warning Condition.
  • protection_failure : Dataset has a job failure while protecting data. This is a warning Condition.
  • lag_warning : Last successful data transfer on the connection or the most recent protected data on the primary node is older than the Lag warning threshold. This is a warning Condition.
  • lag_error : Last successful data transfer on the connection or the most recent protected data on the primary node is older than the Lag Error threshold. This is an Error Condition.
  • baseline_failure : Dataset has a baseline job failure and is not able To register any backup Version. This is an Error Condition.

DrStatus DrStatus
optional
The Status of the Dataset with regard To Disaster Recovery. The DR Status determines how successful a DR Operation such as a failover likely would be if it were performed on the Dataset.
DrStatusProblems ArrayOfDrStatusProblem
optional
A list of the problems found that cause the data set not To have a DrStatus of "normal". This list is not guaranteed To contain all problems related To DR Status.

If DrStatus is present and does not have the Value "normal", then this element appears in the output, and the list contains at least one item. Otherwise, it does not appear.
PerformanceStatus ObjStatus
Performance Status of the Dataset based on the worst performance Events on its Members.
ProtectionStatus xsd:string
optional
The protection Status only applies To Datasets with data protection policies.

A system may be up and running and properly configured, yet not protecting data. For example, if the Lag Thresholds specified by the Policy are exceeded, then the data is not being sufficiently protected.

Possible Values are

  • protected : Dataset has complete backup versions on all nodes of the Dataset that are To retain Backups as per Policy. This is a normal Condition.
  • uninitialized : The Dataset either doesn't have any data in it or it has a "local Snapshots only" Policy (it is a one-node Dataset) and the schedule for that Policy haven't kicked off any Jobs as of yet (or there is no schedule at all). An application Dataset could also reach this Status after it has been created and no scheduled job is run. This is a warning Condition.
  • protection_suspended : Dataset has been suspended as administrator requested and is not performing data protection or conformance operations. This is a warning Condition.
  • protection_failure : Dataset has a job failure while protecting data. This is a warning Condition.
  • lag_warning : Last successful data transfer on the connection or the most recent protected data on the primary node is older than the Lag warning threshold. This is a warning Condition.
  • lag_error : Last successful data transfer on the connection or the most recent protected data on the primary node is older than the Lag Error threshold. This is an Error Condition.
  • baseline_failure : Dataset has a baseline job failure and is not able To register any backup Version. This is an Error Condition.

ProtectionStatusProblems ArrayOfProtectionStatusProblem
optional
A list of the problems found that cause the Dataset not To have a ProtectionStatus of "protected". This list is not guaranteed To contain all problems related To protection Status.

If ProtectionStatus does not have the Value "protected", then this element will be present in the output as long as the IncludeProtectionStatusProblems is set To true and only one Dataset is specified in the DatasetListInfoIterStart api. Otherwise, it does not appear.
ResourceStatus ObjStatus
The Resource Status is the "worst" Status of the resources relevant To the Dataset. Resource Status is calculated using the same rules as for DFM Resource Group Status.
SpaceStatus SpaceStatus
optional
Space Status of the Dataset. Space Status of every member of every node of the data set is considered and the worst space Status is considered as the space Status of the Dataset. Space Status for Members of a Dataset node is calculated only if a provisioning Policy is associated with that Dataset node.

 
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: NfsExportRules [top]
Specifies the NFS security configuration Options provided by Data ONTAP operating system.
Name Type Description
AnonymousAccessUser xsd:integer
optional
If the client accessing the export is not present in the root access list for the export, the effective user for root is the Value specified for this field. Default Value is 65534 which maps To user nobody. It could be an integer Range: [0..65534] or a user Name not more than 255 characters.
DisableSetuid xsd:boolean
optional
If true, causes the server file system To ignore attempts To enable the setuid or setgid mode bits. Default Value is true.
IsReadonlyForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-only permissions on nfs exports in this Dataset node. Equivalent To specifying "ro" on the Filer. Default Value is false. If true, IsReadwriteForAllHosts must be false.
IsReadwriteForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-write permissions on nfs exports in this Dataset node. Equivalent To specifying "rw" on the Filer. Default Value is false. If true, IsReadonlyForAllHosts must be false.
NfsExportRoHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-only permissions on exports in this Dataset node. If a non empty list of NfsExportRoHosts is present along with IsReadonlyForAllHosts as true, then ZAPI will throw an Error.
NfsExportRootHosts ArrayOfNfsExportHost
optional
A list of Hosts with the root user having read-only or read-write permissions on exports in this Dataset node.
NfsExportRwHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-write permissions on exports in this Dataset node. If a non empty list of NfsExportRwHosts is present along with IsReadwriteForAllHosts as true, then ZAPI will throw an Error.
NfsSecurityFlavors ArrayOfNfsSecurityFlavor
optional
List of strings specifying the security flavors supported on exports in this Dataset node. If this field is not specified, the default Value of 'sys' is assumed.

 
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: ProvisionMemberComment [top]
One comment field To fill in as part of the Request
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
Name or identifier of the comment field.
CommentValue CommentValue
Value of the comment field. An empty string can be used To unset the Value of the comment field for this object.

 
Element definition: Snapshot [top]
Information of one Snapshot copy. Either UniqueId or Name of the Snapshot copy should be specified.
Name Type Description
SnapshotName xsd:string
optional
Name of the Snapshot copy. If UniqueId is specified, then this element is ignored.
UniqueId xsd:string
optional
Unique identifier of the Snapshot copy. Currently, this is the Snapshot copy's creation time.

 
Element definition: SpaceInfo [top]
Specifies the Total, available and used space in a Dataset member, the space Status and various space related conditions of the member.
Name Type Description
AvailableSpace xsd:integer
optional
Specifies the space available in the Dataset member, in bytes. Range: [1..2^63-1]
SpaceConditions ArrayOfSpaceCondition
optional
Various space conditions of a Dataset member. Present only if the SpaceStatus of the Dataset member is one of 'Error' or 'warning'.
SpaceStatus SpaceStatus
optional
Space Status of the member.
TotalSpace xsd:integer
optional
Specifies the Total capacity of the Dataset member, in bytes. Range: [1..2^63-1]
UsedSpace xsd:integer
optional
Specifies the capacity used in the Dataset member, in bytes. Range: [1..2^63-1]

 
Element definition: ArrayOfConformanceRunResult [top]
Name Type Description
ConformanceRunResult ConformanceRunResult[]

 
Element definition: ArrayOfDrStatusProblem [top]
Name Type Description
DrStatusProblem DrStatusProblem[]

 
Element definition: ArrayOfProtectionStatusProblem [top]
Name Type Description
ProtectionStatusProblem ProtectionStatusProblem[]

 
Element definition: ArrayOfSpaceCondition [top]
Name Type Description
SpaceCondition SpaceCondition[]

 
Element definition: CifsShareInfo [top]
Specifies the Properties of a CIFS share on Data ONTPAP system.
Name Type Description
CifsShareName CifsShareName
Name of the CIFS share.
CifsSharePermissions ArrayOfCifsSharePermission
ACL information of a CIFS share.

 
Element definition: CifsShareName [top]
CIFS share Name of the storage container (Volumes, Qtrees). Example \\server\sharename.
[none]

 
Element definition: CommentFieldNameOrId [top]
Name or identifier of the comment field. It must conform To one of the following formats:
  • It must be of the format of CommentFieldName
  • It must be of the format of CommentFieldId
[none]

 
Element definition: CommentValue [top]
Value of the specified comment field To be set on the object. This can be of Maximum 1024 characters.
[none]

 
Element definition: DatasetCifsSharePermission [top]
A single Permission granted To a user on CIFS shares within a Dataset node.
Name Type Description
CifsUsername xsd:string
Name of a user in the specified domain. The Username may be the Name of an actual domain user or one of the built-in names - 'administrator' or 'everyone'.
Permission CifsPermission
Specifies the permissions granted To a user.

 
Element definition: DatasetMapEntry [top]
Map a storage set To a Policy node. The root node is not included in the map.
Name Type Description
DatasetAccessDetails DatasetAccessDetails
optional
Data access details for a Dataset. This is returned only when a Dataset is configured To be capable of transparent migration.
DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for the storage set. This field is present only if the IncludeExportSettings field was set To true in DatasetListInfoIterStart for this iteration.
DpNodeId xsd:integer
ID of the node in the data protection Policy. Range: [1..2^31-1].
DpNodeName DpPolicyNodeName
Name of the node in the data protection Policy topology.
IsDrCapable xsd:boolean
True if this node is the destination of a disaster recovery capable connection in the data protection Policy.
IsVfilerCreatedForMigration xsd:boolean
optional
Indicates whether the vFiler Unit attached To the Dataset node was created by Provisioning Manager for migration. This element is present only when VfilerId element is present.
ProvisioningPolicyId ObjId
optional
Identifier of the provisioning Policy associated with the Dataset node.
ProvisioningPolicyName ObjName
optional
Name of the provisioning Policy associated with the Dataset node.
ResourcepoolId ObjId
optional
Identifier of the Resource pool assigned To the storage set that maps To the Policy node. The output element is omitted if no Resource pool has been assigned To the storage set.

If more than one Resource pool is assigned To the Dataset node, then one of them is returned in this field.

This is a legacy parameter and Resourcepools field should be used instead To get the list of all Resource pools assigned To the Dataset node.
ResourcepoolName ObjName
optional
Name of the Resource pool assigned To the storage set that maps To the Policy node. The output element is omitted if no Resource pool has been assigned To the storage set.

If more than one Resource pool is assigned To the Dataset node, then the Name of the Resource pool with the least valued identifier is returned in this field.

This is a legacy parameter and Resourcepools field should be used instead To get the list of all Resource pools assigned To the Dataset node.
Resourcepools ArrayOfDatasetResourcepoolInfo
optional
Name Information of the Resource pool(s) assigned To the storage set that maps To the Policy node. The output element is omitted if no Resource pool(s) has been assigned To the storage set.
StoragesetId ObjId
Identifier of the storage set that maps To the Policy node.
StoragesetName ObjName
Name of the storage set that maps To the node.
StoragesetTimezone xsd:string
Time zone specification, if any, of the storage set. Storage sets without time zones use a time zone From the Resource pool the storage came From, or From a default time zone. Return an empty string if no time zone has been assigned To the storage set. Currently valid time zones can be listed by TimezoneListInfoIterStart.
VfilerId ObjId
optional
Identifier of the vFiler Unit attached To the Dataset node.
VfilerName ObjFullName
optional
Name of the vFiler Unit attached To the Dataset node.

 
Element definition: DatasetResourcepoolInfo [top]
Information about Resource pools associated with Dataset.
Name Type Description
ResourcepoolId ObjId
Identifier of the Resource pool assigned To the storage set.
ResourcepoolName ObjName
Name of the Resource pool assigned To the storage set. storage set.

 
Element definition: DrStatus [top]
The DR Status has one of the following Values:
  • normal : A DR Operation would likely succeed, and the amount of lost data would be within the Duration specified by the Lag warning threshold.
  • warning : A DR Operation would likely succeed, but the amount of lost data would exceed that specified by the Policy's Lag warning threshold.
  • Error : A DR Operation would likely fail, or would succeed but the amount of lost data would be unacceptable.

The DR Status is computed based on all of the following:

  • The Resource Status of the Dataset's DR secondaries. The specific Condition that impacts the Resource Status is the availability of the secondary filers and Volumes. The Status will be Error if either is unavailable.
  • Whether there is sufficient space on the DR secondaries To meet the space guarantees of the primaries.
  • The existence and state of the relationships associated with the Dataset's disaster recovery capable connection.
  • Whether the relationships associated with the Dataset's DR-capable connection are within their Thresholds for Lag warnings and Errors.

If the Dataset list iteration's output element IsDrCapable is true, then this element appears in the output. Otherwise, if IsDrCapable is false, this element does not appear in the output.
[none]

 
Element definition: LunIgroupInfo [top]
If the LUN has been mapped To any igroups or Hosts, this structure contains information relevant To the same.
Name Type Description
IgroupInitiators ArrayOfLunMappingInitiator
optional
Specifies the Initiators and/or Hosts To which the LUN is mapped, if any.
IgroupLunId xsd:integer
If the LUN has been mapped To any initiator Groups, this field contains the ID generated by the storage system for the LUN. Range: [1..2^31-1]
IgroupName ObjName
Name of the igroup.
IgroupOsType xsd:string
Specifies the OS Type of the igroup. Possible Values: "solaris", "windows_gpt", "windows_2008", "windows", "hpux", "aix", "linux", "netware", "vmware". Here "windows_gpt" refers To Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers To Windows Longhorn systems.
IgroupProtocol xsd:string
Specifies the Protocol for the initiator Group. Possible Values: "fcp", "iscsi".

 
Element definition: LunMappingInitiator [top]
Specifies an initiator To map LUNs in the Dataset node To, and, optionally, the Host To which it belongs.
Name Type Description
Hostname xsd:string
optional
Specifies the Name of the Host which owns the initiator.
InitiatorId InitiatorId
Specifies an initiator Id on a Host To which a LUN should be mapped.

 
Element definition: MigrationStatus [top]
Migration Status for an ongoing vFiler Unit migration. Possible Values: "in_progress", "migrating", "migrated", "migrated_with_errors", "migrate_failed", "rolled_back", "rolled_back_with_errors".
[none]

 
Element definition: NfsExportHost [top]
Specifies a single Host or all-hosts. A Host can be a Host Name (DNS Name), an IP Address, a subnet or a domain Name. If an 'all-hosts' entry is present, all other Host Name entries must be negated.
Name Type Description
Hostname xsd:string
optional
Specifies a single Host Name entry. A Host Name may be a DNS Name, an IP Address, a subnet (specified as <subnet Address>/<prefix Length> i.e. CIDR notation or '[network] <subnet-address> [netmask] <Netmask>'), a domain, or a workgroup.
IsAnException xsd:boolean
optional
Specifies that the rule does not apply To this Host. Should be used when it is required To grant permissions To Hosts in a subnet or a domain or all Hosts excluding some. Default Value is false.

 
Element definition: NfsSecurityFlavor [top]
A security flavor To be applied on nfs exports. Possible Values are 'none', 'sys' (Unix Style), 'krb5' (Kerberos v5) , krb5i' (Kerberos v5 integrity) and 'krb5p' (Kerberos v5 privacy). Default Value is 'sys'.
[none]

 
Element definition: ResultDetail [top]
Details on a specific Action that adds information intended To explain more about a higher level Result. For example, the detail may be used To explain a DryRun Result by explaining why resources were not selected.
Name Type Description
Action xsd:string
An Action or check the system had taken.
Effect xsd:string
The Result of the Action or check.
Reason xsd:string
optional
Specifies possible reasons for the this Result. If there are no reasons To specify, this element will not be present.
Severity ObjStatus
Severity of the Result Result. Possible Values are "information", "Error" "warning". It is normal for "information" To be used To explain why a Resource was not selected.
Suggestion xsd:string
Specifies any suggestions To rectify the information, warnings, Errors. If there are no suggestions To specify, this element will not be present.

 
Element definition: SpaceStatus [top]
Worst space Status of a Dataset or a member. Possible Values are: 'unknown', 'ok', 'warning', 'Error'
[none]

 
Element definition: ArrayOfCifsSharePermission [top]
Name Type Description
CifsSharePermission CifsSharePermission[]

 
Element definition: CifsPermission [top]
Permission granted To a CIFS user on a share. Possible Values are 'no_access', 'read', 'change' and 'full_control'
[none]

 
Element definition: ConformanceRunResult [top]
A Description of one Action and the predicted effects of taking that Action.
Name Type Description
ConformanceJobId ObjId
optional
job Id of the conformance job.
ConformanceRunAction xsd:string
An Action the system has taken.
ConformanceRunEffect xsd:string
The Result of the Action.
ConformanceRunReason xsd:string
optional
Present only if Severity is Error or warning. Specifies possible reasons for Error, warning. If there are no reasons To specify, this element will not be present.
ConformanceRunReasonDetails ArrayOfResultDetail
optional
These details apply To the associated ConformanceRunReason within the same ConformanceRunResult. These offer additional information such as the reasons individual reasources may not have been selected for the ConformanceRunAction in this same ConformanceRunResult.
ConformanceRunSeverity ObjStatus
Severity of conformance Action. Possible Values are "information", "Error", "warning".
ConformanceRunSuggestion xsd:string
optional
Present only if Severity is Error or warning. Specifies any suggestions To rectify warnings or Errors. If there are no suggestions To specify, this element will not be present.

 
Element definition: DrStatusProblem [top]
An explanation of a single problem that causes the Dataset not To have a DrStatus of "normal".
Name Type Description
DrStatusDescription xsd:string
A human-readable message describing the problem.
DrStatusSeverity xsd:string
Value is "warning" if the problem causes the data set To have a DrStatus of at least "warning". Value is "Error" if the problem causes the Dataset To have a DrStatus of at least "Error".

 
Element definition: InitiatorId [top]
For FCP Initiators, this is a string composed of 16 hexadecimal digits. For iSCSI Initiators, this is an initiator Name in the dotted-domain notation.
[none]

 
Element definition: ProtectionStatusProblem [top]
Information about a problem that resulted in the Dataset To not have ProtectionStatus as "protected".
Name Type Description
ProtectionStatusDescription xsd:string
A human readable Description of why ProtectionStatus was not found To be "protected". The Description may also contain suggestions that may be helpful in resolving the protection Status problem.
ProtectionStatusJobDetails ArrayOfProtectionStatusJobDetail
optional
Details about one or more Jobs that caused this ProtectionStatusProblem.
ProtectionStatusName xsd:string
A short Name for a Type of ProtectionStatus problem. This Name is intended To ease machine readability and is not expected To be displayed To a user.

Possible Values are

  • uninitialized_no_dp_policy : No protection Policy is assigned.
  • uninitialized_dp_policy_none : The Policy named 'No Protection' is assigned.
  • uninitialized_no_data_to_protect : The Dataset does not contain any data To be protected.
  • uninitialized_no_destination_storage : The Dataset does not contain storage for one or more destination nodes.
  • uninitialized_no_relationships : The Dataset has no relationships in one or more connections.
  • uninitialized_conforming : The Dataset is conforming.
  • uninitialized_nonconformant : The Dataset is not in a conformant state.
  • suspended : Dataset is suspended so no protection schedules will create backup versions in this state.
  • uninitialized_single_node_no_backups : Dataset has one node and no Backups have finished
  • no_backup_version : The multi-node Dataset does not have any backup versions.
  • uninitialized_application_dataset : Application Dataset requires at least one backup Version.
  • failed_baseline : At least one initial baseline data transfer failed To create a relationship.
  • failed_local_backup : Local Backups failed on the primary node.
  • failed_backup_job : One or more backup Jobs has failed.
  • failed_mirror_job : One or more mirror copy Jobs has failed.
  • lag_warning_local_backup : The most recent local backup (Snapshot copy) on the primary node is older than the threshold setting permits.
  • lag_warning_since_last_backup : The time since the last successful backup job exceeds the Lag warning threshold.
  • lag_warning_since_last_mirror : The time since the last successful mirror copy job exceeds the Lag warning threshold.
  • lag_error_local_backup : The most recent local backup (Snapshot copy) on the primary node is older than the threshold setting permits.
  • lag_error_since_last_backup : The time since the last successful backup job exceeds the Lag Error threshold.
  • lag_error_since_last_mirror : The time since the last successful mirror copy job exceeds the Lag Error threshold.


 
Element definition: SpaceCondition [top]
Represents a space Condition of a Dataset member.
Name Type Description
Condition xsd:string
Space Condition. Possible Values:
  • "volume-used-vs-size-above-nearly-full" Used space of the Volume vs Volume usable data space has crossed nearly full threshold specified in the Policy
  • "volume-used-vs-size-above-full" Used space of the Volume vs Volume usable data space has crossed full threshold specified in the Policy
  • "volume-used-vs-maximum-size-above-nearly-full" Used space of the Volume vs Volume usable Maximum data space has crossed nearly full threshold specified in the Policy
  • "volume-used-vs-maximum-size-above-full" Used space of the Volume vs Volume usable Maximum data space has crossed full threshold specified in the Policy
  • "qtree-used-vs-quota-above-nearly-full" Qtree used space vs Qtree hard limit has crossed nearly full threhsold specified in Policy
  • "qtree-used-vs-quota-above-full" Qtree used space vs Qtree hard limit has crossed full threhsold specified in Policy
  • "volume-snapshot-used-above-full-threshold" Snapshot used space in the Volume has crossed volSnapshotFullThreshold specified in Operations Manager.
  • "volume-no-next-snapshot" Next Snapshot is not possible in the Volume due To space contraints
Reason xsd:string
optional
Reason for this space Condition. This can be a Maximum of 1024 characters.
Severity xsd:string
optional
Severity of this space Condition. Possible Values are: "unknown", "ok", "warning", "Error"
Suggestion xsd:string
optional
Possible Action that can be taken To correct this. This can be a Maximum of 1024 characters.

 
Element definition: ArrayOfProtectionStatusJobDetail [top]
Name Type Description
ProtectionStatusJobDetail ProtectionStatusJobDetail[]

 
Element definition: CifsSharePermission [top]
CIFS ACL information configured for a CIFS share.
Name Type Description
CifsUsername xsd:string
Name of the user configured To access a CIFS share.
Permission xsd:string
CIFS Permission configured for the user accessing a CIFS share.

 
Element definition: ProtectionStatusJobDetail [top]
Details about a job that led To a ProtectionStatusProblem
Name Type Description
ProtectionStatusJobDescription xsd:string
Description of what the job is trying To accomplish.
ProtectionStatusJobId xsd:integer
Identifier of the job. Range: [1..2^31-1].
ProtectionStatusJobStatus DpJobOverallStatus
Overall Status of the job based on JobProgress and JobState.
ProtectionStatusJobType DpJobType
Type of data protection job.

 
Element definition: DpJobOverallStatus [top]
The overall Status of the data protection/provisioning job. The possible Values are "queued", "canceling", "canceled", "running", "running_with_failures", "partially_failed", "succeeded", and "failed". This field is derived From DpJobState and DpJobProgress.
The current mappings are as follow: 
 DpJobState DpJobProgress DpJobOverallStatus 
 ===================================================== 
 queued * queued 
 running in_progress running 
 running success running 
 running partial_success running_with_failures 
 running failure running_with_failures 
 aborting * canceling 
 aborted * canceled 
 completed partial_success partially_failed 
 completed failure failed 
 completed success succeeded 
 completed in_progress canceled
[none]

 
Element definition: DpJobType [top]
The Type of data protection, provisioning, migration or space management job. Valid Values for data protection Jobs are "local_backup", "local_backup_confirmation", "remote_backup", "mirror", "restore", "create_relationship", "destroy_relationship", "on_demand_backup" and "failover".

Valid Values for provisioning job types are "provision_member", "resize_member", "destroy_member", "delete_snapshots", "dedupe_member", "undedupe_member", "dedupe_volume" and "pm_re_export".

Valid space management Jobs are: "dedupe_volume", "migrate_volume", "resize_volume", "delete_snapshot" and "delete_backup".

Valid migration job types are: "migrate_start", "migrate_complete", "migrate_cancel", "migrate_cleanup", "migrate_update".
[none]