APIs in Category: dataset | API version 3.7.1

dataset-add-member dataset-add-member-by-dynamic-reference dataset-add-resourcepool dataset-begin-failover dataset-begin-failover-script-test dataset-change-dr-state dataset-conform-begin dataset-create dataset-destroy dataset-dynamic-reference-list-info-iter-end dataset-dynamic-reference-list-info-iter-next dataset-dynamic-reference-list-info-iter-start dataset-edit-begin dataset-edit-commit dataset-edit-rollback dataset-list-info-iter-end dataset-list-info-iter-next dataset-list-info-iter-start dataset-member-delete-snapshots dataset-member-list-info-iter-end dataset-member-list-info-iter-next dataset-member-list-info-iter-start dataset-missing-member-list-info-iter-end dataset-missing-member-list-info-iter-next dataset-missing-member-list-info-iter-start dataset-modify dataset-modify-node dataset-provision-member dataset-remove-member dataset-remove-member-by-dynamic-reference dataset-remove-resourcepool dataset-replace-primary-members dataset-resize-member dataset-set dataset-set-storageset dataset-update-dr-status dataset-update-protection-status | At the highest level, a data set is a logical collection of data, optionally associated with one or more policies. This collection of data resides on storage containers which should be thought of as transient in nature. That is, the storage containers holding the data may change over time and the data should be treated independently from the storage it happens to reside on. Data sets typically describe data that has been provisioned from resource pools according to a policy. A data set may also be created by populating it with legacy storage containers such as existing Data ONTAP volumes or non-NetApp containers such as OSSV directories. In concrete terms, a data set is a collection of volumes, qtrees, luns, or possibly host based containers such as OSSV directories, with the addition of policies that are associated with it. The data set provides virtualization of the physical storage used to hold the data. Currently, data sets can not contain LUNs, data sets can be associated only with data protection policies and their primary data can be either provisioned based on a provisioning policy or can be populated with legacy storage containers. Secondary storage can be automatically provisioned from a resource pool or added explicitly.

NetApp Manage ONTAP

dataset-add-member | [top]

> Add members to an existing data set. This API is for adding direct member objects to one or more storage sets in the data set. Each storage set is identified by the data protection policy node associated with it. The types of storage objects allowed to be added vary: Volumes, qtrees and OSSV directories are allowed in the storage set attached to a primary policy node. Only volumes are allowed in a storage sets attached to secondary/destination nodes. It is legal to add storage objects to multiple storage sets in a single call.

> Input Name | 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 |  |

dataset-add-member-by-dynamic-reference | [top]

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

dataset-add-resourcepool | [top]

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

dataset-begin-failover | [top]

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

dataset-begin-failover-script-test | [top]

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

dataset-change-dr-state | [top]

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

dataset-conform-begin | [top]

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

dataset-create | [top]

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

dataset-destroy | [top]

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

dataset-dynamic-reference-list-info-iter-end | [top]

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

dataset-dynamic-reference-list-info-iter-next | [top]

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

dataset-dynamic-reference-list-info-iter-start | [top]

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

dataset-edit-begin | [top]

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

dataset-edit-commit | [top]

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

dataset-edit-rollback | [top]

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

dataset-list-info-iter-end | [top]

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

dataset-list-info-iter-next | [top]

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

dataset-list-info-iter-start | [top]

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

dataset-member-delete-snapshots | [top]

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

dataset-member-list-info-iter-end | [top]

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

dataset-member-list-info-iter-next | [top]

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

dataset-member-list-info-iter-start | [top]

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

dataset-missing-member-list-info-iter-end | [top]

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

dataset-missing-member-list-info-iter-next | [top]

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

dataset-missing-member-list-info-iter-start | [top]

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

dataset-modify | [top]

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

dataset-modify-node | [top]

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

dataset-provision-member | [top]

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

dataset-remove-member | [top]

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

dataset-remove-member-by-dynamic-reference | [top]

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

dataset-remove-resourcepool | [top]

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

dataset-replace-primary-members | [top]

> Replace primary members and relationships after a failover. If a secondary volume or qtree is specified, it replaces the primary member for just that secondary volume or qtree. If neither are specified, it replaces all primary members that need to be replaced. If 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 |  |

