Input Name	Range	Type	Description
dataset-member-parameters		dataset-member-parameter[]	List of members to add to the dataset.
edit-lock-id		integer	Identifier of the edit lock for a dataset 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
EDSCONFLICTSRCDESTINSAMEAGGR
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTWITHANOTHERDATASET
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTMEMBERVFILERMISMATCH
EINVALIDOBJECTTYPE

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, OSSV hosts, virtualization objects can be attached to a primary 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 dataset.
edit-lock-id		integer	Identifier of the edit lock for a dataset obtained by calling dataset-edit-begin. Range: [1..2^31-1]

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

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 dataset-add-resourcepool, you may also add or remove members or dynamic references, or change the dataset'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 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	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 dataset 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
EDSCONFLICTSRCDESTINSAMEAGGR
EDSCONFLICTALREADYINRESPOOL
ESERVICEISATTACHED

Add datastore objects to a dataset's exclusion list. This API is for adding datastore objects to a dataset's exclusion list. Users may want to exclude a datastore when adding a virtual machine to the dataset. Virtual Machine may be on multiple datastores and one of the datastores will contain swap files which don't need to be backed up. If a datastore is excluded, relationships and backups for that datastore will not be created. If a relationship already exists, it will be left alone and only the backups will stop. There is no impact on suspend/resume.

Input Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock for a dataset obtained by calling dataset-edit-begin. Range: [1..2^31-1]
is-excluded-member-ok		boolean optional	If specified, the call will not return an error if one or more objects being added is already on the exclusion list. By default, is-excluded-member-ok is false.
objects-to-be-added		obj-name-or-id[]	List of datastore object names or IDs to be added to the exclusion list.

Errno	Description
EAPIAUTHENTICATION
EEDITSESSIONNOTFOUND
EOBJECTAMBIGUOUS
ENOTINDATASET
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EDSCONFLICTALREADYEXCLUDED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EINVALIDOBJECTTYPE

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: The DR state of the dataset will immediately change to "failing_over". Any pending conformance tasks will be cancelled. Any jobs running against this dataset 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 dataset 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 dataset.
Output Name	Range	Type	Description
job-id		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]

Errno	Description
EDATASETWRONGDRSTATE
EDATASETDRSTATEUNCHANGED
EDATASETFAILOVERNOTREADY
EINVALIDINPUT
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR

Begin test failover of a dataset 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 dataset.
Output Name	Range	Type	Description
job-id		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]

Errno	Description
EDATASETWRONGDRSTATE
EDATASETFAILOVERNOTREADY
EINVALIDINPUT
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR

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 "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 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 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 dataset.
dr-state		dr-state	Desired DR state of dataset.

Errno	Description
EACCESSDENIED
EAPIAUTHENTICATION
EAPIERROR
EDATABASEERROR
EDATASETWRONGDRSTATE
EINTERNALERROR
EINVALIDINPUT
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND

This API computes space and/or IO usage metrics for a dataset. dataset-space-metric-list-info-iter-* set of APIs can be used to retrieve the computed space metrics and dataset-io-metric-list-info-iter-* set of APIs can be used to retrieve the computed IO metrics.

Input Name	Range	Type	Description
compute-io-usage-metric		boolean optional	If true, IO usage metric for the dataset will be computed. If not specified in input, it defaults to false.
compute-space-usage-metric		boolean optional	If true, space usage metric for the dataset will be computed. If not specified in input, it defaults to false.
dataset-name-or-id		obj-name-or-id	Name or identifier of a dataset for which the usage metric has to be computed.
timestamp		dp-timestamp	Time upto which usage metrics for the dataset needs to be computed. The timestamp value should not be in future. Range: [1..2^31-1]

Errno	Description
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR
EINVALIDINPUT

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	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 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.
dataset-name-or-id		obj-name-or-id	Name or object ID for the dataset.

Errno	Description
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR
EDATASETMIGRATING

