Input Name	Range	Type	Description
dataset-member-parameters		dataset-member-parameter[]	List of members to add to the data set.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]
is-existing-member-ok		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, is-existing-member-ok is false.

Errno	Description
EEDITSESSIONNOTFOUND
EALREADYINDATASET
EDPPOLICYNODENOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTMEMBERVFILERMISMATCH
EINVALIDOBJECTTYPE

Add dynamic reference to an existing data set. By adding a dynamic reference, the volumes, qtrees, and ossv directories referred to by the dynamic reference become implicit (indirect) members of the data set. A dynamic reference can be added to a particular storage set in the data set 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	Range	Type	Description
dataset-dynamic-reference-parameters		dataset-dynamic-reference-parameter[]	List of dynamic-references to add to the data set.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]

Errno	Description
EEDITSESSIONCONFLICTINGOP
EEDITSESSIONNOTFOUND
EALREADYINDATASET
EDPPOLICYNODENOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EINVALIDOBJECTTYPE
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTMEMBERVFILERMISMATCH

Add resource pool to a single storage set that is part of a data set. 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 dataset-add-resourcepool, you may also add or remove members or dynamic references, or change the data set's name, description, is-dp-ignored, is-dp-suspended, or is-suspended. 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 data set 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 data set. EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in resource pool.

Input Name	Range	Type	Description
dp-node-name		dp-policy-node-name optional	Name of the node in the data protection policy that maps to the storage set. dp-node-name must match exactly the name of one of the nodes in the data protection policy that is currently assigned to the data set. If dp-node-name is not specified, then the storage set associated with the root node is modified.
edit-lock-id		integer validate	Identifier of the edit lock for a data set that was obtained by an earlier call to dataset-edit-begin. Range: [1..2^31-1]
resourcepool-name-or-id		obj-name-or-id	Name or object identifier of a resource pool to add to the storage set.

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
ESTORAGESETNOTINDATASET
EDPPOLICYNODENOTFOUND
EEDITSESSIONCONFLICTINGOP
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL

Begin failover of a data set. This API begins the process of failing over a data set 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: The DR state of the data set will immediately change to "failing_over". Any pending conformance tasks will be cancelled. Any jobs running against this data set will be aborted. A failover job will be started to break any mirrors between the primary storage set and the DR storage set Finally, the DR state of the data set will be updated to either "failed_over" or "failover_error" based on whether the failover job succeeded or not.

Input Name	Range	Type	Description
dataset-name-or-id		string	Name or ID of data set.
Output Name	Range	Type	Description
job-id		integer	Identifier of the failover job that is failing the data set over to its DR secondary. If there was an error, the job id will be 0. Range: [1..2^31-1]

Errno	Description
EDATASETWRONGDRSTATE
EDATASETDRSTATEUNCHANGED
EDATASETFAILOVERNOTREADY
EINVALIDINPUT
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR

Begin test failover of a data set that only runs the the failover scripts and does not dequeue tasks, abort jobs or change the dr-state.

Input Name	Range	Type	Description
dataset-name-or-id		string	Name or ID of data set.
Output Name	Range	Type	Description
job-id		integer	Identifier of the failover job that is just running the DR scripts for the data set. If there was an error, the job id will be 0. Range: [1..2^31-1]

Errno	Description
EDATASETWRONGDRSTATE
EDATASETFAILOVERNOTREADY
EINVALIDINPUT
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR

Change the disaster recovery state of a data set. This API sets the DR state of a data set 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 "allow-internal-transitions" 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 data set will also change in one special case: The data set 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 dataset-set-storageset) When the edit session with these modifications is committed, the DR state will be set back to "ready".

Input Name	Range	Type	Description
allow-internal-transitions		boolean optional validate	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.
dataset-name-or-id		obj-name-or-id	Name or ID of data set.
dr-state		dr-state	Desired DR state of data set.

Errno	Description
EACCESSDENIED
EAPIAUTHENTICATION
EAPIERROR
EDATABASEERROR
EDATASETWRONGDRSTATE
EINTERNALERROR
EINVALIDINPUT
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND

Begin a conformance run on a data set, 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 data set's current conformance status, and the set of actions needed to bring the data set into conformance. Perform the conformance actions needed to bring the data set into conformance. In addition, the data set'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 data set'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 data set'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 data set, the conformance run completes immediately and performs no conformance actions. Error conditions: EACCESSDENIED - User does not have privileges to access the data set. EOBJECTNOTFOUND - No data set was found that has the given name or ID. EDATABASEERROR - A database error occurred while processing the request.

Input Name	Range	Type	Description
assume-confirmation		boolean optional	Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. One key and sometimes undesireable 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.
dataset-name-or-id		obj-name-or-id	Name or object ID for the data set.

Errno	Description
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR

Create a new, empty data set.