dataset-resize-member | [top]

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

dataset-set | [top]

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

dataset-set-storageset | [top]

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

> Input Name | 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 |  |

dataset-update-dr-status | [top]

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

dataset-update-protection-status | [top]

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

Element definition: application-info | [top]

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

Element definition: dataset-dynamic-reference-info | [top]

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

Element definition: dataset-dynamic-reference-parameter | [top]

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

Element definition: dataset-export-info | [top]

> 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'.

Element definition: dataset-info | [top]

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

Element definition: dataset-member-info | [top]

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

Element definition: dataset-member-parameter | [top]

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

Element definition: delete-snapshots-request-info | [top]

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

Element definition: dfm-metadata-field | [top]

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

Element definition: dp-policy-node-name | [top]

> Name of a node in a DP policy graph. This typedef is an alias for the builtin ZAPI type string. A node name may contain from 1 to 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). The name of each node in a DP policy must be unique, but nodes in different policies may share the same name. Node names are always compared in a case-insensitive manner. This means that, for example, "a" and "A" are considered to be the same name for purposes of: creating new nodes for a new policy, renaming nodes of an existing policy, or looking up a policy's nodes by name. On the other hand, ZAPIs that return node names do not change the capitalization at all. For example, if a node's name has been set to "Backup", then 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]

Element definition: dr-state | [top]

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

Element definition: dry-run-result | [top]

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

Element definition: email-address-list | [top]

> A list of email addresses. If more than one email address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up to 255 characters.

> [none]

Element definition: job-info | [top]

> Job information of provisioning request.

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

Element definition: missing-member-info | [top]

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

Element definition: obj-id | [top]

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

> [none]

Element definition: obj-name | [top]