Create a new, empty dataset.

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 dataset.
application-policy-name-or-id		obj-name-or-id optional	Name or identifier of the application policy to associate with this dataset. An application policy can only be attached to an empty dataset or a dataset containing only virtualization objects. Once an application policy is attached to a dataset, user can no longer assign volumes or qtrees to the root node of that dataset. Depending on the application policy type, 'vmware' or 'hyperv', only virtualization objects of that type can be added to the dataset. Vmware objects and Hyper-V objects can not be mixed in a single dataset.
dataset-access-details		dataset-access-details 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 value will be ignored if application-policy-name-or-id is specified.
dataset-contact		email-address-list optional	Contact for the dataset, such as the owner's e-mail address.
dataset-description		string optional	Description of the new dataset, up to 255 characters long.
dataset-metadata		dfm-metadata-field[] 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.
dataset-name		obj-name	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.
dataset-owner		string optional	Name of the owner of the dataset, up to 255 characters long.
group-name-or-id		obj-name-or-id 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.
is-application-data		boolean optional	If true, the dataset is an application dataset managed by an external application. The default value is false.
is-dp-suspended		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 is-suspended, which suspends the dataset for all automated actions (data protection and conformance check of the dataset).
is-suspended		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 is-dp-suspended.
online-migration		boolean optional	Indicates, that the dataset will be capable of non-disruptive migration. By default the migration will be disruptive. Default: false.
primary-volume-name-format		primary-volume-name-format optional	Name format string for the primary volumes created by Provisioning Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for the primary volumes. Volume name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the volume name. Volume name can have ASCII alphabets, ASCII numbers and underscore '_'. Volume name cannot start with a number. All other characters will be converted to character 'x'. By default, the value of the option would be empty string.
protection-policy-id		obj-id optional	Identifier of the protection policy to associate with this dataset. 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 dataset. 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 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.
requires-non-disruptive-restore		requires-non-disruptive-restore optional	Specifies whether the dataset should be configured to enable non-disruptive restores from backup destinations. This value will be ignored if application-policy-name-or-id is specified. Non-disruptive-restore is not supported for datasets containing virtualization objects (virtual machines and datastores). Default value is false.
secondary-qtree-name-format		secondary-qtree-name-format optional	Name format for the secondary qtrees created by Protection Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for qtrees Qtree name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the qtree name. Qtree name can have ASCII alphabets, ASCII numbers, hypen '-', dot '.' and underscore '_'. All other characters will be converted to character 'x'. By default, the value of the option would be empty string. This option does not apply to names of primary qtrees..
secondary-volume-name-format		secondary-volume-name-format optional	Naming format string for the secondary volumes created by Protection Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for the secondary volumes. Volume name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the volume name. Volume name can have ASCII alphabets, ASCII numbers and underscore '_'. Volume name cannot start with a number. All other characters will be converted to character 'x'. By default, the value of the option would be empty string.
snapshot-name-format		snapshot-name-format optional	Name format string for snapshots created by Protection Manager and Host Service's plug-ins. This element is optional. If the value of this element is empty string "", then the global naming option will be used to created names for snapshot. If %A is not specified as one of the substitution tokens in the format, plug-ins creating snapshots for application datasets will implicitly add %A at the end of the format string and the snapshot name will have application fields in them. Snapshot name length can only be 124 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the snapshots. Snapshot name can have ASCII alphabets, ASCII numbers, underscore '_', hyphen '-', plus sign '+' and a dot '.'. All other characters will be converted to character 'x'. By default, the value of the option is an empty string.
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 dataset. If a vFiler unit is attached, then all members provisioned into this node will be exported over this vFiler unit. If an application policy is assigned to this dataset, this parameter will be ignored. This value will be ignored if application-policy-name-or-id is specified.
volume-qtree-name-prefix		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
Output Name	Range	Type	Description
dataset-id		obj-id	Identifier of the new dataset.

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

Destroy a dataset. The dataset 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 dataset should be cancelled. If true, any edit operations in progress on the dataset are rolled back before destroying the dataset. If cancel-edit-sessions is false, dataset with pending edit operations cannot be destroyed. Default is false.
dataset-name-or-id		obj-name-or-id	Name or identifier of the dataset to destroy.
force		boolean optional	If true, allows destroying a dataset that has members or dynamic references. By default, only empty datasets can be destroyed.