Input Name	Range	Type	Description
application-info		application-info optional	If is-application-data is true, then this element will contain information about the application which manages this data set.
dataset-contact		email-address-list optional	Contact for the data set, such as the owner's e-mail address.
dataset-description		string optional	Description of the new data set, up to 255 characters long.
dataset-metadata		dfm-metadata-field[] optional	Opaque metadata for data set. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
dataset-name		obj-name	Name of the new data set.
dataset-owner		string optional	Name of the owner of the data set, up to 255 characters long.
group-name-or-id		obj-name-or-id optional	Resource group to which the newly created data set should be added to. User should have DFM.Dataset.Write capability on the specified group. Default value: Global group.
is-application-data		boolean optional	If true, the data set is an application data set managed by an external application. Because backups must be coordinated between the application and DFM, transfers move backups between nodes instead of creating new backups. Policies for which this behavior is not supported may not be assigned to application data sets. The default value is false.
is-dp-suspended		boolean optional	Flag indicating whether or not the data set should be protected. This also indicates whether conformance checking of the data set is to be done or not. Default is False. Deprecated field. Retained for backward compatibility. This field is deprecated in favour of is-suspended, which suspends the data set for all automated actions (data protection and conformance check of the data set).
is-suspended		boolean optional	True if an administrator has chosen to suspend this data set for all automated actions (data protection and conformance check of the data set). Default is False. If present, this field takes precedence over is-dp-suspended.
protection-policy-id		obj-id optional	Identifier of the protection policy to associate with this data set. This legacy parameter is only used if protection-policy-name-or-id is not supplied. The dataprotection license is required for this input.
protection-policy-name-or-id		obj-name-or-id optional	Name or identifier of the protection policy to associate with this data set. This input is preferred over protection-policy-id and if supplied then do not supply protection-policy-id because protection-policy-id will be ignored. The dataprotection license is required for this input.
provisioning-policy-name-or-id		obj-name-or-id optional	Name or identifier of the provisioning policy to be associated with the primary node of the data set. The members of the primary node are provisioned based on this policy. Once the provisioning policy is associated with the data set node, the storage in the node is periodically monitored for conformance with the policy.
requires-non-disruptive-restore		requires-non-disruptive-restore optional	Specifies whether the data set should be configured to enable non-disruptive restores from backup destinations. Default value is false.
timezone-name		string optional	Timezone to assign to the root node. If specified, the value must be a timezone-name returned by timezone-list-info-iter-next. If no timezone is assigned, then the default system timezone will be used.
vfiler-name-or-id		obj-name-or-id optional	Name or identifier of the vFiler unit to be attached to the primary node of the data set. If a vFiler unit is attached, then all members provisioned into this node will be exported over this vFiler unit.
Output Name	Range	Type	Description
dataset-id		obj-id	Identifier of the new data set.

Errno	Description
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATASETEXISTS
EDATABASEERROR
EINVALIDTIMEZONE
EINTERNALERROR
EINVALIDMEMBER
EMEMBERALREADYINGROUP
EACCESSDENIED
EDSCONFLICTNDRESTORE
ENOTLICENSED

Destroy a data set. The data set must be empty unless the "force" option is used.

Input Name	Range	Type	Description
cancel-edit-sessions		boolean optional	Specifies if edit operations in progress on the data set should be cancelled. If true, any edit operations in progress on the data set are rolled back before destroying the data set. If cancel-edit-sessions is false, data set with pending edit operations cannot be destroyed. Default is false.
dataset-name-or-id		obj-name-or-id	Name or identifier of the data set to destroy.
force		boolean optional	If true, allows destroying a data set that has members or dynamic references. By default, only empty data sets can be destroyed.

Errno	Description
EDATASETNOTEMPTY
EDATASETFAILINGOVER
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONINPROGRESS

Ends iteration of the dynamic references in the data set.

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

Errno	Description
EINVALIDTAG

Get next records in the iteration started by dataset-dynamic-reference-list-info-iter-start

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve.
tag		string	Tag from a previous dataset-dynamic-reference-list-info-iter-start.
Output Name	Range	Type	Description
dataset-dynamic-references		dataset-dynamic-reference-info[]	List of the dynamic references in the data set.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

Starts iteration to list the dynamic references in the data set. Volumes are not considered dynamic references because they are members. (even though they can contain qtrees)

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of data set whose dynamic references will be listed.
dp-node-name		dp-policy-node-name optional	List only the members in this policy node. If none is specified, then list members in all policy nodes. If both dp-node-name and storageset-name-or-id are specified, then the value of dp-node-name is ignored.
include-deleted		boolean validate 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.
include-is-available		boolean optional	If true, the is-available status is calculated for each member which may make the call to this zapi take much longer. Default is false.
storageset-name-or-id		obj-name-or-id optional	List only the members in this storage set. If none is specified, then list members in all storagesets mapped to this data set's nodes. If both dp-node-name and storageset-name-or-id are specified, then the value of dp-node-name is ignored.
suppress-status-refresh		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.
Output Name	Range	Type	Description
records		integer	Number of items that have been saved for future retrieval with dataset-dynamic-reference-list-info-iter-next.
tag		string	Tag to be used in subsequent calls to dataset-dynamic-reference-list-info-iter-next.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
ESTORAGESETNOTINDATASET
EDPPOLICYNODENOTFOUND