> Name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object name must conform to the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all. The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules: If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common error code, ZAPI specifications are not required to document cases when they may return it. If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code. A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If an input name element is used to refer to an existing object, then the ZAPI specification must specify which DFM object type (e.g. data set, host, DP policy, etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats. Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name. For example, this constraint applies to data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: provision-member-request-info | [top]

> Details specific to the 'provision_member' request.

> Name | Range | Type | Description
> description |  | string optional | Description of the provisioning request. The length of this string cannot be more than 255 characters.
> initial-snapshot-space |  | integer optional | Applicable when provisioning members in SAN data sets (i.e. data sets associated with provisioning policy of type 'san'). Specify the initial disk space in bytes that needs to be allocated upfront for Snapshot copies of the member. Range: [1..2^44-1]
> maximum-snapshot-space |  | integer optional | Applicable when provisioning members in SAN data sets (i.e. data sets associated with provisioning policy of type 'san'). Specify the maximum disk space in bytes for the Snapshot copies of the member. Once the space consumed by Snapshot copies reaches this value, further Snapshot copies will fail. Range: [1..2^44-1]
> name |  | string | Name of the storage container. If this is a NAS data set, i.e the provisioning policy associated with the primary node of the data set is of type 'nas', then this name corresponds to the qtree created. If this is a SAN data set, i.e the provisioning policy associated with the primary node of the data set is of type 'san', then this name corresponds to the LUN or volume that will be provisioned as part of this request. The length of this string cannot be more than 255 characters.
> provisioning-policy-id |  | obj-id optional | Name or identifier of the provisioning policy used with this request. Ignored for dataset-provision-member and is used only when listing provisioning requests and jobs.
> provisioning-policy-name |  | obj-full-name optional | Name of the provisioning policy used with this request. Present only if the request type is 'provision_member'. Ignored for dataset-provision-member and is used only when listing provisioning requests and jobs.
> size |  | integer validate | Size for the data set member. The value is specified in bytes. Range: [1..2^44-1]

Element definition: replace-result | [top]

> A description of one replace action.

> Name | Range | Type | Description
> dp-node-name |  | dp-policy-node-name optional | Name of the data protection policy node associated with the secondary volume or qtree.
> member-type |  | string | Type of the object replaced. Possible values are "volume", or "qtree".
> new-primary-member-id |  | obj-id optional | Identifier of the new primary member replacing the old. new-primary-member-id is omitted if the replace-status is "not_found".
> new-primary-member-name |  | obj-name optional | Display name of the new primary member replacing the old. new-primary-member-name is omitted if the replace-status is "not_found".
> old-primary-member-id |  | obj-id optional | Identifier of the primary member that needs to be replaced. old-primary-member-id is omitted if the replace-status is "not_required".
> old-primary-member-name |  | obj-name optional | Display name of the primary member that was replaced. old-primary-member-name is omitted if the replace-status is "not_required".
> replace-status |  | string | Possible values are "not_found", "not_required", or "replaced". "not_found" is returned if a replacement primary was not found. "not_required" is returned if the primary did not need to be replaced. "replaced" is returned if the primary was successfully replaced.
> secondary-member-id |  | obj-id | Identifier of the secondary member whose primary member needs to be replaced.
> secondary-member-name |  | obj-name | Displayed name of the secondary member whose primary member needs to be replaced.

Element definition: requires-non-disruptive-restore | [top]

> When this attribute is set, the data set is configured to allow LUNs to be restored from backups in such a way that the host need not detach from the LUN. Configuring the data set for non-disruptive restore does not guarantee that all backup instances may be restored non-disruptively. It only applies to backup instances reached through a Backup connection. The caller must check the supports-non-disruptive-restore output element returned by dp-backup-list-info-next to tell whether a given backup instance can be restored non-disruptively. Specifically, when this attribute is set: All storage systems must be running ONTAP 7.3 or later. Protection Manager must have working ZAPI credentials for all storage systems in use by this data set. All Backup connections will be implemented using SnapVault, not Qtree SnapMirror. All non-primary storage systems used by the data set must have a SnapVault Secondary license. If any of these constraints is not met when adding a member to the data set, the data set will not be in conformance and the addition will generate conformance errors. Addition of members with ONTAP version less than 7.3 to the primary node of the data set will fail with errors. requires-nondisruptive-restore may only be specified if: No Backup connection in the protection policy used by the data set is DR capable (i.e. the is-dr-capable attribute may not be set for any Backup connection of the policy). The data set must be an application data set. Thus, if requires-non-disruptive-restore is specified as true, is-application-data must also be present and true. Callers may check the non-disruptive-restore-compatible output element of the dp-policy-list-info-iter-next API to tell which policies may be applied to data sets requiring non-disruptive restores.

> [none]

Element definition: resize-member-request-info | [top]

> Details of the resize request.

> Name | Range | Type | Description
> maximum-capacity |  | integer optional | Specify the new maximum capacity value for a flexbile volume. The value is specified in bytes. Valid only if the filer to which the volume belongs is of ONTAP version 7.1 or above only. This input is valid only if member-id or member-name refers to a flexible volume. Range: [1..2^44-1]
> member-id |  | obj-id optional | Identifier of the data set member on which the resize operation has to be carried out. This member can be either a flexible volume or a qtree which is a member of the effective primary node of the data set either through direct or indirect membership.
> member-name |  | obj-name optional | Name of the data set member on which the resize operation has to be carried out. This member can be either a flexible volume or a qtree which is a member of the effective primary node of the data set either through direct or indirect membership. Either member-id or member-name has to be specified. If member-id is specified then member-name is ignored.
> new-size |  | integer optional | Specify the new size of the data set member. The value is specified in bytes. If the member is a volume, this corresponds to the size of the volume. If the member is a qtree, this corresponds to hard disk quota limit for the qtree. Range: [1..2^44-1]
> snap-reserve |  | integer optional | Specifies the percetage of space set aside for snapshots in a volume. The value is specified in percentage of the total size of the volume. This input is valid only if member-id or member-name refers to a flexible volume. Range: [0..100]

Element definition: application-info | [top]

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

Element definition: cifs-share-name | [top]

> CIFS share name of the storage container (volumes, qtrees).

> [none]

Element definition: dataset-cifs-export-setting | [top]

> If storage inside this data set node is exported over CIFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> cifs-domain |  | string optional | Name of the CIFS domain. If present, then only filers or vFilers belonging to this CIFS domain is considered for provisioning. If not present, then any filer is picked. Up to 255 characters.
> dataset-cifs-share-permissions |  | dataset-cifs-share-permission[] optional | Specifies the permissions granted to users on storage provisioned in this data set node. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.

Element definition: dataset-export-info | [top]

> 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'.

Element definition: dataset-export-protocol | [top]

> Specifies the export protocols that members in this data set node will be exported over. Possible values are 'nfs', 'cifs', 'mixed', 'fcp', 'iscsi' and 'none'. Specifying 'mixed' implies that the storage in the data set should be exported over both NFS and CIFS.

> [none]

Element definition: dataset-lun-mapping-info | [top]

> Specifies the hosts and/or initiators to which LUNs in this data set node will be mapped, and the igroup OS type.

> Name | Range | Type | Description
> igroup-os-type |  | string | Specifies the OS type for initiators to map LUNs in the data set node to. Possible values are: 'windows', 'windows_gpt', 'windows_2008', 'hpux', 'aix, 'linux, 'solaris', 'vmware' and 'netware'. Here "windows_gpt" refers to Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers to Windows Longhorn systems.
> lun-mapping-initiators |  | lun-mapping-initiator[] | Specifies the initiators to map LUNs in the data set node to, and, optionally, the host to which they belong.

Element definition: dataset-map-entry | [top]

> Map a storage set to a policy node. The root node is not included in the map.

> Name | Range | Type | Description
> dataset-export-info |  | dataset-export-info optional | Specifies the NAS or SAN export settings for the storage 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.
> dp-node-id |  | integer | ID of the node in the data protection policy. Range: [1..2^31-1].
> dp-node-name |  | dp-policy-node-name | Name of the node in the data protection policy topology.
> is-dr-capable |  | boolean | True if this node is the destination of a disaster recovery capable connection in the data protection policy.
> provisioning-policy-id |  | obj-id optional | Identifier of the provisioning policy associated with the data set node.
> provisioning-policy-name |  | obj-name optional | Name of the provisioning policy associated with the data set node.
> resourcepool-id |  | obj-id optional | Identifier of the resource pool assigned to the storage set that maps to the policy node. The output element is omitted if no resource pool has been assigned to the storage set. If more than one resource pool is assigned to the data set node, then one of them is returned in this field. This is a legacy parameter and resourcepools field should be used instead to get the list of all resource pools assigned to the data set node.
> resourcepool-name |  | obj-name optional | Name of the resource pool assigned to the storage set that maps to the policy node. The output element is omitted if no resource pool has been assigned to the storage set. If more than one resource pool is assigned to the 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 | Name Information of the resource pool(s) assigned to the storage set that maps to the policy node. The output element is omitted if no resource pool(s) has been assigned to the storage set.
> storageset-id |  | obj-id | Identifier of the storage set that maps to the policy node.
> storageset-name |  | obj-name | Name of the storage set that maps to the node.
> storageset-timezone |  | string | Time zone specification, if any, of the storage set. Storage sets without time zones use a time zone from the resource pool the storage came from, or from a default time zone. Return an empty string if no time zone has been assigned to the storage set. Currently valid time zones can be listed by timezone-list-info-iter.
> vfiler-id |  | obj-id optional | Identifier of the vFiler unit attached to the data set node.
> vfiler-name |  | obj-full-name optional | Name of the vFiler unit attached to the data set node.

Element definition: dataset-nfs-export-setting | [top]

> If storage inside this data set node is exported over NFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> anonymous-access-user |  | string optional | If the client accessing the export is not present in the root access list for the export, the effective user for root is the value specified for this field. Default value is 65534 which maps to user nobody. It could be an integer Range: [0..65534] or a user name not more than 255 characters.
> disable-setuid |  | boolean optional | If true, causes the server file system to ignore attempts to enable the setuid or setgid mode bits. Default value is true.
> is-readonly-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-only permissions on nfs exports in this data set node. Equivalent to specifying "ro" on the filer. Default value is false. If true, is-readwrite-for-all-hosts must be false.
> is-readwrite-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-write permissions on nfs exports in this data set node. Equivalent to specifying "rw" on the filer. Default value is false. If true, is-readonly-for-all-hosts must be false.
> nfs-export-ro-hosts |  | nfs-export-host[] optional | A list of hosts with read-only permissions on exports in this data set node. If a non empty list of nfs-export-ro-hosts is present along with is-readonly-for-all-hosts as true, then ZAPI will throw an error.
> nfs-export-root-hosts |  | nfs-export-host[] optional | A list of hosts with the root user having read-only or read-write permissions on exports in this data set node.
> nfs-export-rw-hosts |  | nfs-export-host[] optional | A list of hosts with read-write permissions on exports in this data set node. If a non empty list of nfs-export-rw-hosts is present along with is-readwrite-for-all-hosts as true, then ZAPI will throw an error.
> nfs-protocol-version |  | string optional | NFS protocol version, valid values are "v2", "v3" and "v4". Default value is "v3". If set, the storage systems that have the given version enabled will be selected to provision storage for the data set.
> nfs-security-flavors |  | nfs-security-flavor[] optional | List of strings specifying the security flavors supported on exports in this data set node. If this field is not specified, the default value of 'sys' is assumed.

Element definition: dataset-resourcepool-info | [top]

> Information about resource pools associated with data set.

> Name | Range | Type | Description
> resourcepool-id |  | obj-id | Identifier of the resource pool assigned to the storage set.
> resourcepool-name |  | obj-name | Name of the resource pool assigned to the storage set. storage set.

Element definition: dataset-status | [top]

> The complex status of the data set at the time it was last re-calculated.

> Name | Range | Type | Description
> conformance-check-results |  | conformance-run-result[] optional | Results of the most recent conformance check. If the data set does not have a data protection policy assigned to it, this element will not be present.
> conformance-status |  | string | A data set is in conformance if it is configured according to policy. For example, a data protection policy might require provisioned secondary and tertiary volumes and the creation of backup and mirroring relationships. If they are properly configured, then the data set is conformant. If the data set is not conformant, but the system is currently in the process of bringing the data set into conformance, then the data set is conforming. If the system is unable to satisfy one or more policy requirements, then the data set is nonconformant. Possible values are: 'conformant', 'conforming', 'nonconformant'.
> dr-protection-status |  | string optional | The DR protection status only applies to data sets with data protection policies and only to protection policy connections which are disaster recovery capable. A system may be up and running and properly configured, yet not protecting data. For example, if the lag thresholds specified by the policy are exceeded, then the data is not being sufficiently protected. Possible values are: "protected", "uninitialized", "protection_suspended", "protection_failure", "lag_warning", "lag_error".
> dr-status |  | dr-status optional | The status of the data set with regard to Disaster Recovery. The DR status determines how successful a DR operation such as a failover likely would be if it were performed on the data set.
> dr-status-problems |  | dr-status-problem[] optional | A list of the problems found that cause the data set not to have a dr-status of "normal". This list is not guaranteed to contain all problems related to DR status. If dr-status is present and does not have the value "normal", then this element appears in the output, and the list contains at least one item. Otherwise, it does not appear.
> performance-status |  | obj-status | Performance status of the data set based on the worst performance events on its members.
> protection-status |  | string optional | The protection status only applies to data sets with data protection policies. A system may be up and running and properly configured, yet not protecting data. For example, if the lag thresholds specified by the policy are exceeded, then the data is not being sufficiently protected. Possible values are: "protected", "uninitialized", "protection_suspended", "protection_failure", "lag_warning", "lag_error".
> resource-status |  | obj-status | The resource status is the "worst" status of the resources relevant to the data set. Resource status is calculated using the same rules as for DFM resource group status.
> space-status |  | space-status optional | Space status of the data set. Space status of every member of every node of the data set is considered and the worst space status is considered as the space status of the data set. Space status for members of a data set node is calculated only if a provisioning policy is associated with that data set node.

Element definition: dp-policy-node-name | [top]

> Name of a node in a DP policy graph. This typedef is an alias for the builtin ZAPI type string. A node name may contain from 1 to 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). The name of each node in a DP policy must be unique, but nodes in different policies may share the same name. Node names are always compared in a case-insensitive manner. This means that, for example, "a" and "A" are considered to be the same name for purposes of: creating new nodes for a new policy, renaming nodes of an existing policy, or looking up a policy's nodes by name. On the other hand, ZAPIs that return node names do not change the capitalization at all. For example, if a node's name has been set to "Backup", then 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]

