APIs in Category: dp-backup | API version 3.8

dp-backup-content-list-iter-end dp-backup-content-list-iter-next dp-backup-content-list-iter-start dp-backup-get-location dp-backup-list-iter-end dp-backup-list-iter-next dp-backup-list-iter-start dp-backup-start dp-backup-version-create dp-backup-version-delete dp-backup-version-list-iter-end dp-backup-version-list-iter-next dp-backup-version-list-iter-start dp-backup-version-modify dp-get-dataset-backup-jobs-data

NetApp Manage ONTAP

dp-backup-content-list-iter-end | [top]

> Ends iteration to list file contents of a backup.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-backup-content-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-backup-content-list-iter-next | [top]

> Get next few records in the iteration started by dp-backup-content-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1].
> tag |  | string | Tag from a previous dp-backup-content-list-iter-start.
> Output Name | Range | Type | Description
> backup-contents |  | dp-backup-content-info[] | List of files and directories in backup.
> records |  | integer | The number of records actually returned. Range: [0..2^31-1].

> Errno | Description
> EINVALIDTAG |  |

dp-backup-content-list-iter-start | [top]

> Starts iteration to list contents of a backup. Files and directories directly under specified path are listed. In order to list all files recursively, multiple invocations of this API are necessary.

> Input Name | Range | Type | Description
> backup-id |  | integer | Id of backup instance whose file contents are to be listed. Use dp-backup-list-iter-start to retrieve valid backup ids. Range: [1..2^31-1]
> primary-snapshot-name |  | string optional | Name of the Snapshot copy on the primary where the data originated. This field is ignored if the root-object-name-or-id is omitted. It is also ignored, if primary-snapshot-unique-id is specified.
> primary-snapshot-unique-id |  | string optional | Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This field is ignored if the root-object-name-or-id is omitted.
> root-object-name-or-id |  | string optional | Name or id of a dataset member that is at the root of the file tree. This may be qtree, ossv directory or volume that is the source of the physical data protection relationship. Indirect members may also be specified. If the sub path input is given, then this input is required. If specified, backup contents of this object are listed. Otherwise, backup contents directly under the dataset are listed.
> sub-path |  | string optional | Local subpath within the dataset with regard to root-object-name-or-id. If specified, backup contents directly under this sub path are listed. Otherwise, backup contents directly under the specified root-object are listed. Ignored if root-object-name-or-id input is not present If the root-object-name-or-id is a volume,qtree or ossv unix directory then this sub-path is a unix-like path, ex: 'dir1/dir2/'. If the root-object-name-or-id is ossv windows directory then this sub-path is a windows path, ex : 'dir1\\dir2\\'. Maximum length of sub-path is 32767 characters.
> suppress-child-count |  | boolean optional | This flag is set to FALSE by default. When TRUE, the child count for a file will not be calculated and a zero will be returned in its place in the file_info structer.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-backup-content-list-iter-next. Range: [0..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to dp-backup-content-list-iter-next.

> Errno | Description
> EBACKUPLOCATIONDOESNOTEXIST |  |
> EBACKUPDOESNOTEXIST |  |
> EPATHDOESNOTEXIST |  |

dp-backup-get-location | [top]

> Given a backup-id or the backup-version and a list of member-ids or member-names, returns the snapshot name, volume that it exists on as well as the secondary qtree associated with the member id. If more than one snapshots match the backup-id or backup-version, only one, the first item in the resulting list, is returned. Multiple matches occur when the same backup version exists on multiple nodes. In case of mutiple matches which snapshot gets picked is unspecified.

> Input Name | Range | Type | Description
> backup-id |  | integer optional | Identifier of the backup instance. Range: [1..2^31-1]
> backup-version |  | dp-timestamp optional | Timestamp of the backup version.
> dataset-name-or-id |  | obj-name-or-id optional | Name or ID of the dataset to which this backup version belongs to. This parameter is ignored in case of backup-id parameter in the input.
> paths |  | dp-backup-path-info[] | Path information about backup
> Output Name | Range | Type | Description
> backup-locations |  | backup-location-info[] | Location information for the backup.

dp-backup-list-iter-end | [top]

> Ends iteration to list backups.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-backup-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-backup-list-iter-next | [top]

> Get next few records in the iteration started by dp-backup-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve.
> tag |  | string | Tag from a previous dp-backup-list-iter-start.
> Output Name | Range | Type | Description
> backups |  | dp-backup-info[] | List of backups.
> records |  | integer | The number of records actually returned. Range: [0..2^31-1]

> Errno | Description
> EINVALIDTAG |  |

dp-backup-list-iter-start | [top]

> Starts iteration to list backups of a dataset or a path within dataset.

> Input Name | Range | Type | Description
> backup-id |  | integer optional validate | Id of backup instance whose information is to be listed. If this parameter is specified backup-version, volume-id, snapshot-unique-id, root-object-name-or-id and sub-path parameters are ignored. Range: [1..2^31-1]
> backup-version |  | dp-timestamp optional validate | Timestamp when the backup was taken. Backups of the dataset that were taken at this time is listed. If this parameter is specified, volume-id, snapshot-unique-id, root-object-name-or-id and sub-path are ignored.
> dataset-name-or-id |  | obj-name-or-id | Name or id of dataset. Backups for this dataset are listed.
> 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-metadata |  | boolean optional | If true, returns metadata for the backup. If false, metadata, which can be large in size, is not returned. Default is false.
> root-object-name-or-id |  | obj-name-or-id optional | Name or id of a dataset member that is at the root of the file tree. This may be qtree, ossv directory or volume that is source of the physical data protection relationship. If sub path input is given then this input is required. If specified, backups containing this object are listed. Otherwise, all backups of this dataset are listed.
> snapshot-unique-id |  | string optional | Unique id of a snapshot. If volume-id is present, then this input must be given. Ignored if volume-id is not present.
> sub-path |  | string optional | Local subpath within the dataset with regard to root-object-name-or-id. If specified, backups containing this sub path are listed. Ignored if root-object-name-or-id input is not present If the root-object-name-or-id is a volume,qtree or ossv unix directory then this sub-path is a unix-like path, ex: 'dir1/dir2/'. If the root-object-name-or-id is ossv windows directory then this sub-path is a windows path, ex : 'dir1\dir2\'. Maximum length of sub-path is 32767 characters.
> volume-id |  | obj-id optional | Id of volume that is member of a dataset node. If this input is present then snapshot-unique-id must be present. backup-version containing this (volume-id, snapshot-unique-id) is returned. If this parameter is specified, root-object-name-or-id, sub-path are ignored.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-backup-list-iter-next. Range: [0..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to dp-backup-list-iter-next.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EBACKUPDOESNOTEXIST |  |
> EPATHDOESNOTEXIST |  |
> EINVALIDINPUT |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |

dp-backup-start | [top]

> Start an unscheduled backup of a dataset. All members of the dataset will be backed up. A background job will be spawned to backup the dataset.

> Input Name | Range | Type | Description
> backup-description |  | string optional | Description for the backup. Can be arbitrary string meaningful to the user. If provided, the job spawned will have this description. The length of this string cannot be more than 255 characters.
> backup-destination |  | string optional | Destination of the backup. This should be name of one of the nodes in the data protection policy attached to the dataset. If name of the primary node is specified, the management station takes local snapshot only. Otherwise, the management station transfers the backup over intervening policy nodes until it reaches the specified destination node. If this input is not provided, then the management station takes local snapshots on the primary node as well as backups on all connections in the policy.
> dataset-name-or-id |  | obj-name-or-id | Name or id of the dataset to backup.
> retention-type |  | dp-backup-retention-type optional | Retention type to which the backup version should be archived. This input is required for non-application datasets and for the application datasets with is-application-responsible-for-primary-backup set to false. If this input is specified, the specified retention type will be assigned to the backups created by the spawned job. If this input is omitted (and it is not required), the retention type of the primary backup is assigned to the replicated backups.
> Output Name | Range | Type | Description
> job-id |  | integer | Id of the job that handles the unscheduled backup of the dataset. dp-backup-progress-* apis can be used to track the progress of the backup job. Range: [1..2^31-1]

> Errno | Description
> EOBJECTNOTFOUND |  |
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> EINTERNALERROR |  |

dp-backup-version-create | [top]

> Creates a backup version. Backup version is collection of volume snapshots and denotes a single backed up image of a dataset. The management station keeps track of actual volumes that hold the dataset backup using backup versions.

> Input Name | Range | Type | Description
> backup-description |  | string optional | Description for backup version. Can be arbitrary string meaningful to the user. If provided, the new version will have this description. The length of this string cannot be more than 255 characters.
> backup-metadata |  | dfm-metadata[] optional | Opaque metadata for this backup. Metadata is usually set and interpreted by an application that is using the dataset. DFM does not look into the contents of the metadata.
> dataset-name-or-id |  | obj-name-or-id optional | Name or identifier of the dataset for the backup version.
> is-adding-members |  | boolean optional | If this input is true, Protection Manager expects more members to be added to the version-members element of this backup. The job that is transferring this backup, periodically checks to see if the new members have been added and starts transferring them. The transfer job does not exit until this input is set to false by calling dp-backup-version-modify API (or until the timeout occurs). If this input is false, the job exits after transferring any members that it could find in this backup. Any new members that got added to the backup will be transferred by the next job. This input can be used when creating a local backup potentially takes a very long time and you want the Protection Manager to start the transfers without waiting for the local backup to complete. The default value is false.
> is-complete |  | boolean optional | Indicates whether or not this backup version is a consistent backup of the dataset. The default value is true.
> is-for-propagation |  | boolean optional | Indicates whether or not this backup version should be propagated according to the data protection policy. If false, the backup version will not be propagated to other nodes. Once a backup version is created, this property can not be modified. Default value is true.
> is-native |  | boolean optional | Indicates whether or not this backup version would have been created on the same storage set if dataset had not failed over. If is-native is true, this backup version is retained according to retention settings on the node on which the backup version exists. If is-native is false, this backup version is retained according to retention settings on the DR primary node. Default value is true. When dataset has failed over to the DR secondary node, local backups are created on the DR secondary node. But these backups are retained using retention settings on the DR primary node. Server uses is-native in conjunction with retention-type to determine which retention settings to use. Examples: If is-native is true and retention-type is hourly, hourly-retention-duration and hourly-retention-count on the same node, where the backup exists, are used. If is-native is false and retention-type is daily, daily-retention-count and daily-retention-duration on the DR primary node are used.
> job-id |  | integer optional | Id of the data protection job that is invoking this API. This parameter is intended for internal use only.
> retention-type |  | string optional | Retention type that will be applied to the backup being created on the requested node. If it is not provided, the retention-type for the backup being created on the requested node will be set to 'unlimited'. Possible values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
> storageset-id |  | obj-id optional | Identifier of storage set on which this backup version exists. If the storage set is not specified, then the default is the primary storage set.
> version-members |  | version-member-info[] optional | Describes snapshot members of this backup version. Members are not required at time of creation. If omitted, version-members is set to empty.
> version-timestamp |  | dp-timestamp | Timestamp of the backup version. This corresponds to the time at which backup for the dataset started. This timestamp will be used as the identifier of this backup version and will be accepted and returned in the "backup-version" element of various APIs.
> Output Name | Range | Type | Description
> backup-id |  | integer | Integer identifier of the new backup instance. Range: [1..2^31-1] This is different from backup-version.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EDATABASEERROR |  |

dp-backup-version-delete | [top]

> Delete an existing backup version from the database and delete the snapshots from the storage systems for this backup version. The backup version must currently exist. This API does not provide transaction semantics. When API returns an error, the backup version may have been partially deleted. Error conditions: EBACKUPDOESNOTEXIST - The backup version was not found. EBACKUPBUSY - The backup version is busy. This can happen if one of the Snapshots in the backup is needed for future transfers or if transfer from the backup is in progress. EINVALIDINPUT - Not enough inputs to determine version properly. This can happen if less than three of dataset, backup-version, and node-name are used in the case where backup-id is not supplied. EACCESSDENIED - Access was denied on the requested backup version. EINTERNALERROR - An error occurred while processing the request. Try again later. EOBJECTNOTFOUND - Dataset not found.

> Input Name | Range | Type | Description
> allow-deferred-delete |  | boolean optional | If this input is true and if the backup cannot be deleted immediately, it will be marked for deletion at a later time and this API will return success. The backup will be deleted when the conditions that were preventing the backup from deletion no longer exist. For example, if the backup contains Snapshot copies needed by SnapVault or SnapMirror for future transfers, the backup will be deleted when those Snapshot copies are no longer needed. The backups which are marked for deletion will not be returned via any of the backup listing APIs. If this input is false and if the backup cannot be deleted immediately, an error will be returned. Default is false.
> backup-id |  | integer optional | Identifier of the backup instance to be deleted. Range: [1..2^31-1] This input is required unless both dataset-name-or-id and backup-version inputs are supplied.
> backup-version |  | dp-timestamp optional | Timestamp when the backup was taken. This input is required if backup-id is not present. This input should be omitted and is ignored if backup-id is present.
> dataset-name-or-id |  | obj-name-or-id optional | Name or identifier of the dataset for the backup version to be deleted. This input is required if backup-id is not present. This input should be omitted and is ignored if backup-id is present.
> delete-multiple-backups |  | boolean optional | This input is ignored if backup-id input is present or if all three of the dataset-name-or-id, backup-version and node-name are present since in both cases a single backup is identified for deletion. When both backup-id and node-name are omitted and both dataset-name-or-id and backup-version are supplied, multiple backups may produce a match. In that case, this input controls whether multiple backups that match the specified dataset-name-or-id and backup-version inputs will be deleted. If this input is true, all the matching backups will be deleted. The new callers of this API who omit both node-name and backup-id inputs are expected to use this value. If this input is false only a single backup among several matches will be deleted. API does not specify which particular backup will be picked for deletion. This behavior exists for compatibility reasons only. New callers of this API should not specify 'false' value for this input. Default is false.
> node-name |  | string optional | Name of policy node that uniquely defines the backup-id for backup version to be deleted. This input should be omitted and is ignored if backup-id is present.

> Errno | Description
> EBACKUPDOESNOTEXIST |  |
> EBACKUPBUSY |  |
> EINVALIDINPUT |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |
> EINTERNALERROR |  |

dp-backup-version-list-iter-end | [top]

> Ends iteration to list backup versions.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-backup-version-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-backup-version-list-iter-next | [top]

> Get next few records in the iteration started by dp-backup-version-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve.
> tag |  | string | Tag from a previous dp-backup-version-list-iter-start.
> Output Name | Range | Type | Description
> backup-versions |  | dp-backup-version-info[] | List of backup-versions for a given dataset.
> records |  | integer | The number of records actually returned. Range: [0..2^31-1]

> Errno | Description
> EINVALIDTAG |  |

dp-backup-version-list-iter-start | [top]

> Starts iteration to list all backup versions for a given dataset. Information returned includes the IDs of each instance, the propagation status for each version, and job Id responsible for the backup. Clients should use this API if they want a list of backup versions rather than backup instances.

> Input Name | Range | Type | Description
> backup-version |  | dp-timestamp optional validate | Timestamp when the backup was taken. Backups of the dataset that were taken at this time are listed. If this parameter is specified, volume-id, snapshot-unique-id, root-object-name-or-id and sub-path are ignored.
> dataset-name-or-id |  | obj-name-or-id | Name or id of dataset. Backups for this dataset are listed.
> 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-metadata |  | boolean optional | If true, returns metadata for the backup. If false, metadata, which can be large in size, is not returned. Default is false.
> root-object-name-or-id |  | obj-name-or-id optional | Name or id of a dataset member that is at the root of the file tree. This may be a qtree, ossv directory or volume that is the source of the physical data protection relationship. If sub path input is given then this input is required. If specified, only backups containing this object are listed. Otherwise, all backups of this dataset are listed.
> snapshot-unique-id |  | string optional | Unique id of a snapshot. This is currently the snapshot create time. If volume-id is present, then this input must be given. Ignored if volume-id is not present.
> sub-path |  | string optional | Local subpath within the dataset with regard to root-object-name-or-id. If specified, backups containing this sub path are listed. Ignored if root-object-name-or-id input is not present If the root-object-name-or-id is a volume,qtree or ossv unix directory then this sub-path is a unix-like path, ex: 'dir1/dir2/'. If the root-object-name-or-id is ossv windows directory then this sub-path is a windows path, ex : 'dir1\dir2\'. Maximum length of sub-path is 32767 characters.
> volume-id |  | obj-id optional | Id of volume that is a member of a dataset node. If this input is present then snapshot-unique-id must be present. backup-version containing this (volume-id, snapshot-unique-id) is returned. If this parameter is specified, root-object-name-or-id, sub-path are ignored.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-backup-version-list-iter-next. Range: [0..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to dp-backup-version-list-iter-next.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EBACKUPDOESNOTEXIST |  |
> EPATHDOESNOTEXIST |  |
> EINVALIDINPUT |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |

dp-backup-version-modify | [top]

> Modifies a backup version. Either the backup-id or some combination of the dataset-name-or-id, node-name-or-id and backup-version are used to specify an individual backup instance or a set of backup instances which represent the same backup version. Certain inputs, such as is-adding-members, dp-backup-transfer-info and version-members, can only be applied to a single backup instance. When a backup instance is transferred from one node to another, the attributes of the backup instance, backup-description and backup-metadata, are copied at the beginning of the transfer. Any changes to these fields made after a backup instance has been copied will not be propagated automatically. Specify only the dataset-name-or-id and backup-version to update the fields of all the backup instances with the same backup-version.

> Input Name | Range | Type | Description
> backup-description |  | string optional | Description for backup version. Can be arbitrary string meaningful to the user. The length of this string cannot be more than 255 characters.
> backup-id |  | integer optional | Identifier of the backup instance to be modified. Range: [1..2^31-1] Either the backup-id or both the dataset-name-or-id and backup-version must be specified.
> backup-metadata |  | dfm-metadata[] optional | Opaque metadata for this backup. Metadata is usually set and interpreted by an application that is using the dataset. DFM does not look into the contents of the metadata.
> backup-version |  | dp-timestamp optional | Timestamp when the backup was taken. Backups of same dataset at different locations have same version if their contents are identical. The management station keeps track of which backups have identical contents and assigns same version to them. Either the backup-id or both the dataset-name-or-id and backup-version must be specified. Ignored if backup-id is specified.
> dataset-name-or-id |  | obj-name-or-id optional | Name or identifier of the dataset for the backup version. Either the backup-id or both the dataset-name-or-id and backup-version must be specified. Ignored if backup-id is specified.
> dp-backup-transfer-info |  | dp-backup-transfer-info optional | The transfer status of the backup to a destination node. If this input is specified, either the backup-id or all three of the dataset-name-or-id, node-name-or-id, and backup-version must be specified. This input is for the internal use of the Protection Manager. Protection Manager job can modify backup-transfer-status, backup-transfer-needed or job-id elements of dp-backup-transfer-info.
> is-adding-members |  | boolean optional | Indicates whether more members are being added to the version-members element of this backup. If this input is true, Protection Manager expects more members to be added to the version-members element of this backup. The job that is transferring this backup, periodically checks to see if the new members have been added and starts transferring them. The transfer job does not exit until this input is set to false by calling dp-backup-version-modify API (or until the timeout occurs). If this input is false, the job exits after transferring any members that it could find in this backup. Any new members that got added to the backup will be transferred by the next job. This input can be used when creating a local backup potentially takes a very long time and you want the Protection Manager to start the transfers without waiting for the local backup to complete.
> is-complete |  | boolean optional | Indicates whether or not this backup version is a consistent backup of the dataset. If not specified, the value of the attribute remains unchanged.
> node-name-or-id |  | string optional | Name or id of policy node that uniquely defines the backup-id for backup version to be modified. If version-members or dp-backup-transfer-info input is specified, either the backup-id or all three of the dataset-name-or-id, node-name-or-id, and backup-version must be specified. If version-members and backup-transfer-info inputs are not specified, omitting node-name-or-id and backup-id inputs is acceptable as long as both dataset-name-or-id and backup-version are specified. In such case, the setting change will be applied to all backups with the specified backup-version. If node-name-or-id is 1, it is interpreted as root node. This is true even when there is no data protection policy attachted to the dataset. This input should be omitted and is ignored if backup-id is present.
> retention-type |  | string optional | Retention type of this version. Possible values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
> version-members |  | version-member-info[] optional | Snapshots to add to the backup. If a snapshot is already a member of the backup, do nothing. Existing members of the backup are unaffected. If this input is specified, either the backup-id or all three of the dataset-name-or-id, node-name-or-id, and backup-version must be specified.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EDATABASEERROR |  |
> EBACKUPDOESNOTEXIST |  |
> EDPPOLICYNODENOTFOUND |  |
> EACCESSDENIED |  |

dp-get-dataset-backup-jobs-data | [top]

> Returns a set of jobs to be spawned to backup the dataset. This zapi is used to obtain data that is later used to start an on-demand backup of dataset.

> Input Name | Range | Type | Description
> backup-destination |  | string optional | Destination of the dataset backup. This should be name of one of the nodes in data protection policy attached to the dataset. If primary node is specified, only local snapshot is taken. Otherwise, backup is transferred over intervening policy nodes until it reaches the specified node. If this element is not present, then local snapshot on the primary node as well as backup and mirror transfers on all connections of the policy are done.
> dataset-name-or-id |  | obj-name-or-id | Name or id of the dataset to be backed up.
> retention-type |  | dp-backup-retention-type optional | Retention type to which the backup version should be archived. This input may be required depending on the type of the dataset. See retention-type field in dp-backup-start for more information.
> Output Name | Range | Type | Description
> dp-jobs-data |  | dp-job-data[] | List of jobs that need to be started to backup this dataset. Each element will have all the details required for that job.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> EINTERNALERROR |  |

Element definition: backup-location-info | [top]

> location information for backup. Only the members which are found are returned.

> Name | Range | Type | Description
> backup-id |  | integer optional | Actual backup instance used to restore Range: [1..2^31-1]
> member-id |  | obj-id | ID of the qtree or OSSV directory. member-id is for the primary qtree or OSSV dir.
> member-name |  | obj-name | Name of the qtree or OSSV directory. member-name is for the primary qtree or OSSV dir.
> path |  | string optional | Name of the path. The maximum path length is 32767 characters. This path is relative to 'member-id' path in the storage system or OSSV host. For storage system and ossv unix hosts this is a unix-like path (ex: '/dir1/dir2'). For ossv windows host this is a windows path (ex: '\dir1\dir2').
> path-found |  | boolean | TRUE if the path is found in a backup-version. The following elements will be set only if path-found is TRUE.
> primary-snapshot-name |  | string optional | Name of the Snapshot copy on the primary where the data originated.
> primary-snapshot-unique-id |  | string optional | Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
> secondary-qtree-id |  | obj-id optional | ID of the secondary qtree which is protecting the member-id.
> secondary-qtree-name |  | obj-name optional | Name of the secondary qtree which is protecting the member-id.
> snapshot-name |  | string optional | Name of the snapshot in the backup which contains the backup of the member.
> storage-system-id |  | obj-id optional | ID of the storage system on which the secondary Snapshot copy resides. Always present in the output if the path is found.
> storage-system-name |  | obj-name optional | Name of the storage system on which the secondary Snapshot copy resides. Always present in the output if the path is found.
> volume-id |  | obj-id optional | Identifier of the volume on which the snapshot resides.

Element definition: dfm-metadata | [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-backup-content-info | [top]

> Information about contents of a backup of dataset.

> Name | Range | Type | Description
> dp-file-info |  | dp-file-info optional | Information about file (or directory etc.) in a backup. This element will not be present in case of top-level contents.
> primary-snapshot-name |  | string optional | Name of the Snapshot copy on the primary where the data originated.
> primary-snapshot-unique-id |  | string optional | Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This can be used to differentiate between versions of the same file in the same backup.
> root-object-id |  | obj-id optional | Id of a dataset member that is at the root of the file tree. This may be qtree, ossv directory or volume that is source of the physical data protection relationship.
> root-object-name |  | string optional | Object name for root-object-id.
> root-object-type |  | string optional | Object type for root-object-id. Possible values: 'qtree', 'directory', 'volume', 'virtual_machine'.

Element definition: dp-backup-info | [top]

> Backup is a single backed up image of a dataset. If backup is too large to fit on a single volume, the management station uses multiple volumes in the same storageset. In such cases, a single backup may span multiple volumes in a single storageset. The management station keeps track of actual volumes that hold the backup. Caller can identify backup by its numeric identifier.

> Name | Range | Type | Description
> backup-description |  | string optional | User specified description of backup for unscheduled backup started by dp-backup-start. The maximum length of this string is 255 characters.
> backup-id |  | integer | Identifier of the backup instance. The management station assigns a unique id to each backup instance. Range: [1..2^31-1]
> backup-metadata |  | dfm-metadata[] optional | Opaque metadata for the backup. Metadata is usually set and interpreted by an application that is using the dataset. DFM does not look into the contents of the metadata.
> backup-transfer-infos |  | dp-backup-transfer-info[] | Indicates the transfer status of this backup to each of the destination nodes directly connected to the node on which this backup exists.
> backup-transfer-status |  | string optional | This field has been deprecated, use backup-transfer-infos instead. Indicates the transfer status of this backup. This field is meant for internal use. It is set by backup transfer job only for backups on the Primary node of an application dataset. Possible values: 'transferring', 'transferred', 'transfer_failed', and ''.
> backup-version |  | dp-timestamp | Timestamp when the backup was taken. Backups of same dataset at different locations have same version if their contents are identical. The management station keeps track of which backups have identical contents and assigns same version to them. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> is-adding-members |  | boolean | Indicates whether more members are being added to the version-members element of this backup. If this element is true, Protection Manager expects more members to be added to the version-members element of this backup. The job that is transferring this backup, periodically checks to see if the new members have been added and starts transferring them. The transfer job does not exit until this input is set to false by calling dp-backup-version-modify API (or until the timeout occurs). If this element is false, the job exits after transferring any members that it could find in this backup. Any new members that got added to the backup will be transferred by the next job. This element can be used when creating a local backup potentially takes a very long time and you want the Protection Manager to start the transfers without waiting for the local backup to complete.
> is-for-propagation |  | boolean optional | Indicates whether or not this backup version should be propagated according to the data protection policy. If false, the backup version will not be propagated to other nodes. Default value is true.
> node-id |  | integer optional | Id of policy node that corresponds to the storageset that holds backup. May not be present if policy has been modified in such a way that storageset has no corresponding node in policy. It may be possible to restore contents from such orphaned backup if the physical relationships continue to exist. The node-id values start at 1. The node id of the primary node is always 1.
> node-name |  | string optional | Name of policy node that corresponds to the storageset that holds backup. May not be present if policy has been modified in such a way that storageset has no corresponding node in policy. It may be possible to restore contents from such orphaned backup if the physical relationships continue to exist.
> retention-type |  | dp-backup-retention-type | Type of retention for the backup.
> supports-non-disruptive-restore |  | requires-non-disruptive-restore | Indicates whether a non disruptive restore is possible from this backup version. If true then non disruptive restore is possible.
> version-members |  | version-member-info[] | describes snapshot members of this backup version.

Element definition: dp-backup-path-info | [top]

> Information about backup path

> Name | Range | Type | Description
> member-id |  | obj-id optional | The qtree or OSSV dir ID. Either member-id or member-name must be supplied. If member-id is supplied member-name should not be supplied.
> member-name |  | obj-name optional | The qtree or OSSV dir name. Either member-id or member-name must be supplied. member-name is only used if member-id is not supplied
> path |  | string optional | Name of the path. The maximum path length is 32767 characters. This path is relative to 'member-id' path in the storage system or OSSV host. For storage system and ossv unix hosts this is a unix-like path (ex: '/dir1/dir2'). For ossv windows host this is a windows path (ex: '\dir1\dir2').
> primary-snapshot-name |  | string optional | Name of the Snapshot copy on the primary where the data originated. This is ignored if primary-snapshot-unique-id is specified.
> primary-snapshot-unique-id |  | string optional | Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This should be specified when member exists in more than one Snapshot copies in the same backup.

Element definition: dp-backup-retention-type | [top]

> Retention type to which the backup should be archived. Possible values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

> [none]

Element definition: dp-backup-transfer-info | [top]

> Indicates the transfer status of the backup between the two nodes directly connected to each other. When present in the input, you must specify at least one of destination-storageset-id, destination-node-name or destination-node-id.

> Name | Range | Type | Description
> backup-transfer-needed |  | boolean optional | Indicates if the backup needs to be transferred to the destination storage set. This field is for internal use by the Protection Manager.
> backup-transfer-status |  | string optional | Indicates the transfer status of the backup to the destination node. Possible values: 'transferring', 'transferred', 'transfer_failed', and ''. 'transferring' indicates that a job is currently transferring the backup to the destination node. 'transferred' indicates that backup was successfully transferred to the destination node. '' indicates that no transfer has started. In the case of a mirror relationship, transfer_failed is not a terminal state. The transfer could be retried as part of a subsequent mirror update.
> connection-type |  | string optional | Type of the policy connection between source and destination nodes. Possible values: 'backup', 'mirror'. Present in the output only. Ignored if present in the input. May not be present in the output if the policy connection could not be found.
> destination-backup-id |  | integer optional | Identifier of backup on the destination node. Present in the output only. Ignored if specified in the input. May not be present in the output if the backup version does not exist on the destination node yet. Range: [1..2^31-1]
> destination-node-id |  | integer optional | ID of destination node in the data protection policy that corresponds to the destination storage set. May not be present in the output if the destination storage set cannot be mapped to any node in the policy. Range: [1..2^31-1].
> destination-node-name |  | string optional | Name of destination node in the data protection policy that corresponds to the destination storage set. May not be present in the output if the destination storage set cannot be mapped to any node in the policy.
> destination-storageset-id |  | integer optional | ID of the destination storage set. Range: [1..2^31-1].
> job-id |  | integer optional | Identifier for the job that is transferring or has transferred this backup to the destination storage set.
> source-backup-id |  | integer optional | Identifier of backup on the source node. Present in the output only. Ignored if specified in the input. Range: [1..2^31-1]
> source-node-id |  | integer optional | ID of source node in the data protection policy that corresponds to the source storage set. Present in the output only. Ignored if specified in the input. May not be present in the output if the source storage set cannot be mapped to any node in the policy. Range: [1..2^31-1].
> source-node-name |  | string optional | Name of source node in the data protection policy that corresponds to the source storage set. Present in the output only. Ignored if specified in the input. May not be present in the output if the destination storage set cannot be mapped to any node in the policy.
> source-storageset-id |  | integer optional | ID of the source storage set. Present in the output only. Ignored if specified in the input. Range: [1..2^31-1].

Element definition: dp-backup-version-info | [top]

> Backup-version information including list of all instances of this version.

> Name | Range | Type | Description
> backup-description |  | string optional | Description for the backup. It may be any arbitrary string meaningful to the agent spawning the backup. The maximum length of this string is 255 characters.
> backup-id-infos |  | dp-backup-id-info[] | List of backup instances.
> backup-transfer-infos |  | dp-backup-transfer-info[] | Indicates the transfer status of this backup version between each pairs of the source and destination nodes which have direct connection in the data protection policy.
> backup-version |  | dp-timestamp | Timestamp when the backup was taken. Backups of same dataset at different locations have same version if their contents are identical. The management station keeps track of which backups have identical contents and assigns same version to them. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> is-fully-propagated |  | boolean | Indicates that this version is a complete backup of the dataset on all nodes specified by the protection policy.
> retention-type |  | dp-backup-retention-type | Type of retention for the backup.
> version-members |  | version-member-info[] | Describes snapshot members of this backup version.

Element definition: dp-job-data | [top]

> Describes an unscheduled data protection job. Type of job is specified in dp-job-type element. Only one of all possible dp-*-job-data elements can be present.

> Name | Range | Type | Description
> dataset-id |  | obj-id | Id of the dataset being protected by the job.
> dp-job-type |  | string | Type of the dp job. Possible values: 'snapvault', 'snapmirror' and 'local_snapshot'.
> dp-local-snapshot-job-data |  | dp-local-snapshot-job-data optional | Data for local-snapshot job.
> dp-snapmirror-transfer-job-data |  | dp-snapmirror-transfer-job-data optional | Data for snapmirror-transfer job.
> dp-snapvault-transfer-job-data |  | dp-snapvault-transfer-job-data optional | Data for snapvault-transfer job.

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: 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. dataset, 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-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. dataset, 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: version-member-info | [top]

> Describes one snapshot member of a backup version.

> Name | Range | Type | Description
> is-available |  | boolean optional | Whether this snapshot is available for a restore. A snapshot is considered available if the containing filer is responding to ping requests and the containing volume is online. These values will be based on information returned by the most recent DFM pass, not by querying the filer in real-time.
> snapshot-contents |  | snapshot-member-info[] | Contents of the snapshot.
> snapshot-name |  | string | Name of the snapshot.
> snapshot-unique-id |  | string | Unique id of the snapshot. currently this is snapshot creation time.
> volume-id |  | obj-id optional | Always included in output, either volume-id or volume-name must be specified in input. ID of the volume corresponding to member snapshot.
> volume-name |  | obj-name optional | Always included in output, either volume-id or volume-name must be specified in input. The name of the volume this Snapshot resides on.

Element definition: dfm-metadata | [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-backup-id-info | [top]

> Backup-version instance information including id and node name for this version.

> Name | Range | Type | Description
> backup-id |  | integer | Identifier of the backup instance. The management station assigns a unique id to each backup instance. Range: [1..2^31-1]
> backup-metadata |  | dfm-metadata[] optional | Opaque metadata for the backup. Metadata is usually set and interpreted by an application that is using the dataset. DFM does not look into the contents of the metadata.
> job-id |  | integer | Identifier for the job creating this backup.
> node-id |  | integer | ID of the node in the data protection policy. Range: [1..2^31-1].
> node-name |  | string optional | Name of policy node that corresponds to the storage set that holds backup. May not be present if a different policy has been associated with this dataset, and the storage set containing this backup has no corresponding node in the current policy. It may be possible to restore contents from such orphaned backups if the physical relationships continue to exist.

Element definition: dp-backup-retention-type | [top]

> Retention type to which the backup should be archived. Possible values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

> [none]

Element definition: dp-backup-transfer-info | [top]

> Indicates the transfer status of the backup between the two nodes directly connected to each other. When present in the input, you must specify at least one of destination-storageset-id, destination-node-name or destination-node-id.

> Name | Range | Type | Description
> backup-transfer-needed |  | boolean optional | Indicates if the backup needs to be transferred to the destination storage set. This field is for internal use by the Protection Manager.
> backup-transfer-status |  | string optional | Indicates the transfer status of the backup to the destination node. Possible values: 'transferring', 'transferred', 'transfer_failed', and ''. 'transferring' indicates that a job is currently transferring the backup to the destination node. 'transferred' indicates that backup was successfully transferred to the destination node. '' indicates that no transfer has started. In the case of a mirror relationship, transfer_failed is not a terminal state. The transfer could be retried as part of a subsequent mirror update.
> connection-type |  | string optional | Type of the policy connection between source and destination nodes. Possible values: 'backup', 'mirror'. Present in the output only. Ignored if present in the input. May not be present in the output if the policy connection could not be found.
> destination-backup-id |  | integer optional | Identifier of backup on the destination node. Present in the output only. Ignored if specified in the input. May not be present in the output if the backup version does not exist on the destination node yet. Range: [1..2^31-1]
> destination-node-id |  | integer optional | ID of destination node in the data protection policy that corresponds to the destination storage set. May not be present in the output if the destination storage set cannot be mapped to any node in the policy. Range: [1..2^31-1].
> destination-node-name |  | string optional | Name of destination node in the data protection policy that corresponds to the destination storage set. May not be present in the output if the destination storage set cannot be mapped to any node in the policy.
> destination-storageset-id |  | integer optional | ID of the destination storage set. Range: [1..2^31-1].
> job-id |  | integer optional | Identifier for the job that is transferring or has transferred this backup to the destination storage set.
> source-backup-id |  | integer optional | Identifier of backup on the source node. Present in the output only. Ignored if specified in the input. Range: [1..2^31-1]
> source-node-id |  | integer optional | ID of source node in the data protection policy that corresponds to the source storage set. Present in the output only. Ignored if specified in the input. May not be present in the output if the source storage set cannot be mapped to any node in the policy. Range: [1..2^31-1].
> source-node-name |  | string optional | Name of source node in the data protection policy that corresponds to the source storage set. Present in the output only. Ignored if specified in the input. May not be present in the output if the destination storage set cannot be mapped to any node in the policy.
> source-storageset-id |  | integer optional | ID of the source storage set. Present in the output only. Ignored if specified in the input. Range: [1..2^31-1].

Element definition: dp-file-info | [top]

> Information about file, directory, qtree, drive etc. on a primary host or in a backup.

> Name | Range | Type | Description
> child-count |  | integer | Count of children. This is zero when value of file-type element is 'file'. Otherwise, it can be zero or non-zero. Range: [0..2^31-1]
> file-name |  | string | Name of the file.
> file-size |  | integer optional | Size of file in bytes. Range: [0..2^64-1]
> file-type |  | string | Type of the file. Possible values: 'file', 'directory', 'qtree', 'volume', 'drive', 'fifo', 'cspec', 'bspec', 'symlink', 'socket', 'registry', 'stream', 'lun', and 'other'.
> is-empty |  | boolean optional | This element is present only if the file-type is a directory and the version of ONTAP on the storage systems in 7.3.2 and higher. For all other cases, this element will be absent. It determines if the directory is is an empty directory. The value of the element is TRUE is directory is empty, it is FALSE otherwise. Directory is considered empty if it only contains entries for "." and ".."
> last-modified-timestamp |  | integer optional | Timestamp when the file was last modified. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.

Element definition: dp-local-snapshot-job-data | [top]

> Data for local-snapshot job. If this element is present, job is responsible for taking a local snapshot of data on the storageset associated with the specified node.

> Name | Range | Type | Description
> is-confirmation-data |  | boolean optional | If the element: "is-confirmation-data" is set to 'true', this job only confirms backups have been created on the primary node. An external agent, such as a SnapManager/SnapDrive, is responsible for creating these backups. This element can only be true for application data sets. If set to true, the job type will be "local_backup_confirmation" and the job will update the protection status without creating a local backup.
> node-id |  | integer | Id of the node that needs local snapshot. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the local snapshot.

Element definition: dp-snapmirror-transfer-job-data | [top]

> Data for snapmirror-transfer job. If this element is present, job is responsible for transferring data between two storagesets associated with the specified connection using SnapMirror protocol.

> Name | Range | Type | Description
> connection-id |  | integer | Id of the policy connection that needs SnapMirror transfer. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the pre/post backup script in the snapmirror-transfer job only.

Element definition: dp-snapvault-transfer-job-data | [top]

> Data for snapvault-transfer job. If this element is present, job is responsible for transferring data between two storagesets associated with the specified connection using SnapVault protocol.

> Name | Range | Type | Description
> connection-id |  | integer | Id of the policy connection that needs SnapVault transfer. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the backup created by snapvault-transfer job.

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. dataset, 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 built in ZAPI type string. An object name must conform to the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all. The behavior of a ZAPI when it encounters an error involving an 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 datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an 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: requires-non-disruptive-restore | [top]

> When this attribute is set, the dataset is configured to allow LUNs to be restored from backups in such a way that the host need not detach from the LUN. Configuring the dataset for non-disruptive restore does not guarantee that all backup instances may be restored non-disruptively. It only applies to backup instances reached through a Backup connection. The caller must check the 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 dataset. All Backup connections will be implemented using SnapVault, not Qtree SnapMirror. All non-primary storage systems used by the data set must have a SnapVault Secondary license. If any of these constraints is not met when adding a member to the dataset, the dataset will not be in conformance and the addition will generate conformance errors. Addition of members with ONTAP version less than 7.3 to the primary node of the dataset will fail with errors. requires-nondisruptive-restore may only be specified if: No Backup connection in the protection policy used by the dataset is DR capable (i.e. the is-dr-capable attribute may not be set for any Backup connection of the policy). The dataset must be an application dataset. 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 datasets requiring non-disruptive restores.

> [none]

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

> Information of one qtree or ossv dir that is in snapshot.

> Name | Range | Type | Description
> primary-id |  | obj-id optional | Always returned on output, either primary-id or primary-name must be specified on input. Primary qtree or OSSV directory ID.
> primary-name |  | obj-name optional | Always returned on output, either primary-id or primary-name must be specified on input. The name of a qtree or OSSV directory whose data is in the Snapshot.
> primary-snapshot-name |  | string optional | Name of the Snapshot copy on the primary where the data originated.
> primary-snapshot-unique-id |  | string optional | Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
> secondary-qtree-id |  | obj-id optional | Corresponding secondary qtree id. This legacy parameter if supplied along with secondary-qtree-name-or-id will be ignored unless it references a different qtree in which case an error will be returned. Not included if the backup version consists of local snapshots.
> secondary-qtree-name |  | string optional | Corresponding secondary qtree name. This is ignored on input. Use secondary-qtree-name-or-id to specify by name. On output this will be returned along with secondary-qtree-id. Not included if the backup version consists of local snapshots.
> secondary-qtree-name-or-id |  | string optional | Corresponding secondary qtree name or identifier. This is used to lookup the secondary-qtree-id if present. If this is present, secondary-qtree-id will be ignored. Not included if the backup version consists of local snapshots.

Element definition: dfm-metadata | [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-backup-retention-type | [top]

> Retention type to which the backup should be archived. Possible values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

> [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. dataset, 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 built in ZAPI type string. An object name must conform to the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all. The behavior of a ZAPI when it encounters an error involving an 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 datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an 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]