Errno	Description
EDATASETNOTEMPTY
EDATASETFAILINGOVER
EDATASETMIGRATING
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONINPROGRESS

Ends iteration of the dynamic references in the dataset.

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 dataset.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

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	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of dataset 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.
dynamic-reference-type		string optional	Type of dynamic reference. Possible values are 'filer', 'vfiler', 'aggregate', 'ossv_host' or 'app_object'. If present, only dynamic references of the specified type are returned.
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 dataset'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 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: dataset-add-member dataset-remove-member dataset-add-member-by-dynamic-reference dataset-remove-member-by-dynamic-reference dataset-set-storageset dataset-modify dataset-modify-node dataset-add-resourcepool dataset-remove-resourcepool dataset-provision-member dataset-resize-member dataset-member-delete-snapshots dataset-add-to-exclusion-list dataset-remove-from-exclusion-list Use dataset-edit-commit to commit the changes to the database. Use dataset-edit-rollback 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	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the dataset to edit.
force		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.
Output Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock on the dataset. Range: [1..2^31-1]

Errno	Description
EDATASETFAILINGOVER
EDATASETMIGRATING
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EDATABASEERROR
EEDITSESSIONINPROGRESS

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 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. The dry-run 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 dry-run is false, then before the call returns, the system begins a conformance run on the dataset. (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 specify if user confirmation is to be assumed or not for this dataset-edit-commit. One key, and sometimes undesirable, 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 undesirable, resolvable action that requires user confirmation is the possible re-baseline of a relationship.
dry-run		boolean optional	If true, return the dry-run-results list as well as the conformance-alerts list. The dry-run-results list contains actions that would be taken should the changes be committed without actually committing the changes. The conformance-alerts 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, dry-run is false.
edit-lock-id		integer	Identifier of the edit lock on the dataset. Range: [1..2^31-1]
include-dry-run-reason-details		boolean optional	If true or omitted, then include any possible dry-run-reason-details along with the associated dry-run-result element. Default value is true. If false, the dry-run-reason-details will not be returned.
Output Name	Range	Type	Description
conformance-alerts		conformance-alert[] 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 dry-run is true.
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 dataset conformance related errors.
job-ids		job-info[] 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 dry-run is false.

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

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

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

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EDATABASEERROR

Ends iteration of dataset exclusion list.

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

Errno	Description
EINVALIDTAG

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

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous dataset-exclusion-list-info-iter-start.
Output Name	Range	Type	Description
exclusion-list		excluded-object-info[]	List of the objects in the dataset to exclude from being backed up.
records		integer	The number of records actually returned. Range: [1..2^31-1]

Errno	Description
EINVALIDTAG

Starts iteration to retrieve the backup exclusion list of the dataset.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the dataset whose members will be listed.
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.
object-name-or-id		obj-name-or-id optional	Name or id in the DFM database, of a specific member of the dataset's exclusion list. If specified, details of only this object will be returned.
Output Name	Range	Type	Description
records		integer	Number of records that have been saved for future retieval with dataset-exclusion-list-info-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dataset-exclusion-list-info-iter-next.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR
EINVALIDINPUT

Ends iteration to list dataset I/O usage metric.

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

Errno	Description
EINVALIDTAG

Get next few records in the iteration started by dataset-io-metric-list-info-iter-start.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous dataset-io-metric-list-info-iter-start.
Output Name	Range	Type	Description
dataset-io-metrics		dataset-io-metric-info[]	List of I/O usage measurement information of datasets.
records		integer	The number of records actually returned. Range: [0..2^31-1]

Errno	Description
EINVALIDTAG

Starts iteration to list dataset's I/O usage measurements.

Input Name	Range	Type	Description
day		integer optional	The day for which the usage metric is required. The month element is required along with this input. When present, the usage metrics for the day is returned. Range: [1..31]
month		month optional	The month for which the usage metric is required. If month is not specified, it defaults to the current month. If month element is provided without the day element in input, then the usage metrics available for the month is returned. If month and year element is not provided in input, then the usage measurements for the current month is returned. The start of the current month is determined by the chargebackDayOfMonth global option. Range: [1..12]
object-name-or-id		obj-name-or-id optional	Name or identifier of a dataset or resource group or storage service. If a resource group is given, usage measurement of the datasets which are direct members of the group are returned. If a storage service is given, usage measurement of datasets associated with the storage service is returned. If input is not given, usage measurement of all the datasets is returned.
year		integer optional	The year for which the usage metric is required. If year element is not provided in input, then the current year is selected. Range: [1900..2^31-1]
Output Name	Range	Type	Description
records		integer	Number of records that have been saved for future retrieval with dataset-io-metric-list-info-iter-next. Range: [0..2^31-1]
tag		string	Tag to be used in subsequent calls to dataset-io-metric-list-info-iter-next.

Errno	Description
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR
EINVALIDINPUT

Ends iteration to list datasets.

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 dataset has a data protection policy assigned to it, the has-protection-policy field will be true. If the client has suspended the dataset, has-protection-policy 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 datasets which are not ignored, the ignored datasets 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 datasets.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

Starts iteration to list datasets.

Input Name	Range	Type	Description
application-name		string optional	Return only application datasets managed by a particular type of application. Up to 255 characters long.
application-resource-namespace		application-resource-namespace optional	Namespace of the application resources in the dataset. If specified, then only datasets containing application resources, which belong to this namespace, are returned. Ignored, if include-can-contain-application-resources-only is false. If not specified, when include-can-contain-application-resources-only is true, then all datasets which can contain application resources, are returned.
application-server-name		string optional	Return only application datasets 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 datasets will be listed.
has-application-policy		boolean optional	If true, only list datasets which have an application policy assigned to them. If false, only list datasets which do not have any application policy assigned. If not set, list all datasets.
has-protection		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.
has-protection-policy		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.
include-can-contain-application-resources-only		boolean optional	If true, restricts returned datasets to only those to which application resources can be added. If false or not specified, this restriction is not applied. Default is false.
include-can-contain-storage-resources-only		boolean optional	If true, restricts returned datasets to only those to which storage resources can be added. If false or not specified, this restriction is not applied. Default is false.
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-conformance-run-reason-details		boolean optional	If true or omitted and include-conformance-check-results is also true, then include any possible conformance-run-reason-details along with the associated conformance-run-result element. Default value is true. If false, the conformance-run-reason-details, will not be returned.
include-export-settings		boolean optional	If true, the export settings for the dataset nodes will be present in the output of dataset-list-info-iter-next. Default value is false.
include-metadata		boolean optional	If true, returns dataset's metadata. If false, metadata, which can be large in size, is not returned. Default is false.
include-migration-info		boolean optional	If true, the migration information for the dataset is returned in dataset-list-info-iter-next. Default is false.
include-protection-status-problems		boolean optional	If true, return the detailed protection-status-problems if the dataset does not have protection status as "protected". Setting include-protection-status-problems to true will generate an error unless only one dataset is specified from the other input parameters. If false or omitted, protection-status-problems, which can be expensive to retrieve, will not be returned.
is-application-data		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.
is-dp-ignored		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.
is-dr-capable		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.
is-protected		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 has-protection-policy.
object-name-or-id		obj-name-or-id 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.
requires-non-disruptive-restore		requires-non-disruptive-restore 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.
suppress-status-refresh		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.
volume-qtree-name-prefix		string optional	Return only datasets with a particular type of custom name prefix. Up to 60 characters long.
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

Abort in-progress dedupe operation on the given volume member of the dataset.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of dataset.
volume-name-or-id		obj-name-or-id	Name or identifier of a volume member of the dataset.
Output Name	Range	Type	Description
job-id		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]

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EINVALIDINPUT
EINTERNALERROR
EDATABASEERROR
EDEDUPEABORTNOTSUPPORTED
EJOBALREADYCOMPLETED
EJOBALREADYABORTED
EDEDUPENOTRUNNING
EDEDUPEABORTNOTSUPPORTED