Obtain an edit lock to start modifying a data set. Besides locking the data set itself, all storage sets in the data set are locked, as well as the data protection policy if one is assigned. An edit lock must be obtained before invoking the following ZAPIs: dataset-add-member dataset-delete-member dataset-add-member-by-dynamic-reference dataset-remove-member-by-dynamic-reference dataset-add-storageset dataset-delete-storageset dataset-modify dataset-modify-node dataset-add-resourcepool dataset-remove-resourcepool dataset-provision-member dataset-resize-member dataset-member-delete-snapshots Use dataset-edit-commit to commit the changes to the database. Use dataset-edit-rollback to undo the changes made to the data set. 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	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the data set to edit.
force		boolean optional	By default, force is false. If true, and an edit is already in progress on the specified data set or an object the data set is dependent on (such as a data protection policy), the previous edit session is rolled back and a new edit session is begun.
Output Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock on the data set. Range: [1..2^31-1]

Errno	Description
EDATASETFAILINGOVER
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONINPROGRESS

Commit changes made to a data set into the database. The edit lock on the data set will be released after the changes have been successfully committed. Use the dry-run 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. If dry-run is false, then before the call returns, the system begins a conformance run on the data set. (See dataset-conform-begin 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 assume-confirmation. The default value for assume-confirmation is initially true when the edit session begins, but may be altered by certain changes to the dataset made through the use of dataset-modify. The optional assume-confirmation option may be used to to specify if user confirmation is to be assumed or not for this dataset-edit-commit. One key and sometimes undesireable resolvable action that requires user confirmation is the possible re-baseline of a relationship.

Input Name	Range	Type	Description
assume-confirmation		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 dataset-modify. One key and sometimes undesireable resolvable action that requires user confirmation is the possible re-baseline of a relationship.
dry-run		boolean optional	If true, return a list of actions that would be taken should the changes be committed without actually committing the changes. The edit lock is not released after a dry run. By default, dry-run is false.
edit-lock-id		integer	Identifier of the edit lock on the data set. Range: [1..2^31-1]
Output Name	Range	Type	Description
dry-run-results		dry-run-result[] 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 dry-run is true.
is-provisioning-failure		boolean optional	This element is returned only if dry-run 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 data set conformance related errors.
job-ids		job-info[] optional	Job identifiers of provisioning requests. This output element is present only if there were any provisioning requests issued in the edit session. This is returned only if dry-run is false.

Errno	Description
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONNOTFOUND
EDATASETFAILINGOVER
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE

Roll back changes made to a data set. The edit lock on the data set will be released after the rollback.

Input Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock on the data set. Range: [1..2^31-1]

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EDATABASEERROR

Ends iteration to list data sets.

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

Errno	Description
EINVALIDTAG

Get next few records in the iteration started by dataset-list-info-iter-start. If a data set has a data protection policy assigned to it, the is-protected field will be true. If the client has suspended the data set, is-protected is still true, but is-dp-suspended and is-suspended fields are also set to true to reflect this. When the client sets is-dp-ignored to true, nothing changes, except that, when the client requests the list of data sets which are not ignored, the ignored data sets will not be returned.

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

Errno	Description
EINVALIDTAG

Starts iteration to list data sets.

Input Name	Range	Type	Description
application-name		string optional	Return only application data sets managed by a particular type of application. Up to 255 characters long.
application-server-name		string optional	Return only application data sets managed by an application running on a particular server. Up to 255 characters long.
dr-state		dr-state optional	Filter by dr-state value. If no dr-state input is supplied, all data sets will be listed.
include-conformance-check-results		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.
include-export-settings		boolean optional	If true, the export settings for the data set nodes will be present in the output of dataset-list-info-iter-next. Default value is false.
include-metadata		boolean optional	If true, returns data set's metadata. If false, metadata, which can be large in size, is not returned. Default is false.
is-application-data		boolean optional	If true, return only data sets managed by an application. If false, return only data sets which are not managed by an application. By default, return all data sets.
is-dp-ignored		boolean optional	If true, only list data sets that have been set to be ignored for purposes of data protection. If false, only list data sets that have been not set to be ignored for purposes of data protection. If not specified, list all data sets without taking into account whether they have been ignored or not.
is-dr-capable		boolean optional	If true, return only data sets with dp policies that are disaster recovery capable. If false, return only data sets with policies that are not disaster recovery capable. By default, return all data sets.
is-protected		boolean optional	If true, only list data sets which have a data protection policy assigned to them.
object-name-or-id		obj-name-or-id optional	Name or identifier of a data set or resource group or provisioning policy. If a resource group is given, only the data sets which are direct members of the group are returned. If a provisioning policy is given, only those data sets where one or more of its nodes is associated with the provisioning policy are returned.
requires-non-disruptive-restore		requires-non-disruptive-restore optional	If true, return only data sets requiring non-disruptive restore. If false, return only data sets which do not require non-disruptive restore. By default, return all data sets.
suppress-status-refresh		boolean optional	If true, do not refresh the data set status. If false or omitted, the status of all queried data sets will be re-calculated before being returned.
Output Name	Range	Type	Description
records		integer	Number of records that have been saved for future retrieval with dataset-list-info-iter-next.
tag		string	Tag to be used in subsequent calls to dataset-list-info-iter-next.

Errno	Description
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR

Delete Snapshot copies of a volume which is a member of the effective primary node of the data set. The effective primary node for a non disaster recovery capable data set or a disaster recovery capable data set not in the DR state of "failed_over" is the root node of the data set. The effective primary of a disaster recovery data set in the DR state of "failed_over" is the disaster recovery capable node of the data set. The deletion of Snapshot copies happens in the background. A provisioning job id is returned in dataset-edit-commit zapi that represents the job which will delete the specified Snapshot copies. The status of the job can be checked using dp-job-list-iter ZAPIs with the given job-id. 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 data set. 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 volume-id and volume-name 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 data set is not in a stable disaster recovery state.

Input Name	Range	Type	Description
delete-snapshots-request-info		delete-snapshots-request-info	Details on the volume and Snapshot copies to be deleted.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]