Element definition: dp-timestamp | [top]

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

> [none]

Element definition: lun-igroup-info | [top]

> If the LUN has been mapped to any igroups or hosts, this structure contains information relevant to the same.

> Name | Range | Type | Description
> igroup-initiators |  | lun-mapping-initiator[] optional | Specifies the initiators and/or hosts to which the LUN is mapped, if any.
> igroup-lun-id |  | integer | If the LUN has been mapped to any initiator groups, this field contains the ID generated by the storage system for the LUN. Range: [1..2^31-1]
> igroup-name |  | obj-name | Name of the igroup.
> igroup-os-type |  | string | Specifies the OS type of the igroup. Possible values: "solaris", "windows_gpt", "windows_2008", "windows", "hpux", "aix", "linux", "netware", "vmware". Here "windows_gpt" refers to Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers to Windows Longhorn systems.
> igroup-protocol |  | string | Specifies the protocol for the initiator group. Possible values: "fcp", "iscsi".

Element definition: obj-full-name | [top]

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

> [none]

Element definition: obj-id | [top]

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

> [none]

Element definition: obj-name | [top]

> Name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object name must conform to the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all. The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules: If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common error code, ZAPI specifications are not required to document cases when they may return it. If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code. A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If an input name element is used to refer to an existing object, then the ZAPI specification must specify which DFM object type (e.g. data set, host, DP policy, etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats. Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name. For example, this constraint applies to data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the appliance or agent. warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption. error: An object has error status when it does not cause any service disruption, but it may affect performance. critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]

