APIs in Category: dataset | API version 3.6R2

dataset-add-member dataset-add-member-by-dynamic-reference 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-list-info-iter-end dataset-member-list-info-iter-next dataset-member-list-info-iter-start dataset-modify dataset-modify-node dataset-remove-member dataset-remove-member-by-dynamic-reference dataset-set-storageset 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 cannot contain luns, data sets can be associated only with data protection policies and their primary data must 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 |  |

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: Filers, vFilers, aggregates and OSSV hosts can be attached to a primary policy node. Filers, vFilers 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 dataset 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 |  |

dataset-conform-begin | [top]

> Begin a conformance run on a data set, to attempt to bring it into conformance with its data protection 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 any needed conformance actions require user confirmation, it is assumed that such confirmation has not been given, and the actions that require confirmation are not performed. Instead, those tasks that do not require confirmation are performed, and the data set's conformance status is set to 'nonconformant'. If no policy has been assigned to the dataset, the conformance run completes immediately and performs no conformance actions. Error conditions: EACCESSDENIED - User does not have privileges to access the 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
> 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.
> 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.
> 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.
> 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.
> 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.
> Output Name | Range | Type | Description
> dataset-id |  | obj-id | Identifier of the new data set.

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EDATASETEXISTS |  |
> EDATABASEERROR |  |
> EINVALIDTIMEZONE |  |

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 |  |
> 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.
> 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. 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 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, the previous edit is rolled back and a new edit 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
> 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 any needed conformance actions require user confirmation, it is assumed that such confirmation has been given, and the actions are performed.

> Input Name | Range | Type | Description
> 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.

> Errno | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EEDITSESSIONNOTFOUND |  |
> 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 suspeneded protection of the data set, is-protected is still true, but the is-dp-suspended field is 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.
> 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-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-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 group.
> 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-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-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.
> 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-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.
> 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 dataset 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. Default is False.
> 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.
> 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.

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

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, or is-dp-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 application 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.

> 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.
> resourcepool-name-or-id |  | obj-name-or-id optional | Name or object identifier of a resource pool to assign to the storage set. If another resource pool is already assigned to the storage set, then this one will replace it. If the input value is the empty string "", then no resource pool will be assigned to the storage set. If this parameter is not supplied, then the storage set's resource pool assignment will not be changed.
> 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.

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

dataset-remove-member | [top]

> Remove member from a data set. Only members explicitly added to the data set (direct members) can be removed. Volumes provisioned automatically from a resource pool are considered direct members.

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

> Errno | Description
> EEDITSESSIONCONFLICTINGOP |  |
> EEDITSESSIONNOTFOUND |  |
> ENOTINDATASET |  |
> EDPPOLICYNODENOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |

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 dataset obtained by calling dataset-edit-begin. Range: [1..2^31-1]

> Errno | Description
> EEDITSESSIONCONFLICTINGOP |  |
> EEDITSESSIONNOTFOUND |  |
> ENOTINDATASET |  |
> EDPPOLICYNODENOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |

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 | Name of the data protection policy node associated with the dynamic reference. The dp-node-name must be specified. The node cannot be the root node.
> edit-lock-id |  | integer | Identifier of the edit lock for a dataset 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-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'.
> 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-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-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 dataset at the time it was last calculated. If suppress-dataset-status was not set to true, then the resource status will be re-calculated as part of the iteration. The resource status is the only aspect of dataset-status that is ever refreshed when iterated.
> dynamic-reference-count |  | integer | The count of dynamic references to members in the data set. Range: [0..2^31-1]
> 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.
> is-protected |  | boolean | True if this data set has a data protection policy associated with it
> 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.
> 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.
> 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.
> 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.

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

> Information about one member of a data set.

> Name | Range | Type | Description
> 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.
> 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 are 'volume', 'qtree' or 'ossv_directory'.
> 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: 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: 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: 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: 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-map-entry | [top]

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

> Name | Range | Type | Description
> dp-node-name |  | dp-policy-node-name | Name of the node in the data protection policy topology.
> 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.
> 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.
> 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.

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'.
> performance-status |  | obj-status | Performance status of the dataset 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.

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