Errno	Description
EACCESSDENIED
EDATABASEERROR
EOBJECTNOTFOUND
ENOTINDATASET
EOBJECTAMBIGUOUS
EINVALIDINPUT
EEDITSESSIONNOTFOUND
EEDITSESSIONOBJECTALREADYLOCKED
EEDITSESSIONCONFLICTINGOP
EDATASETNOTINSTABLEDRSTATE

Ends iteration of data set members.

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

Errno	Description
EINVALIDTAG

Get next records in the iteration started by dataset-member-list-info-iter-start

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve.
tag		string	Tag from a previous dataset-member-list-info-iter-start.
Output Name	Range	Type	Description
dataset-members		dataset-member-info[]	List of the members of the data set.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

Starts iteration to list members of the data set. Dynamic references are not returned by this API, nor are objects only associated with the data set by their inclusion in a dynamic reference.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the data set whose members will be listed.
dp-node-name		dp-policy-node-name optional	List only the members in this policy node. If none is specified, then list members in all policy nodes. If both dp-node-name and storageset-name-or-id are specified, then the value of dp-node-name is ignored.
include-deleted		boolean validate optional	If present and true, members which are marked as deleted in the database are also returned. Otherwise, deleted members are not returned.
include-exports-info		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 nfs-export-name element in dataset-member-info. If the member is exported over CIFS, the share names are returned in cifs-share-names array in dataset-member-info. 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.
include-indirect		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 data set.
include-is-available		boolean optional	If true, the is-available status is calculated for each member which may make the call to this zapi take much longer. Default is false.
include-space-info		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.
member-id		obj-id optional	Id, in the DFM database, of a specific member of the data set. If specified, details of only this object will be returned.
storageset-name-or-id		obj-name-or-id optional	List only the members in this storage set. If none is specified, then list members in all storagesets mapped to this data set's nodes. If both dp-node-name and storageset-name-or-id are specified, then the value of dp-node-name is ignored.
suppress-status-refresh		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.
Output Name	Range	Type	Description
records		integer	Number of records that have been saved for future retieval with dataset-member-list-info-iter-next.
tag		string	Tag to be used in subsequent calls to dataset-member-list-info-iter-next.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
ESTORAGESETNOTINDATASET
EDPPOLICYNODENOTFOUND

Ends iteration of missing data set members.

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

Errno	Description
EINVALIDTAG

Get next records in the iteration started by dataset-member-list-info-iter-start

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve.
tag		string	Tag from a previous dataset-member-list-info-iter-start.
Output Name	Range	Type	Description
missing-members		missing-member-info[]	List of the missing members of the data set.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

Starts iteration to list members of the data set that have gone missing. The way the server determines if an object was not intentionally removed from the data set is: The object is still a data set member. The object's objDeleted flag is set.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the data set whose members will be listed.
Output Name	Range	Type	Description
records		integer	Number of records that have been saved for future retieval with dataset-member-list-info-iter-next.
tag		string	Tag to be used in subsequent calls to dataset-member-list-info-iter-next.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED

Modify attributes for a data set.

Input Name	Range	Type	Description
application-info		application-info optional	This input is used only if is-application-data is true. It contains information about the application which manages this data set.
check-protection-policy-on-commit		boolean optional	In the default case for a protection policy change, we immediately check the data set'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.
dataset-contact		email-address-list optional	Contact for the data set, such as the owner's e-mail address.
dataset-description		string optional	Description of the data set, up to 255 character long.
dataset-metadata		dfm-metadata-field[] optional	Opaque metadata for data set. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
dataset-name		obj-name optional	Name of the data set.
dataset-owner		string optional	Name of the owner of the data set, up to 255 characters long.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]
is-application-data		boolean optional	If true, the data set is an application data set managed by an external application. Because backups must be coordinated between the application and DFM, transfers move backups between nodes instead of creating new backups. Policies for which this behavior is not supported may not be assigned to application data sets. Conversion of a non-application data set to an application data set is not allowed. The default value is false.
is-dp-ignored		boolean optional	True if an administrator has chosen to ignore this data set for purposes of data protection. Data sets with this attribute set to true are not returned when the client requests data sets which are not ignored. This attribute has no other significance to the system.
is-dp-suspended		boolean optional	Flag indicating whether or not the data set should be protected. This also indicates whether conformance checking of the data set is to be done or not. Default is False. Should is-dp-suspended go from TRUE to FALSE the edit session assume-confirmation default setting will be be set to FALSE for this dataset. (See dataset-edit-commit for details) Deprecated field. Retained for backward compatibility. This field is deprecated in favour of is-suspended, which suspends the data set for all automated actions (data protection and conformance check of the data set).
is-suspended		boolean optional	True if an administrator has chosen to suspend this data set for all automated actions (data protection and conformance check of the data set). Default is False. If present, this field takes precedence over is-dp-suspended. Should is-suspended go from TRUE to FALSE the edit session assume-confirmation default setting will be be set to FALSE for this dataset. (See dataset-edit-commit for details)
protection-policy-id		obj-id optional	Identifier of the protection policy to associate with this data set. This legacy parameter is only used if protection-policy-name-or-id is not supplied. The dataprotection license is required for this input.
protection-policy-name-or-id		obj-name-or-id optional	Name or identifier of the protection policy to associate with this data set. This input is preferred over protection-policy-id and if supplied then do not supply protection-policy-id because protection-policy-id will be ignored. The dataprotection license is required for this input.
requires-non-disruptive-restore		boolean optional	Specifies whether the dataset requires a non disruptive restore of LUNs. Default value is false.

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EDATASETEXISTS
EEDITSESSIONNOTFOUND
EEDITSESSIONOBJECTALREADYLOCKED
EEDITSESSIONCONFLICTINGOP
EDATABASEERROR
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTNDRESTORE
ENOTLICENSED