Element definition: snapshot | [top]

> Information of one Snapshot copy. Either unique-id or name of the Snapshot copy should be specified.

> Name | Range | Type | Description
> snapshot-name |  | string optional | Name of the Snapshot copy. If unique-id is specified, then this element is ignored.
> unique-id |  | string optional | Unique identifier of the Snapshot copy. Currently, this is the Snapshot copy's creation time.

Element definition: space-info | [top]

> Specifies the total, available and used space in a data set member, the space status and various space related conditions of the member.

> Name | Range | Type | Description
> available-space |  | integer optional | Specifies the space available in the data set member, in bytes. Range: [1..2^44-1]
> space-conditions |  | space-condition[] optional | Various space conditions of a data set member. Present only if the space-status of the data set member is one of 'error' or 'warning'.
> space-status |  | space-status optional | Space status of the member.
> total-space |  | integer optional | Specifies the total capacity of the data set member, in bytes. Range: [1..2^44-1]
> used-space |  | integer optional | Specifies the capacity used in the data set member, in bytes. Range: [1..2^44-1]

Element definition: conformance-run-result | [top]

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

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

Element definition: dataset-cifs-export-setting | [top]

> If storage inside this data set node is exported over CIFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> cifs-domain |  | string optional | Name of the CIFS domain. If present, then only filers or vFilers belonging to this CIFS domain is considered for provisioning. If not present, then any filer is picked. Up to 255 characters.
> dataset-cifs-share-permissions |  | dataset-cifs-share-permission[] optional | Specifies the permissions granted to users on storage provisioned in this data set node. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.