Start deduplication operation on specified volume member of the given dataset.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or Identifier of the dataset.
dedupe-member-request-info		dedupe-member-request-info	Details on member to be deduplicated.
Output Name	Range	Type	Description
job-id		integer	Id of the job that handles the deduplication operation. Range: [1..2^31-1]

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
ENOTINDATASET
EACCESSDENIED
EINVALIDINPUT
EINTERNALERROR
EDATABASEERROR
EDEDUPENOTSUPPORTED
EDEDUPEALREADYRUNNING

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 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 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 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 dataset 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 dataset 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 dataset 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 dataset.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

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	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or identifier of the dataset 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 dataset.
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 dataset. If specified, details of only this object will be returned.
member-name-or-id		obj-name-or-id 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 member-id and member-name-or-id is specified, then member-id will take precedence over member-name-or-id.
member-type		string optional	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". If present, only members of the specified type are 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 dataset'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

Start undeduplication operation on specified volume member of the given dataset.

Input Name	Range	Type	Description
dataset-name-or-id		obj-name-or-id	Name or Identifier of the dataset.
undedupe-member-request-info		undedupe-member-request-info	Details on member to be undeduplicated.
Output Name	Range	Type	Description
job-id		integer	Id of the job that handles the undeduplication operation. Range: [1..2^31-1]

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
ENOTINDATASET
EACCESSDENIED
EINVALIDINPUT
EINTERNALERROR
EDATABASEERROR
EUNDEDUPENOTSUPPORTED