Modify attributes of a single storage set that is part of a data set. 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 dataset-modify-node, you may also add or remove members or dynamic references, or change the data set's name, description, is-dp-ignored, is-dp-suspended, or is-suspended. 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 data set 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 data set. 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 data set. EDSCONFLICTOSSVNOTALLOWED - OSSV is not allowed in the data set. 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 data set. EDSCONFLICTNOTROOTNODE - Operation cannot be performed on non-root node of data set. EDSCONFLICTNOTLEAFNODE - Operation cannot be performed on non-leaf node of data set. EDSCONFLICTINVALIDVFILER - Data set node has members that do not belong to the vFiler being attached.

Input Name	Range	Type	Description
dataset-export-info		dataset-export-info optional	Specifies the NAS or SAN export settings for members provisioned in this node of the data set.
dp-node-name		dp-policy-node-name optional	Name of the node in the data protection policy that maps to the storage set. dp-node-name must match exactly the name of one of the nodes in the data protection policy that is currently assigned to the data set. If dp-node-name is not specified, then the storage set associated with the root node is modified.
edit-lock-id		integer validate	Identifier of the edit lock for a data set that was obtained by an earlier call to dataset-edit-begin.
provisioning-policy-name-or-id		obj-name-or-id 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.
resourcepool-name-or-id		obj-name-or-id 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. dataset-add-resourcepool and dataset-remove-resourcepool are preferred APIs for adding and removing resource pools to/from data set nodes.
timezone-name		string optional	Timezone to assign to the storage set. The value must be either a timezone-name returned by timezone-list-info-iter-next, 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.
vfiler-name-or-id		obj-name-or-id 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.

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
ESTORAGESETNOTINDATASET
EDPPOLICYNODENOTFOUND
ENODENOTDRCAPABLE
EINVALIDINPUT
EEDITSESSIONCONFLICTINGOP
EINVALIDTIMEZONE
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTINVALIDVFILER

Provision a new member into the effective primary node of a data set. The effective primary node for a non disaster recovery capable data set or a disaster recovery capable data set not in the DR state of "failed_over" is the data set root node. The effective primary node of a disaster recovery data set in the DR state of "failed_over" is the disaster recovery capable node of the data set. 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 data set is not in a stable disaster recovery state.

Input Name	Range	Type	Description
edit-lock-id		integer validate	Identifier of the edit lock for a data set that was obtained by an earlier call to dataset-edit-begin. Range: [1..2^31-1]
provision-member-request-info		provision-member-request-info	Information of the provisioning request.

Errno	Description
EINVALIDINPUT
EEDITSESSIONNOTFOUND
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONCONFLICTINGOP
EDATASETNOTINSTABLEDRSTATE
ESTORAGESETNOTINDATASET

Remove member from a data set. Only members explicitly added to the data set (direct members) can be removed. If "destroy" is true, even indirect members can be destroyed on the storage system and removed from the data set. If "destroy" is true, then it is applicable only on members of the effective primary node of the data set. The effective primary node for a non disaster recovery capable data set or a disaster recovery capable data set not in the DR state of "failed_over" is the data set root node. The effective primary node of a disaster recovery data set in the DR state of "failed_over" is the disaster recovery capable node of the data set. The destroy operation happens in the background. A provisioning job id is returned in dataset-edit-commit api that represents the job which will resize the member as specified. The status of the job can be checked using dp-job-list-iter ZAPIs with the given job-id.

Input Name	Range	Type	Description
dataset-member-parameters		dataset-member-parameter[]	List of members to remove from the data set.
destroy		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 data set.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]

Errno	Description
EEDITSESSIONCONFLICTINGOP
EEDITSESSIONNOTFOUND
ENOTINDATASET
EDPPOLICYNODENOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EINVALIDOBJECTTYPE
ECANNOTDESTROYSTORAGE

Remove dynamic references from a data set. Only dynamic_references explicitly added to the data set can be removed.

Input Name	Range	Type	Description
dataset-dynamic-reference-parameters		dataset-dynamic-reference-parameter[]	List of dynamic-references to remove from the data set.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]

Errno	Description
EEDITSESSIONCONFLICTINGOP
EEDITSESSIONNOTFOUND
ENOTINDATASET
EDPPOLICYNODENOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED

Remove resource pool from a single storage set that is part of a data set. 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 dataset-remove-resourcepool, you may also add or remove members or dynamic references, or change the data set's name, description, is-dp-ignored, is-dp-suspended, or is-suspended. 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 data set 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 data set. EDSCONFLICTALREADYINRESPOOL - Object, its ancestor or descendent is already in resource pool.

Input Name	Range	Type	Description
dp-node-name		dp-policy-node-name optional	Name of the node in the data protection policy that maps to the storage set. dp-node-name must match exactly the name of one of the nodes in the data protection policy that is currently assigned to the data set. If dp-node-name is not specified, then the storage set associated with the root node is modified.
edit-lock-id		integer validate	Identifier of the edit lock for a data set that was obtained by an earlier call to dataset-edit-begin. Range: [1..2^31-1]
resourcepool-name-or-id		obj-name-or-id	Name or object identifier of a resource pool to remove from the storage set.

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
ESTORAGESETNOTINDATASET
EDPPOLICYNODENOTFOUND
EEDITSESSIONCONFLICTINGOP
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL

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 dry-run is specified, it returns the results of the operation that would be taken should the operation be committed.

Input Name	Range	Type	Description
cancel-edit-sessions		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 data set, EEDITSESSIONINPROGRESS is returned and no primary members will be replaced. By default, cancel-edit-sessions is false. If dry-run is true, canel-edit-sessions is ignored.
dataset-name-or-id		obj-name-or-id	Name or identifier of the data set whose primary members need to be replaced.
dry-run		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, dry-run is false.
object-name-or-id		obj-name-or-id optional	Name or identifier of the secondary volume or qtree whose primary needs to be replaced. If object-name-or-id is not specified, it replaces all primary members in the data set that need to be replaced.
Output Name	Range	Type	Description
replace-results		replace-result[] optional	Results of the replace operation. Each result describes one action that was taken. If dry-run is true, it describes one action that would be taken should the operation be committed.

Errno	Description
EOBJECTNOTFOUND
EDATASETFAILINGOVER
EEDITSESSIONINPROGRESS
EACCESSDENIED
EOBJECTAMBIGUOUS
EDATABASEERROR
EDATASETNOTDRCAPABLE
EDATASETNOTINFAILEDOVERSTATE

Resize, change maximum capacity and change snap reserve for a data set member on the effective primary node of the data set. The effective primary node for a non disaster recovery capable data set or a disaster recovery capable data set not in the DR state of "failed_over" is the data set 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 data set. The resize operation happens in the background. A provisioning job id is returned in dataset-edit-commit zapi that represents the job which will resize the member as specified. The status of the job can be checked using dp-job-list-iter ZAPIs with the given job-id. 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 data set. EOBJECTAMBIGUOUS - The specified member name could refer to two or more objects. Try again with the object identifier or object full name. EINVALIDINPUT - Both member-id and member-name are not specified, inputs other than new-size 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 data set is not in a stable disaster recovery state.

Input Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]
resize-member-request-info		resize-member-request-info	Details on member to be resized.

Errno	Description
EACCESSDENIED
EDATABASEERROR
EOBJECTNOTFOUND
ENOTINDATASET
EOBJECTAMBIGUOUS
EINVALIDINPUT
EEDITSESSIONNOTFOUND
EEDITSESSIONOBJECTALREADYLOCKED
EEDITSESSIONCONFLICTINGOP
EDATASETNOTINSTABLEDRSTATE

Set data set options.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or object identifier for the data set whose options need to be set.
is-allow-custom-settings		boolean optional	If true, conformance check of some volume options is disabled for the data set. These volume options include, fractional-reserve, autodelete commitment and autodelete trigger attributes only. This option is applicable only for data sets which have san thin provisioning policy associated. For other data sets the option is ignored. default value is false.
is-enable-write-guarantee-checks		boolean optional	If true, periodic write guarantee checks are enabled for the dataset. This option is applicable only for data sets 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 data sets the option is ignored. default value is true.
maximum-luns-per-volume		integer optional	Maximum luns to be provisioned from a volume in this data set. If the value is empty, then the data set level value of the global option maxLUNsPerVolume is applicable for the data set.
maximum-qtrees-per-volume		integer optional	Maximum qtrees to be provisioned from a volume in this data set. If the value is empty, then the data set level value of the global option maxQtreesPerVolume is applicable for the data set.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR

Change the storage sets associated with policy nodes. It is legal to change many storage set/node mappings in an edit session.

Input Name	Range	Type	Description
dp-node-name		dp-policy-node-name 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 dp-node-name is the root node, data set must have a disaster recovery capable protection policy data set must be in a "failed_over" DR state object-name-or-id 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.
edit-lock-id		integer	Identifier of the edit lock for a data set obtained by calling dataset-edit-begin. Range: [1..2^31-1]
object-name-or-id		obj-name-or-id	Name or identifier of the storage set to add.

Errno	Description
EOBJECTNOTFOUND
EEDITSESSIONOBJECTALREADYLOCKED
EEDITSESSIONNOTFOUND
EEDITSESSIONCONFLICTINGOP
EDPPOLICYNODENOTFOUND
EACCESSDENIED
EDSCONFLICTALREADYINDATASET
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE

Update disaster recovery status for a data set.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or object identifier for the data set.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR

Update protection status for a data set.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or object identifier for the data set.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR

Information about an application.

Name	Range	Type	Description
application-name		string	Name of an application, up to 255 characters long. For example: "SnapManager for Oracle"
application-server-name		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.
application-version		string	Version of an application, up to 255 characters long. For example: "2.1"
is-application-responsible-for-primary-backup		boolean	DFM creates primary backup versions only if this option is false.

Information about one dynamic reference in a data set.

Name	Range	Type	Description
dp-node-name		dp-policy-node-name 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 data set.
dynamic-reference-id		obj-id	Identifier of the dynamic reference.
dynamic-reference-name		obj-name	Name of the dynamic reference.
dynamic-reference-status		obj-status	Current status of the dynamic reference.
dynamic-reference-type		string	Type of the dynamic reference. Possible values are 'filer', 'vfiler', 'aggregate' or 'ossv_host'.
is-available		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".
storageset-id		obj-id	Identifier of the storage set to which the dynamic reference belongs.
storageset-name		obj-name	Name of the storage set to which the dynamic reference belongs.

Information about one dynamic reference in a data set.

Name	Range	Type	Description
dp-node-name		dp-policy-node-name optional	Name of the data protection policy node associated with the dynamic reference. If dp-node-name is not specified, the root data protection policy node is assumed.
object-name-or-id		obj-name-or-id	Name or identifier of the dynamic reference to add to or remove from the data set.

Specifies the NAS or SAN export settings for a data set node.

Name	Range	Type	Description
dataset-cifs-export-setting		dataset-cifs-export-setting optional	The CIFS export settings for storage exported over CIFS. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.
dataset-export-protocol		dataset-export-protocol optional	Specifies the protocol over which members of the data set 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 dataset-nfs-export-setting and dataset-cifs-share-permissions, should be specified in a modify operation, and will be returned in the iterator output.
dataset-lun-mapping-info		dataset-lun-mapping-info optional	Specifies the hosts and/or initiators to which LUNs in this data set node will be mapped, and the igroup OS type. This field may be present only if the dataset-export-protocol is 'fcp' or 'iscsi'.
dataset-nfs-export-setting		dataset-nfs-export-setting optional	The NFS export settings for storage exported over NFS. This field may be present only if the dataset-export-protocol is 'nfs' or 'mixed'.

Information about a data set.

Name	Range	Type	Description
application-info		application-info optional	If is-application-data is true, then this element must be present and it will contain information about the application which manages this data set.
dataset-contact		email-address-list optional	Contact information for the data set, such as the owner's e-mail address.
dataset-description		string	Description of the data set, up to 255 characters long.
dataset-export-info		dataset-export-info optional	Specifies the NAS or SAN export settings for the root node of the data set. This field is present only if the include-export-settings field was set to true in dataset-list-info-iter-start for this iteration.
dataset-id		obj-id	Identifier of data set.
dataset-map		dataset-map-entry[] 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 data set.
dataset-metadata		dfm-metadata-field[] optional	Opaque metadata for data set. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
dataset-name		obj-name	Name of data set.
dataset-owner		string optional	Name of the owner of the data set, up to 255 characters long.
dataset-status		dataset-status	The complex status of the data set 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 dataset-status that is ever refreshed when iterated.
dr-state		dr-state optional	Disaster recovery state of the data set. If the data set list iteration's output element is-dr-capable is true, then this element appears in the output. Otherwise, if is-dr-capable is false, this element does not appear in the output.
dynamic-reference-count		integer	The count of dynamic references to members in the data set. Range: [0..2^31-1]
is-allow-custom-settings		boolean optional	If true, conformance check of some volume options is disabled for the data set. These volume options include, fractional-reserve, autodelete commitment and autodelete trigger attributes only. This option is applicable only for data sets which have san thin provisioning policy associated. For other data sets the option is ignored. default value is false.
is-application-data		boolean	If true, the data set is an application data set managed by an external application. Because backups must be coordinated between the application and DFM, transfers move backups between nodes instead of creating new backups. Policies for which this behavior is not supported may not be assigned to application data sets.
is-dp-ignored		boolean	True if an administrator has chosen to ignore this data set for purposes of data protection. Data sets with this attribute set to true are not returned when the client requests data sets which are not ignored. This attribute has no other significance to the system.
is-dp-suspended		boolean	True if an administrator has chosen to suspend data protection of this data set. Deprecated field. Retained for backward compatibility. This field is deprecated in favour of is-suspended, which suspends the data set for all automated actions (data protection and conformance check of the data set).
is-dr-capable		boolean	True if this data set has a data protection policy associated with it that is disaster recovery capable.
is-enable-write-guarantee-checks		boolean optional	If true, periodic write guarantee checks are enabled for the dataset. This option is applicable only for data sets 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 data sets the option is ignored. default value is true.
is-protected		boolean	True if this data set has a data protection policy associated with it
is-suspended		boolean	True if an administrator has chosen to suspend this data set for all automated actions (data protection and conformance check of the data set).
maximum-luns-per-volume		integer optional	Data set 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 data set.
maximum-qtrees-per-volume		integer optional	Data set 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 data set.
member-count		integer	The count of direct members in the data set. Range: [0..2^31-1]
protection-policy-id		obj-id optional	Identifier of the protection policy governing this data set.
protection-policy-name		obj-name optional	Name of the protection policy governing this data set.
provisioning-policy-id		obj-id optional	Identifier of the provisioning policy associated with primary node of the data set.
provisioning-policy-name		obj-name optional	Name of the provisioning policy associated with the primary node of the data set.
requires-non-disruptive-restore		requires-non-disruptive-restore	Specifies whether the data set is configured to enable non-disruptive restores.
resourcepool-id		obj-id 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 data set 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 data set node.
resourcepool-name		obj-name 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 data set 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 data set node.
resourcepools		dataset-resourcepool-info[] 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.
storageset-id		obj-id	Identifier of the storage set representing the primary data, or "root," of the data set.
storageset-name		obj-name	Name of the storage set representing the primary data, or "root," of the data set.
storageset-timezone		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 timezone-list-info-iter.
vfiler-id		obj-id optional	Identifier of the vFiler unit attached to the primary node of the data set.
vfiler-name		obj-full-name optional	Name of the vFiler unit attached to the primary node of the data set.