Element definition: dataset-cifs-share-permission | [top]

> A single permission granted to a user on CIFS shares within a data set node.

> Name | Range | Type | Description
> cifs-username |  | string | Name of a user in the specified domain. The username may be the name of an actual domain user or one of the built-in names - 'administrator' or 'everyone'.
> permission |  | cifs-permission | Specifies the permissions granted to a user.

Element definition: dataset-export-info | [top]

> 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'.

Element definition: dataset-export-protocol | [top]

> Specifies the export protocols that members in this data set node will be exported over. Possible values are 'nfs', 'cifs', 'mixed', 'fcp', 'iscsi' and 'none'. Specifying 'mixed' implies that the storage in the data set should be exported over both NFS and CIFS.

> [none]

Element definition: dataset-lun-mapping-info | [top]

> Specifies the hosts and/or initiators to which LUNs in this data set node will be mapped, and the igroup OS type.

> Name | Range | Type | Description
> igroup-os-type |  | string | Specifies the OS type for initiators to map LUNs in the data set node to. Possible values are: 'windows', 'windows_gpt', 'windows_2008', 'hpux', 'aix, 'linux, 'solaris', 'vmware' and 'netware'. Here "windows_gpt" refers to Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers to Windows Longhorn systems.
> lun-mapping-initiators |  | lun-mapping-initiator[] | Specifies the initiators to map LUNs in the data set node to, and, optionally, the host to which they belong.