Ends iteration of missing dataset 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 dataset.
records		integer	The number of records actually returned.

Errno	Description
EINVALIDTAG

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: The object is still a dataset 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 dataset 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 dataset.

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 dataset.
application-policy-name-or-id		obj-name-or-id optional	Name or identifier of the application policy to associate with this dataset. An application policy can only be attached to an empty dataset or a dataset containing only virtualization objects. Once an application policy is attached to a dataset, user can no longer assign volumes or qtrees to the root node of that dataset. Depending on the application policy type, 'vmware' or 'hyperv', only virtualization objects of that type can be added to the dataset. Vmware objects and Hyper-V objects can not be mixed in a single dataset.
check-protection-policy-on-commit		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.
dataset-contact		email-address-list optional	Contact for the dataset, such as the owner's e-mail address.
dataset-description		string optional	Description of the dataset, up to 255 character long.
dataset-metadata		dfm-metadata-field[] 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.
dataset-name		obj-name 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.
dataset-owner		string optional	Name of the owner of the dataset, up to 255 characters long.
edit-lock-id		integer	Identifier of the edit lock for a dataset obtained by calling dataset-edit-begin. Range: [1..2^31-1]
is-application-data		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.
is-dp-ignored		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.
is-dp-suspended		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 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 dataset for all automated actions (data protection and conformance check of the dataset).
is-suspended		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 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)
primary-volume-name-format		primary-volume-name-format optional	Name format string for the primary volumes created by Provisioning Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for the primary volumes. Volume name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the volume name. Volume name can have ASCII alphabets, ASCII numbers and underscore '_'. Volume name cannot start with a number. All other characters will be converted to character 'x'. By default, the value of the option would be empty string.
protection-policy-id		obj-id optional	Identifier of the protection policy to associate with this dataset. 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 dataset. 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		requires-non-disruptive-restore optional	Specifies whether the dataset requires a non-disruptive restore of LUNs so that the host need not get detached from the LUN. This value will be ignored if application-policy-name-or-id is specified. Non-disruptive-restore is not supported for datasets containing virtualization objects. Default value is false.
secondary-qtree-name-format		secondary-qtree-name-format optional	Name format for the secondary qtrees created by Protection Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for qtree Qtree name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the qtree name. Qtree name can have ASCII alphabets, ASCII numbers, hypen '-', dot '.' and underscore '_'. All other characters will be converted to character 'x'. By default, the value of the option would be empty string. This option does not apply to names of primary qtrees.
secondary-volume-name-format		secondary-volume-name-format optional	Naming format string for the secondary volumes created by Protection Manager. This element is optional. If the value of this element is empty string "", then the global naming option will be used to create names for the secondary volumes. Volume name can only be 60 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the volume name. Volume name can have ASCII alphabets, ASCII numbers and underscore '_'. Volume name cannot start with a number. All other characters will be converted to character 'x'. By default, the value of the option would be empty string.
snapshot-name-format		snapshot-name-format optional	Name format string for snapshots created by Protection Manager and Host Service's plug-ins. This element is optional. If the value of this element is empty string "", then the global naming option will be used to created names for snapshot. If %A is not specified as one of the substitution tokens in the format, plug-ins creating snapshots for application datasets will implicitly add %A at the end of the format string and the snapshot name will have application fields in them. Snapshot name length can only be 124 characters long. Name would be truncated if it exceeds that limit. For name collisions, numeric suffix would be added at the end of the snapshots. Snapshot name can have ASCII alphabets, ASCII numbers, underscore '_', hyphen '-', plus sign '+' and a dot '.'. All other characters will be converted to character 'x'. By default, the value of the option is an empty string.
volume-qtree-name-prefix		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.

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

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 dataset-modify-node, you may also add or remove members or dynamic references, or change the dataset'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 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	Range	Type	Description
dataset-access-details		dataset-access-details 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.
dataset-export-info		dataset-export-info optional	Specifies the NAS or SAN export settings for members provisioned in this node of the dataset.
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 dataset that was obtained by an earlier call to dataset-edit-begin.
online-migration		boolean optional	Indicates, that this dataset is capable of non-disruptive migration. This field is valid only when either dataset-access-details or vfiler-id is not empty. By default the migration will be assumed to be disruptive. Default: false.
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.
relinquish-vfiler		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 node of the dataset has been created by Provisioning Manager. In this case is-vfiler-created-for-migration will be true in dataset-info returned by dataset-list-info-iter APIs. All storage of the vFiler unit belongs to the node of the dataset, except for the root storage. Default value is false.
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 dataset 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
EDSCONFLICTSRCDESTINSAMEAGGR
EDSCONFLICTALREADYINRESPOOL
EDSCONFLICTCANTMIRROROSSV
EDSCONFLICTCANTSNAPSHOTOSSV
EDSCONFLICTINCOMPATIBLEPOLICY
EDSCONFLICTOSSVNOTALLOWED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EDSCONFLICTROOTNODE
EDSCONFLICTNOTROOTNODE
EDSCONFLICTNOTLEAFNODE
EDSCONFLICTINVALIDVFILER
ESERVICEISATTACHED
EDSCONFLICTTRANSPARENTMIGRATION

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	Range	Type	Description
edit-lock-id		integer validate	Identifier of the edit lock for a dataset 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 datastore objects from a dataset's exclusion list. This API is for removing datastore objects from a dataset's exclusion list.