Information about one member of a data set.

Name	Range	Type	Description
cifs-share-names		cifs-share-name[] optional	List of share names for accesing the storage container (volume/qtree) when access protocol of storage set is "CIFS" or "Mixed".
dp-node-name		dp-policy-node-name 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 data set.
is-available		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".
lun-igroups-info		lun-igroup-info[] 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.
member-id		obj-id	Identifier of the member.
member-name		obj-name	Display name of the member.
member-perf-status		obj-status	Current status of the member based on the worst performance event.
member-status		obj-status	Current status of the member.
member-type		string	Type of the member. Possible values for direct members are: "volume", "qtree" or "ossv_directory". When include-exports-info is true in dataset-member-list-info-iter-start, this can also be "lun_path".
nfs-export-name		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. Example: "/vol/myvol/myqtree" can be exported as "myexport") if not this will be same as full path of the container.
space-info		space-info optional	Space related information of a data set member. Included in the output only if include-space-info was true in the call to dataset-member-list-info-iter-start. 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.
storageset-id		obj-id	Identifier of the storage set to which the member belongs.
storageset-name		obj-name	Name of the storage set to which the member belongs.

Information about one member of a data set.

Name	Range	Type	Description
dp-node-name		dp-policy-node-name optional	Name of the data protection policy node associated with the object. If dp-node-name is not specified, the object is added to the root data protection policy node.
object-name-or-id		obj-name-or-id	Identifier of the object to add to or remove from the data set.

Details on which Snapshot copies are to be deleted.

Name	Range	Type	Description
snapshots		snapshot[]	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.
volume-id		obj-id 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 data set either through direct or indirect membership.
volume-name		obj-name 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 data set either through direct or indirect membership. Either volume-id or volume-name has to be specified. If volume-id is specified then volume-name is ignored.

Named field in the metadata.

Name	Range	Type	Description
field-name		string	Name of the metadata field. Field names are up to 255 characters in length and are case- insensitive.
field-value		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.

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

[none]

Disaster recovery states of a data set. Possible values are: "ready": The data set is prepared to fail over. "failing_over": The data set is in the process of failing over. Eventually, the state of the data set will change to either "failed_over" or "failover_error". "failed_over": The data set 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 data set attempted to fail over but encountered an error. User intervention is required to change the state to either "failed_over" or "ready".

[none]

A description of one action and the predicted effects of taking that action.

Name	Range	Type	Description
dry-run-action		string	An action the system would take.
dry-run-effect		string	The predicted effect of the action.
dry-run-reason		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.
dry-run-severity		obj-status	severity of the dry-run result. Possible values are "information", "error" or "warning".
dry-run-suggestion		string	Present only if severity is error or warning. Specifies any suggestions to rectify warnings,errors. If there are no suggestions to specify, this element will not be present.

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]

Job information of provisioning request.

Name	Range	Type	Description
job-id		integer	Identifier of job started for the provisioning request.

Information about one missing member of a data set.

Name	Range	Type	Description
aggregate-id		obj-id	Identifier of the aggregate to which the member belongs.
aggregate-name		obj-name	Name of the aggregate to which the member belongs.
cifs-share-names		cifs-share-name[] 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.
deleted-timestamp		dp-timestamp	The time and date when the object was deleted.
host-id		obj-id	Identifier of the host to which the member belongs.
hostname		obj-name	Name of the host to which the member belongs.
member-id		obj-id	Identifier of the missing member.
member-name		obj-name	Display name of the missing member.
member-type		string	Type of the missing member. Possible values are 'volume', 'qtree'.
nfs-export-name		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.
quota-hard-limit		integer optional	The hard limit on the amount of space a user can use in kilobytes. Range: [1..2^44-1] Valid only for qtree members.
quota-soft-limit		integer optional	The soft limit on the amount of space a user can use in kilobytes. Range: [1..2^44-1] Valid only for qtree members.
space-guarantee		string optional	The space guarantee setting for a volume member. Possible values are "none," "file," or "volume." Valid only for volume members.
total-space		integer optional	Specifies the total capacity of the data set member, in kilobytes. Range: [1..2^44-1] Valid only for volume members.