Element definition: dataset-nfs-export-setting | [top]

> If storage inside this data set node is exported over NFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> anonymous-access-user |  | string optional | If the client accessing the export is not present in the root access list for the export, the effective user for root is the value specified for this field. Default value is 65534 which maps to user nobody. It could be an integer Range: [0..65534] or a user name not more than 255 characters.
> disable-setuid |  | boolean optional | If true, causes the server file system to ignore attempts to enable the setuid or setgid mode bits. Default value is true.
> is-readonly-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-only permissions on nfs exports in this data set node. Equivalent to specifying "ro" on the filer. Default value is false. If true, is-readwrite-for-all-hosts must be false.
> is-readwrite-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-write permissions on nfs exports in this data set node. Equivalent to specifying "rw" on the filer. Default value is false. If true, is-readonly-for-all-hosts must be false.
> nfs-export-ro-hosts |  | nfs-export-host[] optional | A list of hosts with read-only permissions on exports in this data set node. If a non empty list of nfs-export-ro-hosts is present along with is-readonly-for-all-hosts as true, then ZAPI will throw an error.
> nfs-export-root-hosts |  | nfs-export-host[] optional | A list of hosts with the root user having read-only or read-write permissions on exports in this data set node.
> nfs-export-rw-hosts |  | nfs-export-host[] optional | A list of hosts with read-write permissions on exports in this data set node. If a non empty list of nfs-export-rw-hosts is present along with is-readwrite-for-all-hosts as true, then ZAPI will throw an error.
> nfs-protocol-version |  | string optional | NFS protocol version, valid values are "v2", "v3" and "v4". Default value is "v3". If set, the storage systems that have the given version enabled will be selected to provision storage for the data set.
> nfs-security-flavors |  | nfs-security-flavor[] optional | List of strings specifying the security flavors supported on exports in this data set node. If this field is not specified, the default value of 'sys' is assumed.

Element definition: dr-status | [top]

> The DR status has one of the following values: normal : A DR operation would likely succeed, and the amount of lost data would be within the duration specified by the lag warning threshold. warning : A DR operation would likely succeed, but the amount of lost data would exceed that specified by the policy's lag warning threshold. error : A DR operation would likely fail, or would succeed but the amount of lost data would be unacceptable. The DR status is computed based on all of the following: The resource status of the data set's DR secondaries. The specific condition that impacts the resource status is the availability of the secondary filers and volumes. The status will be error if either is unavailable. Whether there is sufficient space on the DR secondaries to meet the space guarantees of the primaries. The existence and state of the relationships associated with the data set's disaster recovery capable connection. Whether the relationships associated with the data set's DR-capable connection are within their thresholds for lag warnings and errors. 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.

> [none]

Element definition: dr-status-problem | [top]

> An explanation of a single problem that causes the data set not to have a dr-status of "normal".

> Name | Range | Type | Description
> dr-status-description |  | string | A human-readable message describing the problem.
> dr-status-severity |  | string | Value is "warning" if the problem causes the data set to have a dr-status of at least "warning". Value is "error" if the problem causes the data set to have a dr-status of at least "error".

Element definition: lun-mapping-initiator | [top]

> Specifies an initiator to map LUNs in the data set node to, and, optionally, the host to which it belongs.

> Name | Range | Type | Description
> hostname |  | string optional | Specifies the name of the host which owns the initiator.
> initiator-id |  | initiator-id | Specifies an initiator id on a host to which a LUN should be mapped.