Input Name	Range	Type	Description
edit-lock-id		integer	Identifier of the edit lock for a dataset obtained by calling dataset-edit-begin. Range: [1..2^31-1]
objects-to-be-removed		obj-name-or-id[]	List of datastore object names or IDs to be removed from the exclusion list.

Errno	Description
EAPIAUTHENTICATION
EEDITSESSIONNOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EDSCONFLICTNOTEXCLUDED
EDSCONFLICTNOSMLICENSE
EDSCONFLICTNOSMSVLICENSE
EINVALIDOBJECTTYPE

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 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 dataset.
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 dataset.
edit-lock-id		integer	Identifier of the edit lock for a dataset 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 dataset. Only dynamic_references explicitly added to the dataset can be removed.

Input Name	Range	Type	Description
dataset-dynamic-reference-parameters		dataset-dynamic-reference-parameter[]	List of dynamic-references to remove from the dataset.
edit-lock-id		integer	Identifier of the edit lock for a dataset 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 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 dataset-remove-resourcepool, you may also add or remove members or dynamic references, or change the dataset'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 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	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 dataset 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
EDSCONFLICTSRCDESTINSAMEAGGR
EDSCONFLICTALREADYINRESPOOL
ESERVICEISATTACHED

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 dataset, 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 dataset 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 dataset 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