Element definition: nfs-export-host | [top]

> Specifies a single host or all-hosts. A host can be a host name (DNS name), an IP address, a subnet or a domain name. If an 'all-hosts' entry is present, all other host name entries must be negated.

> Name | Range | Type | Description
> hostname |  | string optional | Specifies a single host name entry. A host name may be a DNS name, an IP address (in standard aaa.bbb.ccc.ddd format), a subnet (specified as <subnet address>/<prefix length> or '[network] <subnet-address> [netmask] <netmask>'), a domain, or a workgroup.
> is-an-exception |  | boolean optional | Specifies that the rule does not apply to this host. Should be used when it is required to grant permissions to hosts in a subnet or a domain or all hosts excluding some. Default value is false.

Element definition: nfs-security-flavor | [top]

> A security flavor to be applied on nfs exports. Possible values are 'none', 'sys' (Unix Style), 'krb5' (Kerberos v5) , krb5i' (Kerberos v5 integrity) and 'krb5p' (Kerberos v5 privacy). Default value is 'sys'.

> [none]

Element definition: obj-id | [top]

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

> [none]

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the appliance or agent. warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption. error: An object has error status when it does not cause any service disruption, but it may affect performance. critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]

Element definition: space-condition | [top]

> Represents a space condition of a data set member.

> Name | Range | Type | Description
> condition |  | string | Space condition. Possible values: "volume-used-vs-size-above-nearly-full" Used space of the volume vs volume usable data space has crossed nearly full threshold specified in the policy "volume-used-vs-size-above-full" Used space of the volume vs volume usable data space has crossed full threshold specified in the policy "volume-used-vs-maximum-size-above-nearly-full" Used space of the volume vs volume usable maximum data space has crossed nearly full threshold specified in the policy "volume-used-vs-maximum-size-above-full" Used space of the volume vs volume usable maximum data space has crossed full threshold specified in the policy "qtree-used-vs-quota-above-nearly-full" Qtree used space vs qtree hard limit has crossed nearly full threhsold specified in policy "qtree-used-vs-quota-above-full" Qtree used space vs qtree hard limit has crossed full threhsold specified in policy "volume-snapshot-used-above-full-threshold" Snapshot used space in the volume has crossed volSnapshotFullThreshold specified in Operations Manager. "volume-no-next-snapshot" Next snapshot is not possible in the volume due to space contraints
> reason |  | string optional | Reason for this space condition. This can be a maximum of 1024 characters.
> severity |  | string optional | Severity of this space condition. Possible values are: "unknown", "ok", "warning", "error"
> suggestion |  | string optional | Possible action that can be taken to correct this. This can be a maximum of 1024 characters.

Element definition: space-status | [top]

> Worst space status of a data set or a member. Possible values are: 'unknown', 'ok', 'warning', 'error'

> [none]

Element definition: cifs-permission | [top]

> Permission granted to a CIFS user on a share. Possible values are 'no_access', 'read', 'change' and 'full_control'

> [none]

Element definition: dataset-cifs-export-setting | [top]

> If storage inside this data set node is exported over CIFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> cifs-domain |  | string optional | Name of the CIFS domain. If present, then only filers or vFilers belonging to this CIFS domain is considered for provisioning. If not present, then any filer is picked. Up to 255 characters.
> dataset-cifs-share-permissions |  | dataset-cifs-share-permission[] optional | Specifies the permissions granted to users on storage provisioned in this data set node. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.

Element definition: dataset-cifs-share-permission | [top]

> A single permission granted to a user on CIFS shares within a data set node.

> Name | Range | Type | Description
> cifs-username |  | string | Name of a user in the specified domain. The username may be the name of an actual domain user or one of the built-in names - 'administrator' or 'everyone'.
> permission |  | cifs-permission | Specifies the permissions granted to a user.

Element definition: initiator-id | [top]

> For FCP initiators, this is a string composed of 16 hexadecimal digits. For iSCSI initiators, this is an initiator name in the dotted-domain notation.

> [none]

Element definition: cifs-permission | [top]

> Permission granted to a CIFS user on a share. Possible values are 'no_access', 'read', 'change' and 'full_control'

> [none]