Input Name	Type
DpBackupContentListIterEnd	DpBackupContentListIterEnd
Output Name	Type
DpBackupContentListIterEndResult	DpBackupContentListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpBackupContentListIterStart.

Input Name	Type
DpBackupContentListIterNext	DpBackupContentListIterNext
Output Name	Type
DpBackupContentListIterNextResult	DpBackupContentListIterNextResult

Error Name	Description
EINVALIDTAG

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	Type
DpBackupContentListIterStart	DpBackupContentListIterStart
Output Name	Type
DpBackupContentListIterStartResult	DpBackupContentListIterStartResult

Error Name	Description
EBACKUPDOESNOTEXIST
EBACKUPLOCATIONDOESNOTEXIST
EPATHDOESNOTEXIST

Given a BackupId or the BackupVersion 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-d or BackupVersion, 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	Type
DpBackupGetLocation	DpBackupGetLocation
Output Name	Type
DpBackupGetLocationResult	DpBackupGetLocationResult

Ends iteration To list Backups.

Input Name	Type
DpBackupListIterEnd	DpBackupListIterEnd
Output Name	Type
DpBackupListIterEndResult	DpBackupListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpBackupListIterStart.

Input Name	Type
DpBackupListIterNext	DpBackupListIterNext
Output Name	Type
DpBackupListIterNextResult	DpBackupListIterNextResult

Error Name	Description
EINVALIDTAG

Starts iteration To list Backups of a Dataset or a Path within Dataset.

Input Name	Type
DpBackupListIterStart	DpBackupListIterStart
Output Name	Type
DpBackupListIterStartResult	DpBackupListIterStartResult

Error Name	Description
EACCESSDENIED
EBACKUPDOESNOTEXIST
EDATABASEERROR
EINVALIDINPUT
EOBJECTNOTFOUND
EPATHDOESNOTEXIST

Mount a backup containing virtual infrastructure Objects such as VMs or Datastores. A background job will be started for this Operation.

Input Name	Type
DpBackupMountStart	DpBackupMountStart
Output Name	Type
DpBackupMountStartResult	DpBackupMountStartResult

Error Name	Description
EACCESSDENIED
EBACKUPDOESNOTEXIST
EBACKUP_ALREADY_MOUNTED
EDATABASEERROR
EINVALIDINPUTERROR
EOBJECTNOTFOUND

Start an unscheduled backup of a Dataset. All Members or a subset of the Dataset will be backed up. A background job will be spawned To backup the Dataset.

Input Name	Type
DpBackupStart	DpBackupStart
Output Name	Type
DpBackupStartResult	DpBackupStartResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDINPUT
ENOTINDATASET
EOBJECTNOTFOUND
EUNUSEDAPPLICATIONOBJECTSETTING

Unmount a mounted backup. A background job is started for this Operation.

Input Name	Type
DpBackupUnmountStart	DpBackupUnmountStart
Output Name	Type
DpBackupUnmountStartResult	DpBackupUnmountStartResult

Error Name	Description
EACCESSDENIED
EBACKUP_NOT_MOUNTED
EDATABASEERROR
EINVALIDINPUTERROR
EOBJECTNOTFOUND

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	Type
DpBackupVersionCreate	DpBackupVersionCreate
Output Name	Type
DpBackupVersionCreateResult	DpBackupVersionCreateResult

Error Name	Description
EDATABASEERROR
EINVALIDINPUT
EOBJECTNOTFOUND

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 and must not be mounted. 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. EBACKUP_ALREADY_MOUNTED - The backup Version is either being mounted or has already been successfully mounted. EINVALIDINPUT - Not enough inputs To determine Version properly. This can happen if less than three of Dataset, BackupVersion, and NodeName are used in the case where BackupId 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	Type
DpBackupVersionDelete	DpBackupVersionDelete
Output Name	Type
DpBackupVersionDeleteResult	DpBackupVersionDeleteResult

Error Name	Description
EACCESSDENIED
EBACKUPBUSY
EBACKUPDOESNOTEXIST
EBACKUP_ALREADY_MOUNTED
EDATABASEERROR
EINTERNALERROR
EINVALIDINPUT
EOBJECTNOTFOUND

Ends iteration To list backup versions.

Input Name	Type
DpBackupVersionListIterEnd	DpBackupVersionListIterEnd
Output Name	Type
DpBackupVersionListIterEndResult	DpBackupVersionListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpBackupVersionListIterStart.

Input Name	Type
DpBackupVersionListIterNext	DpBackupVersionListIterNext
Output Name	Type
DpBackupVersionListIterNextResult	DpBackupVersionListIterNextResult

Error Name	Description
EINVALIDTAG

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	Type
DpBackupVersionListIterStart	DpBackupVersionListIterStart
Output Name	Type
DpBackupVersionListIterStartResult	DpBackupVersionListIterStartResult

Error Name	Description
EACCESSDENIED
EBACKUPDOESNOTEXIST
EDATABASEERROR
EINVALIDINPUT
EOBJECTNOTFOUND
EPATHDOESNOTEXIST

Modifies a backup Version. Either the BackupId or some combination of the DatasetNameOrId, NodeNameOrId and BackupVersion are used To specify an individual backup Instance or a set of backup Instances which represent the same backup Version. Certain inputs, such as IsAddingMembers, DpBackupTransferInfo and VersionMembers, 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, BackupDescription and BackupMetadata, 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 DatasetNameOrId and BackupVersion To update the fields of all the backup Instances with the same BackupVersion.

Input Name	Type
DpBackupVersionModify	DpBackupVersionModify
Output Name	Type
DpBackupVersionModifyResult	DpBackupVersionModifyResult

Error Name	Description
EACCESSDENIED
EBACKUPDOESNOTEXIST
EDATABASEERROR
EDPPOLICYNODENOTFOUND
EINVALIDINPUT
EOBJECTNOTFOUND

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	Type
DpGetDatasetBackupJobsData	DpGetDatasetBackupJobsData
Output Name	Type
DpGetDatasetBackupJobsDataResult	DpGetDatasetBackupJobsDataResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDINPUT
EOBJECTNOTFOUND

Ends iteration To list file contents of a backup.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpBackupContentListIterStart.

[none]

Get next few Records in the iteration started by DpBackupContentListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve. Range: [1..2^31-1].
Tag	xsd:string	Tag From a previous DpBackupContentListIterStart.

Name	Type	Description
BackupContents	ArrayOfDpBackupContentInfo	List of files and Directories in backup.
Records	xsd:integer	The number of Records actually returned. Range: [0..2^31-1].

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.

Name	Type	Description
BackupId	xsd:integer	Id of backup Instance whose file contents are To be listed. Use DpBackupListIterStart To retrieve valid backup ids. Range: [1..2^31-1]
PrimarySnapshotName	xsd:string optional	Name of the Snapshot copy on the primary where the data originated. This field is ignored if the RootObjectNameOrId is omitted. It is also ignored, if PrimarySnapshotUniqueId is specified.
PrimarySnapshotUniqueId	xsd: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 RootObjectNameOrId is omitted.
RootObjectNameOrId	xsd: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.
SubPath	xsd:string optional	Local subpath within the Dataset with regard To RootObjectNameOrId. If specified, backup contents directly under this sub Path are listed. Otherwise, backup contents directly under the specified root-object are listed. Ignored if RootObjectNameOrId input is not present If the RootObjectNameOrId is a Volume, Qtree or ossv unix Directory then this SubPath is a unix-like Path, ex: 'dir1/dir2/'. If the RootObjectNameOrId is ossv windows Directory then this SubPath is a windows Path, ex : 'dir1\\dir2\\'. Maximum Length of SubPath is 32767 characters.
SuppressChildCount	xsd: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.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpBackupContentListIterNext. Range: [0..2^31-1]
Tag	xsd:string	Tag To be used in subsequent calls To DpBackupContentListIterNext.

Given a BackupId or the BackupVersion 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-d or BackupVersion, 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.

Name	Type	Description
BackupId	xsd:integer optional	Identifier of the backup Instance. Range: [1..2^31-1]
BackupVersion	DpTimestamp optional	Timestamp of the backup Version.
DatasetNameOrId	ObjNameOrId optional	Name or ID of the Dataset To which this backup Version belongs To. This parameter is ignored in case of BackupId parameter in the input.
Paths	ArrayOfDpBackupPathInfo	Path information about backup

Name	Type	Description
BackupLocations	ArrayOfBackupLocationInfo	Location information for the backup.

Ends iteration To list Backups.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpBackupListIterStart.

[none]

Get next few Records in the iteration started by DpBackupListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve.
Tag	xsd:string	Tag From a previous DpBackupListIterStart.

Name	Type	Description
Backups	ArrayOfDpBackupInfo	List of Backups.
Records	xsd:integer	The number of Records actually returned. Range: [0..2^31-1]

Starts iteration To list Backups of a Dataset or a Path within Dataset.

Name	Type	Description
ApplicationResourceNamespace	ApplicationResourceNamespace optional	Name of the application Resource namespace. If HasApplicationResourcesOnly is true, then (HasApplicationResourcesOnly, ApplicationResourceNamespace) is used To load Backups, specific To a Resource namespace. Ignored if HasApplicationResourcesOnly is false. If not specified, when has-application-resource-namespace is true, then all Backups containing application resources are returned.
BackupId	xsd:integer optional	Id of backup Instance whose information is To be listed. If this parameter is specified BackupVersion, VolumeId, SnapshotUniqueId, RootObjectNameOrId, SubPath, ApplicationResourceNamespace and SearchKeys parameters are ignored. Range: [1..2^31-1]
BackupVersion	DpTimestamp optional	Timestamp when the backup was taken. Backups of the Dataset that were taken at this time is listed. If this parameter is specified, VolumeId, SnapshotUniqueId, RootObjectNameOrId, SubPath, ApplicationResourceNamespace and SearchKeys are ignored.
DatasetNameOrId	ObjNameOrId optional	Name or Id of Dataset. Backups for this Dataset are listed. If this is not given, then all Backups for all Datasets will be returned, the BackupId, BackupVersion, VolumeId fields are ignored.
HasApplicationResourcesOnly	xsd:boolean optional	If true, returns Backups containing only application resources From Host services and plugins. Can be true, only if HasStorageResourcesOnly is false. Default is false.
HasStorageResourcesOnly	xsd:boolean optional	If true, returns Backups containing only storage entities. Can be true, only if HasApplicationResourcesOnly is false. Default is false.
IncludeBackupGraphInfo	xsd:boolean optional	If true, the BackupGraphInfo is returned in the output. Otherwise, BackupGraphInfo is omitted To improve performance. Default is true.
IncludeIsAvailable	xsd:boolean optional	If true, the IsAvailable Status is calculated for each member which may make the call To this zapi take much longer. Default is false.
IncludeMetadata	xsd:boolean optional	If true, returns metadata for the backup. If false, metadata, which can be large in Size, is not returned. Default is false. Ignored if IncludeMetadataHostService is specified.
IncludeMetadataHostService	ObjNameOrId optional	Name or object identifier of the Host Service for the backup metadata. If specified, only the backup metadata of the given Host Service are listed, and IncludeMetadata is ignored.
IsMounted	xsd:boolean optional	If true, return Backups that are either mounted, being mounted or being unmounted. If false, this input will not be used as filtering criterion while listing Backups. Ignored if either BackupId, BackupVersion, or SearchKeys are specified. Default is false.
IsRootObjectRestorable	xsd:boolean optional	If RootObjectNameOrId is given, and this is TRUE, only the Backups From which the root-object is restorable will be returned. Default is FALSE. This is ignored if RootObjectNameOrId is not given.
RootObjectNameOrId	ObjNameOrId optional	Name or Id of a Dataset member. This may be either be an application object such as VM or a Datastore or it can be a Qtree, ossv Directory or Volume. If sub Path input is given then this input is required. However, sub Path input cannot be specified if this input represents an application object. If specified, Backups containing this object are listed. Otherwise, all Backups of this Dataset are listed. If DatasetNameOrId is not specified, all Backups containing this root object across all Datasets will be listed.
SearchKeys	ArrayOfSearchKey optional	Keys To search the Backups by. If any of the given search keys matchs a backup, the backup will be returned. If BackupId, BackupVersion, VolumeId, SnapshotUniqueId, RootObjectNameOrId, or SubPath is specified, this field is ignored. If DatasetNameOrId is not specified, Backups are searched across all the Datasets, otherwise search is limited To only the specified Dataset.
SnapshotUniqueId	xsd:string optional	Unique Id of a Snapshot. If VolumeId is present, then this input must be given. Ignored if VolumeId is not present.
SubPath	xsd:string optional	Local subpath within the Dataset with regard To RootObjectNameOrId. If specified, Backups containing this sub Path are listed. Ignored if RootObjectNameOrId input is not present or if RootObjectNameOrId represents an application object such as a VM or a Datastore. If the RootObjectNameOrId is a Volume, Qtree or ossv unix Directory then this SubPath is a unix-like Path, ex: 'dir1/dir2/'. If the RootObjectNameOrId is ossv windows Directory then this SubPath is a windows Path, ex : 'dir1\dir2\'. Maximum Length of SubPath is 32767 characters.
VolumeId	ObjId optional	Id of Volume that is member of a Dataset node. If this input is present then SnapshotUniqueId must be present. BackupVersion containing this (VolumeId, SnapshotUniqueId) is returned. If this parameter is specified, RootObjectNameOrId, SubPath, ApplicationResourceNamespace and SearchKeys are ignored.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpBackupListIterNext. Range: [0..2^31-1]
Tag	xsd:string	Tag To be used in subsequent calls To DpBackupListIterNext.

Mount a backup containing virtual infrastructure Objects such as VMs or Datastores. A background job will be started for this Operation.

Name	Type	Description
BackupId	xsd:integer	Identifier of the backup that is To be mounted. Range: [1..2^31-1]
HostNameOrId	ObjNameOrId	Name of the Host on which the backup is mounted.

Name	Type	Description
JobId	xsd:integer	Id of the job that handles the mounting Operation. All Host services progress/status information will be logged in this job. Range: [1..2^31-1]
MountId	xsd:integer	Id of the mount session. This can be used To unmount the backup. Range: [1..2^31-1]

Start an unscheduled backup of a Dataset. All Members or a subset of the Dataset will be backed up. A background job will be spawned To backup the Dataset.

Name	Type	Description
BackupDescription	xsd: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.
BackupDestination	xsd:string optional	This field is deprecated in favor of BackupDestinationNameOrId. Destination node Name of the backup. This legacy parameter is ignored if BackupDestinationNameOrId is supplied. Please see input BackupDestinationNameOrId for the Description of how this node Name will be used.
BackupDestinationNameOrId	xsd:string optional	Destination of the backup. For a Dataset with an associated data protection Policy, this may be the Name or Id of one of the nodes in the data protection Policy associated with the Dataset directly or through the storage Service. If the Name or Id 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 destination with this node Name or Id. If no node Name or Id is provided, and there is an associated data protection Policy for the Dataset, the management station takes local Snapshots on the primary node as well as Backups on all connections in the Policy. A Value of 1 is used for the root node of the Dataset. If both BackupDestination and BackupDestinationNameOrId are specified, then BackupDestinationNameOrId will take precedence over BackupDestination.
BackupMembers	ArrayOfObjNameOrId optional	One or more Dataset Members which should be included in the backup. If this input is not supplied, all Members of the Dataset will be backed up. This input is valid only for the Datasets containing application Objects such as Hyper-V VMs or VMware VMs. If supplied for a Dataset not containing application Objects, EUNUSEDAPPLICATIONOBJECTSETTING is returned. Specification of a member that is not part of the Dataset generates an Error of Type ENOTINDATASET.
BackupScript	xsd:string optional	Name of the script To invoke on the Host Services station both before and after the backup. This script is only used for Datasets containing application Objects such as Hyper-V VMs or VMware VMs and if supplied on other Datasets will generate an Error of EUNUSEDAPPLICATIONOBJECTSETTING. The BackupScript consists of 0 To 255 characters. An empty string Value "" indicates no script is invoked. The default Value of this property is the empty string "". The system does not check whether a non-empty Path string actually refers To an executable script prior To attempting To run the script. The default Value of this property is the empty string "". For example, possible Values are %env%\scripts\backup.ps1 OR c:\program..\HS\scripts\backup.ps1 OR k:\program..\HS\scripts\backup.ps1 [k is a network share] OR UNC Path \\SCRIPTSSVR\SHARE\SCRIPTS\BACKUP.PS
DatasetNameOrId	ObjNameOrId	Name or Id of the Dataset To backup.
HypervBackupSettingsInfo	WrapperOfHypervBackupScheduleSettingsInfo optional	Hyper-V specific settings for the backup Operation. These settings apply To this backup only. When backing up Hyper-V Objects, this input can be used To specify the Hyper-V Plugin settings.
RetentionDuration	xsd:integer optional	The age, in seconds, after which this backup expires. When this input is not present for Datasets that are associated with a data protection Policy, the RetentionDuration for this one backup will be determined by the data protection Policy. When RetentionType is omitted the the Value of RetentionDuration will determine the RetentionType as shown below. 'hourly' if less than 24 hours 'daily' if 1 Day up To and not including 1 week 'weekly' if 1 week up To and not including 31 Days 'monthly' if 31 Days or longer. At least one of RetentionType or RetentionDuration is required unless the Dataset is an application Dataset with IsApplicationResponsibleForPrimaryBackup set To true. In the latter case, both can be omitted. If present, it should be a non-zero Value. Range: [1..2^31 - 1].
RetentionType	DpBackupRetentionType optional	Retention Type To which the backup Version should be archived. At least one of RetentionType or RetentionDuration is required unless the Dataset is an application Dataset with IsApplicationResponsibleForPrimaryBackup set To true. In the latter case, both can be omitted. If this input is specified, the specified Retention Type will be assigned To the Backups created by this Operation. This applies To all types of Datasets including the application Datasets with IsApplicationResponsibleForPrimaryBackup set To true. If this input is omitted for an application Dataset and if IsApplicationResponsibleForPrimaryBackup is true, the Retention Type of the primary backup is assigned To the replicated Backups. If this input is omitted in any of the other cases, Retention Type will be determined From RetentionDuration as specified in the RetentionDuration definition that follows.
VmwareBackupSettingsInfo	WrapperOfVmwareBackupScheduleSettingsInfo optional	VMware specific settings for the backup Operation. These settings apply To this backup only. When backing up VMware Objects, this input can be used To specify the VMware Plugin settings.

Name	Type	Description
JobId	xsd:integer	Id of the job that handles the unscheduled backup of the Dataset. DpJobProgressEventListIter* apis can be used To track the progress of the backup job. Range: [1..2^31-1]

Unmount a mounted backup. A background job is started for this Operation.

Name	Type	Description
MountId	xsd:integer	Id of the backup mount session. Range: [1..2^31-1]

Name	Type	Description
JobId	xsd:integer	Id of the job that handles the backup unmounting Operation. All the progress/status information will be logged in this job. Range: [1..2^31-1]

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.

Name	Type	Description
BackupDescription	xsd: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.
BackupMetadata	ArrayOfDfmMetadata 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.
DatasetNameOrId	ObjNameOrId optional	Name or identifier of the Dataset for the backup Version.
IsAddingMembers	xsd:boolean optional	If this input is true, Protection Manager expects more Members To be added To the VersionMembers 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 DpBackupVersionModify 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.
IsComplete	xsd:boolean optional	Indicates whether or not this backup Version is a consistent backup of the Dataset. The default Value is true.
IsForPropagation	xsd: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.
IsNative	xsd: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 IsNative is true, this backup Version is retained according To Retention settings on the node on which the backup Version exists. If IsNative 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 IsNative in conjunction with RetentionType To determine which Retention settings To use. Examples: If IsNative is true and RetentionType is hourly, HourlyRetentionDuration and HourlyRetentionCount on the same node, where the backup exists, are used. If IsNative is false and RetentionType is daily, DailyRetentionCount and DailyRetentionDuration on the DR primary node are used.
JobId	xsd:integer optional	Id of the data protection job that is invoking this API. This parameter is intended for internal use only.
RetentionType	xsd:string optional	Retention Type that will be applied To the backup being created on the requested node. If it is not provided, the RetentionType for the backup being created on the requested node will be set To 'unlimited'. Possible Values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
StoragesetId	ObjId 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.
VersionMembers	ArrayOfVersionMemberInfo optional	Describes Snapshot Members of this backup Version. Members are not required at time of creation. If omitted, VersionMembers is set To empty.
VersionTimestamp	DpTimestamp	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 "BackupVersion" element of various APIs.

Name	Type	Description
BackupId	xsd:integer	Integer identifier of the new backup Instance. Range: [1..2^31-1] This is different From BackupVersion.

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 and must not be mounted. 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. EBACKUP_ALREADY_MOUNTED - The backup Version is either being mounted or has already been successfully mounted. EINVALIDINPUT - Not enough inputs To determine Version properly. This can happen if less than three of Dataset, BackupVersion, and NodeName are used in the case where BackupId 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.

Name	Type	Description
AllowDeferredDelete	xsd: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. If this input is true and if the backup is mounted, it will not be marked for deletion and an Error EBACKUP_ALREADY_MOUNTED will be returned. 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.
BackupId	xsd:integer optional	Identifier of the backup Instance To be deleted. Range: [1..2^31-1] This input is required unless both DatasetNameOrId and BackupVersion inputs are supplied.
BackupVersion	DpTimestamp optional	Timestamp when the backup was taken. This input is required if BackupId is not present. This input should be omitted and is ignored if BackupId is present.
DatasetNameOrId	ObjNameOrId optional	Name or identifier of the Dataset for the backup Version To be deleted. This input is required if BackupId is not present. This input should be omitted and is ignored if BackupId is present.
DeleteMultipleBackups	xsd:boolean optional	This input is ignored if BackupId input is present or if all three of the DatasetNameOrId, BackupVersion and NodeName are present since in both cases a single backup is identified for deletion. When both BackupId and NodeName are omitted and both DatasetNameOrId and BackupVersion are supplied, multiple Backups may produce a Match. In that case, this input controls whether multiple Backups that Match the specified DatasetNameOrId and BackupVersion 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 NodeName and BackupId 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.
NodeName	xsd:string optional	Name of Policy node that uniquely defines the BackupId for backup Version To be deleted. This input should be omitted and is ignored if BackupId is present.

[none]

Ends iteration To list backup versions.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpBackupVersionListIterStart.

[none]

Get next few Records in the iteration started by DpBackupVersionListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve.
Tag	xsd:string	Tag From a previous DpBackupVersionListIterStart.

Name	Type	Description
BackupVersions	ArrayOfDpBackupVersionInfo	List of BackupVersions for a given Dataset.
Records	xsd:integer	The number of Records actually returned. Range: [0..2^31-1]

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.

Name	Type	Description
BackupVersion	DpTimestamp optional	Timestamp when the backup was taken. Backups of the Dataset that were taken at this time are listed. If this parameter is specified, VolumeId, SnapshotUniqueId, RootObjectNameOrId and SubPath are ignored.
DatasetNameOrId	ObjNameOrId	Name or Id of Dataset. Backups for this Dataset are listed.
IncludeIsAvailable	xsd:boolean optional	If true, the IsAvailable Status is calculated for each member which may make the call To this zapi take much longer. Default is false.
IncludeMetadata	xsd:boolean optional	If true, returns metadata for the backup. If false, metadata, which can be large in Size, is not returned. Default is false.
RootObjectNameOrId	ObjNameOrId 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.
SnapshotUniqueId	xsd:string optional	Unique Id of a Snapshot. This is currently the Snapshot create time. If VolumeId is present, then this input must be given. Ignored if VolumeId is not present.
SubPath	xsd:string optional	Local subpath within the Dataset with regard To RootObjectNameOrId. If specified, Backups containing this sub Path are listed. Ignored if RootObjectNameOrId input is not present If the RootObjectNameOrId is a Volume, Qtree or ossv unix Directory then this SubPath is a unix-like Path, ex: 'dir1/dir2/'. If the RootObjectNameOrId is ossv windows Directory then this SubPath is a windows Path, ex : 'dir1\dir2\'. Maximum Length of SubPath is 32767 characters.
VolumeId	ObjId optional	Id of Volume that is a member of a Dataset node. If this input is present then SnapshotUniqueId must be present. BackupVersion containing this (VolumeId, SnapshotUniqueId) is returned. If this parameter is specified, RootObjectNameOrId, SubPath are ignored.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpBackupVersionListIterNext. Range: [0..2^31-1]
Tag	xsd:string	Tag To be used in subsequent calls To DpBackupVersionListIterNext.

Modifies a backup Version. Either the BackupId or some combination of the DatasetNameOrId, NodeNameOrId and BackupVersion are used To specify an individual backup Instance or a set of backup Instances which represent the same backup Version. Certain inputs, such as IsAddingMembers, DpBackupTransferInfo and VersionMembers, 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, BackupDescription and BackupMetadata, 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 DatasetNameOrId and BackupVersion To update the fields of all the backup Instances with the same BackupVersion.

Name	Type	Description
BackupDescription	xsd: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.
BackupId	xsd:integer optional	Identifier of the backup Instance To be modified. Range: [1..2^31-1] Either the BackupId or both the DatasetNameOrId and BackupVersion must be specified.
BackupMetadata	ArrayOfDfmMetadata 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.
BackupVersion	DpTimestamp 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 BackupId or both the DatasetNameOrId and BackupVersion must be specified. Ignored if BackupId is specified.
DatasetNameOrId	ObjNameOrId optional	Name or identifier of the Dataset for the backup Version. Either the BackupId or both the DatasetNameOrId and BackupVersion must be specified. Ignored if BackupId is specified.
DpBackupTransferInfo	DpBackupTransferInfo optional	The transfer Status of the backup To a destination node. If this input is specified, either the BackupId or all three of the DatasetNameOrId, NodeNameOrId, and BackupVersion must be specified. This input is for the internal use of the Protection Manager. Protection Manager job can modify BackupTransferStatus, BackupTransferNeeded or JobId elements of DpBackupTransferInfo.
IsAddingMembers	xsd:boolean optional	Indicates whether more Members are being added To the VersionMembers element of this backup. If this input is true, Protection Manager expects more Members To be added To the VersionMembers 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 DpBackupVersionModify 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.
IsComplete	xsd: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.
NodeNameOrId	xsd:string optional	Name or Id of Policy node that uniquely defines the BackupId for backup Version To be modified. If VersionMembers or DpBackupTransferInfo input is specified, either the BackupId or all three of the DatasetNameOrId, NodeNameOrId, and BackupVersion must be specified. If VersionMembers and backup-transfer-info inputs are not specified, omitting NodeNameOrId and BackupId inputs is acceptable as long as both DatasetNameOrId and BackupVersion are specified. In such case, the setting change will be applied To all Backups with the specified BackupVersion. If NodeNameOrId 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 BackupId is present.
RetentionType	xsd:string optional	Retention Type of this Version. Possible Values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
VersionMembers	ArrayOfVersionMemberInfo 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 BackupId or all three of the DatasetNameOrId, NodeNameOrId, and BackupVersion must be specified.

[none]

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.

Name	Type	Description
BackupDestination	xsd: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.
DatasetNameOrId	ObjNameOrId	Name or Id of the Dataset To be backed up.
RetentionType	DpBackupRetentionType optional	Retention Type To which the backup Version should be archived. This input may be required depending on the Type of the Dataset. See RetentionType field in DpBackupStart for more information.

Name	Type	Description
DpJobsData	ArrayOfDpJobData	List of Jobs that need To be started To backup this Dataset. Each element will have all the details required for that job.

Name of the application Resource namespace. We cannot list all possible Values for this Type. Because, in theory, someone could write a new Plugin and install it under a Host Service at RunTime, and we will support such a Plugin From the server side in future. Client should depend on the specific Values only when they are writing plugin-specific code.

[none]

Name	Type	Description
BackupLocationInfo	BackupLocationInfo[]

Name	Type	Description
DfmMetadata	DfmMetadata[]

Name	Type	Description
DpBackupContentInfo	DpBackupContentInfo[]

Name	Type	Description
DpBackupInfo	DpBackupInfo[]

Name	Type	Description
DpBackupPathInfo	DpBackupPathInfo[]

Name	Type	Description
DpBackupVersionInfo	DpBackupVersionInfo[]

Name	Type	Description
DpJobData	DpJobData[]

Name	Type	Description
ObjNameOrId	ObjNameOrId[]

Name	Type	Description
SearchKey	SearchKey[]

Name	Type	Description
VersionMemberInfo	VersionMemberInfo[]

Retention Type To which the backup should be archived. Possible Values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

[none]

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 DestinationStoragesetId, DestinationNodeName or DestinationNodeId.

Name	Type	Description
BackupTransferNeeded	xsd: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.
BackupTransferStatus	xsd: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.
ConnectionType	xsd: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.
DestinationBackupId	xsd: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]
DestinationNodeId	xsd: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].
DestinationNodeName	xsd: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.
DestinationStoragesetId	xsd:integer optional	ID of the destination storage set. Range: [1..2^31-1].
JobId	xsd:integer optional	Identifier for the job that is transferring or has transferred this backup To the destination storage set.
SourceBackupId	xsd: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]
SourceNodeId	xsd: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].
SourceNodeName	xsd: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.
SourceStoragesetId	xsd:integer optional	ID of the Source storage set. Present in the output only. Ignored if specified in the input. Range: [1..2^31-1].

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]

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

Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: It must have the format of an ObjName, or It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1]. In case of application resources From the Host Service, this field can contain unique identifier assigned To the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits From 0 through 9. In that case, you cannot use such identifier as ObjNameOrId input. Elements of Type ObjNameOrId 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 ObjNameOrId 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]

Name	Type	Description
HypervBackupScheduleSettingsInfo	HypervBackupScheduleSettingsInfo

Name	Type	Description
VmwareBackupScheduleSettingsInfo	VmwareBackupScheduleSettingsInfo

location information for backup. Only the Members which are found are returned.

Name	Type	Description
BackupId	xsd:integer optional	Actual backup Instance used To restore Range: [1..2^31-1]
MemberId	ObjId	ID of the Qtree or OSSV Directory. MemberId is for the primary Qtree or OSSV dir.
MemberName	ObjName	Name of the Qtree or OSSV Directory. MemberName is for the primary Qtree or OSSV dir.
Path	xsd:string optional	Name of the Path. The Maximum Path Length is 32767 characters. This Path is relative To 'MemberId' 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').
PathFound	xsd:boolean	TRUE if the Path is found in a BackupVersion. The following elements will be set only if PathFound is TRUE.
PrimarySnapshotName	xsd:string optional	Name of the Snapshot copy on the primary where the data originated.
PrimarySnapshotUniqueId	xsd:string optional	Unique Id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
SecondaryQtreeId	ObjId optional	ID of the secondary Qtree which is protecting the MemberId.
SecondaryQtreeName	ObjName optional	Name of the secondary Qtree which is protecting the MemberId.
SnapshotName	xsd:string optional	Name of the Snapshot in the backup which contains the backup of the member.
StorageSystemId	ObjId optional	ID of the storage system on which the secondary Snapshot copy resides. Always present in the output if the Path is found.
StorageSystemName	ObjName optional	Name of the storage system on which the secondary Snapshot copy resides. Always present in the output if the Path is found.
VolumeId	ObjId optional	Identifier of the Volume on which the Snapshot resides.

Named field in the metadata.

Name	Type	Description
FieldName	xsd:string	Name of the metadata field. Field names are up To 255 characters in Length and are case- insensitive.
FieldValue	xsd: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.

Information about contents of a backup of Dataset.

Name	Type	Description
DpFileInfo	DpFileInfo optional	Information about file (or Directory etc.) in a backup. This element will not be present in case of top-level contents.
PrimarySnapshotName	xsd:string optional	Name of the Snapshot copy on the primary where the data originated.
PrimarySnapshotUniqueId	xsd: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.
RootObjectId	ObjId 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.
RootObjectName	xsd:string optional	Object Name for RootObjectId.
RootObjectType	xsd:string optional	Object Type for RootObjectId. Possible Values: 'Qtree', 'Directory', 'Volume', 'virtual_machine'.

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	Type	Description
ApplicationBackupInfos	ArrayOfApplicationBackupInfo optional	Contains all the information about the application resources in the backup, created by Host services. It is present only if the backup contains application Objects.
BackupDescription	xsd:string optional	User specified Description of backup for unscheduled backup started by DpBackupStart. The Maximum Length of this string is 255 characters.
BackupId	xsd:integer	Identifier of the backup Instance. The management station assigns a unique Id To each backup Instance. Range: [1..2^31-1]
BackupMetadata	ArrayOfDfmMetadata 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.
BackupMountInfos	ArrayOfBackupMountInfo optional	Indicates the mount information for the backup. Currently, there can only be one member in this list since a backup can be mounted only once.
BackupTransferInfos	ArrayOfDpBackupTransferInfo	Indicates the transfer Status of this backup To each of the destination nodes directly connected To the node on which this backup exists.
BackupTransferStatus	xsd:string optional	This field has been deprecated, use BackupTransferInfos 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 ''.
BackupVersion	DpTimestamp	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.
DatasetId	ObjId optional	Object ID of Dataset that the backup was for. Always present in the output, but ignored in the input.
DatasetName	ObjName optional	Name of Dataset that the backup was for. Always present in the output, but ignored in the input.
IsAddingMembers	xsd:boolean	Indicates whether more Members are being added To the VersionMembers element of this backup. If this element is true, Protection Manager expects more Members To be added To the VersionMembers 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 DpBackupVersionModify 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.
IsBackupDestinationNode	xsd:boolean optional	This will be true if the node has an incoming backup connection, false otherwise. This Value may not be present if Policy has been modified in such a way that storageset has no corresponding node in Policy. If the node is the primary node of the Dataset, this Value will be false.
IsForPropagation	xsd: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.
IsMirrorDestinationNode	xsd:boolean optional	This will be true if the node has an incoming mirror connection, false otherwise. This element may not be present if Policy has been modified in such a way that storageset has no corresponding node in Policy. If the node is the primary node of the Dataset, this Value will be false.
NodeId	xsd: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 NodeId Values start at 1. The node Id of the primary node is always 1.
NodeName	xsd: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.
RetentionDuration	xsd:integer optional	The age, in seconds, after which this backup expires. This Value is relative To the backup Version Timestamp. If RetentionDuration is not present, the backup does not expire. Range: [0..2^31 - 1].
RetentionType	DpBackupRetentionType	Type of Retention for the backup.
SupportsNonDisruptiveRestore	RequiresNonDisruptiveRestore	Indicates whether a non disruptive restore is possible From this backup Version. If true then non disruptive restore is possible.
VersionMembers	ArrayOfVersionMemberInfo	describes Snapshot Members of this backup Version.

Information about backup Path

Name	Type	Description
MemberId	ObjId optional	The Qtree or OSSV dir ID. Either MemberId or MemberName must be supplied. If MemberId is supplied MemberName should not be supplied.
MemberName	ObjName optional	The Qtree or OSSV dir Name. Either MemberId or MemberName must be supplied. MemberName is only used if MemberId is not supplied
Path	xsd:string optional	Name of the Path. The Maximum Path Length is 32767 characters. This Path is relative To 'MemberId' 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').
PrimarySnapshotName	xsd:string optional	Name of the Snapshot copy on the primary where the data originated. This is ignored if PrimarySnapshotUniqueId is specified.
PrimarySnapshotUniqueId	xsd: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.

Backup-version information including list of all Instances of this Version.

Name	Type	Description
BackupDescription	xsd: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.
BackupIdInfos	ArrayOfDpBackupIdInfo	List of backup Instances.
BackupTransferInfos	ArrayOfDpBackupTransferInfo	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.
BackupVersion	DpTimestamp	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.
IsFullyPropagated	xsd:boolean	Indicates that this Version is a complete backup of the Dataset on all nodes specified by the protection Policy.
RetentionType	DpBackupRetentionType	Type of Retention for the backup.
VersionMembers	ArrayOfVersionMemberInfo	Describes Snapshot Members of this backup Version.

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

Name	Type	Description
DatasetId	ObjId	Id of the Dataset being protected by the job.
DpJobType	xsd:string	Type of the dp job. Possible Values: 'snapvault', 'snapmirror' and 'local_snapshot'.
DpLocalSnapshotJobData	DpLocalSnapshotJobData optional	Data for local-snapshot job.
DpSnapmirrorTransferJobData	DpSnapmirrorTransferJobData optional	Data for snapmirror-transfer job.
DpSnapvaultTransferJobData	DpSnapvaultTransferJobData optional	Data for snapvault-transfer job.

Schedule level settings for the Hyper-V backup Operation.

Name	Type	Description
AllowSavedStateBackup	xsd:boolean	If true, the backup is always taken even if the backup Operation will cause Virtual Machine To go offline. If false, the backup is taken only if it is possible To do so with the Virtual Machine being online, otherwise the backup is not taken and the Operation is marked as failed.

Key To search the Backups by. This Key is matched against: partial Description of the backup, partial current Name of a primary object in the backup, partial Name of a primary application resources when the backup was taken, UUID of a primary application resources in the backup.

[none]

Describes one Snapshot member of a backup Version.

Name	Type	Description
HostAddress	IpAddress optional	The primary IP Address of the Host To which the Volume belongs To. Always present in the output. Ignored in the input.
HostFqdn	xsd:string optional	The fully qualified domain Name of the Host To which the Volume belongs To. Always present in the output. Ignored in the input. Length: [1..255]
HostId	ObjId optional	This is the identifier of the Host To which the Volume belongs To. Always present in the output. Ignored in the input.
IsAvailable	xsd: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 RealTime.
SnapshotContents	ArrayOfSnapshotMemberInfo	Contents of the Snapshot.
SnapshotName	xsd:string	Name of the Snapshot.
SnapshotUniqueId	xsd:string	Unique Id of the Snapshot. currently this is Snapshot creation time.
VolumeId	ObjId optional	Always included in output, either VolumeId or VolumeName must be specified in input. ID of the Volume corresponding To member Snapshot.
VolumeName	ObjName optional	Always included in output, either VolumeId or VolumeName must be specified in input. The Name of the Volume this Snapshot resides on.

Schedule level settings for the VMware backup Operation.

Name	Type	Description
CreateVmwareSnapshot	xsd:boolean	If true VMware Snapshot will be taken To create a VM consistent backup. If false, only a crash-consistent backup will be created.
IncludeIndependentDisks	xsd:boolean	If false, independent Disks are not included in the backup. If true, independent Disks are also included in the backup. The term independent disk is vmware specifc, please refer To vmware documentation.

Name	Type	Description
ApplicationBackupInfo	ApplicationBackupInfo[]

Name	Type	Description
BackupMountInfo	BackupMountInfo[]

Name	Type	Description
DpBackupIdInfo	DpBackupIdInfo[]

Name	Type	Description
DpBackupTransferInfo	DpBackupTransferInfo[]

Name	Type	Description
SnapshotMemberInfo	SnapshotMemberInfo[]

Information about file, Directory, Qtree, drive etc. on a primary Host or in a backup.

Name	Type	Description
ChildCount	xsd:integer	Count of children. This is zero when Value of FileType element is 'file'. Otherwise, it can be zero or non-zero. Range: [0..2^31-1]
FileName	xsd:string	Name of the file.
FileSize	xsd:unsignedLong optional	Size of file in bytes. Range: [0..2^64-1]
FileType	xsd:string	Type of the file. Possible Values: 'file', 'Directory', 'Qtree', 'Volume', 'drive', 'fifo', 'cspec', 'bspec', 'symlink', 'socket', 'registry', 'stream', 'Lun', and 'other'.
IsEmpty	xsd:boolean optional	This element is present only if the FileType 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 ".."
LastModifiedTimestamp	xsd: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.

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	Type	Description
IsConfirmationData	xsd:boolean optional	If the element: "IsConfirmationData" 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.
NodeId	xsd:integer	Id of the node that needs local Snapshot. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the local Snapshot.

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	Type	Description
ConnectionId	xsd:integer	Id of the Policy connection that needs SnapMirror transfer. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the pre/post backup script in the snapmirror-transfer job only.

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	Type	Description
ConnectionId	xsd:integer	Id of the Policy connection that needs SnapVault transfer. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the backup created by snapvault-transfer job.

IP Address in string format. The Length of this string cannot be more than 40 characters.

[none]

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

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 SupportsNonDisruptiveRestore 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 IsDrCapable attribute may not be set for any Backup connection of the Policy). The Dataset must be an application Dataset. Thus, if RequiresNonDisruptiveRestore is specified as true, IsApplicationData 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]

Contains all the information about the application Objects in the backup.

Name	Type	Description
ApplicationBackupProperties	ArrayOfPropertyInfo	List of Properties, for application Resource backup.
ApplicationResourceNamespace	ApplicationResourceNamespace	Name of the application Resource namespace. The application resources contained in this backup, belong To this namespace.
BackupGraphInfo	BackupGraphInfo optional	Resource graph has the information about the application Objects contained in the backup.
HostServiceBackupId	HostServiceUniqueId	Unique identifier of the application object as generated by the Host Service.
HostServiceId	ObjId	Object ID of the Host Service, where the backup resides.

Indicates the mount information of the backup.

Name	Type	Description
HostId	ObjId	Identifier of Host on which the backup is mounted.
HostName	ObjName	Name of the Host on which the backup is mounted.
MountId	xsd:integer	Identifier of the mount session that mounted the backup. Range: [1..2^31-1]
MountJobId	xsd:integer optional	Identifier of the job that is mounting or has mounted the backup. The job Id will not be available if the mount state has changed To "mounting" but the job has not started yet. The job Id will be available for "mounted" Backups. Range: [1..2^31-1]
MountState	MountState	The mount state of the backup.
MountedBy	xsd:string	The Name of the user who mounted the backup.
UnmountJobId	xsd:integer optional	Identifier of the job that is unmounting the backup. This element will be present only if the backup is in the 'unmounting' state. Range: [1..2^31-1]

Backup-version Instance information including Id and node Name for this Version.

Name	Type	Description
BackupId	xsd:integer	Identifier of the backup Instance. The management station assigns a unique Id To each backup Instance. Range: [1..2^31-1]
BackupMetadata	ArrayOfDfmMetadata 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.
JobId	xsd:integer	Identifier for the job creating this backup.
NodeId	xsd:integer	ID of the node in the data protection Policy. Range: [1..2^31-1].
NodeName	xsd: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.

Information of one Qtree or ossv dir that is in Snapshot.

Name	Type	Description
PrimaryId	ObjId optional	Always returned on output, either PrimaryId or PrimaryName must be specified on input. Primary Qtree or OSSV Directory ID.
PrimaryName	ObjName optional	Always returned on output, either PrimaryId or PrimaryName must be specified on input. The Name of a Qtree or OSSV Directory whose data is in the Snapshot.
PrimarySnapshotHostServiceId	xsd:string optional	Id assigned To the Snapshot copy on the primary by the Host Service. This is filled in only for the Backups containing resources From the Host Service in which case it is set To the ObjectId of the Snapshot copy as reported by the Host Service. Ignored in the input.
PrimarySnapshotName	xsd:string optional	Name of the Snapshot copy on the primary where the data originated.
PrimarySnapshotUniqueId	xsd:string optional	Unique Id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
SecondaryQtreeId	ObjId optional	Corresponding secondary Qtree Id. This legacy parameter if supplied along with SecondaryQtreeNameOrId 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.
SecondaryQtreeName	xsd:string optional	Corresponding secondary Qtree Name. This is ignored on input. Use SecondaryQtreeNameOrId To specify by Name. On output this will be returned along with SecondaryQtreeId. Not included if the backup Version consists of local Snapshots.
SecondaryQtreeNameOrId	xsd:string optional	Corresponding secondary Qtree Name or identifier. This is used To lookup the SecondaryQtreeId if present. If this is present, SecondaryQtreeId will be ignored. Not included if the backup Version consists of local Snapshots.

Name	Type	Description
PropertyInfo	PropertyInfo[]

Contains the information about the various resources and edges To and From these resources, for a backup. The application Objects, are stored in the resource-graph, in form of resources and edges connecting these resources.

Name	Type	Description
GraphEdges	ArrayOfBackupGraphEdgeInfo	Edges in the backup graph.
GraphResources	ArrayOfBackupGraphResourceInfo	Resources in the backup graph.

Identifier generated by the Host Service that is unique within the Host Service.

[none]

Mount session state. Possible Values are: 'mounting', 'mounted', 'unmounting'.

[none]

Name	Type	Description
BackupGraphEdgeInfo	BackupGraphEdgeInfo[]

Name	Type	Description
BackupGraphResourceInfo	BackupGraphResourceInfo[]

Describes a property of an object.

Name	Type	Description
PropertyName	xsd:string	The Name of the property field. Property names are upto 255 characters in Length and are case- sensitive.
PropertyValue	xsd:string	Value of the backup property. Property Values are upto 255 characters in Length and are case- sensitive.

An edge in the backup graph. These are used To traverse From a Resource To another Resource in the backup graph, To extract more specific information.

Name	Type	Description
FromResourceId	ObjId	Object Id of the "From" Resource.
ToResourceId	ObjId	Object Id of the "To" Resource.

Resource is an application object.

Name	Type	Description
ApplicationResourceProperties	ArrayOfPropertyInfo	List of Properties, for an application Resource contained in a backup.
HostServiceObjectId	HostServiceUniqueId	Unique identifier of the application object as generated by the Host Service
IsRestorable	xsd:boolean	Indicates if the restore be done at the level of this object. Object may have been backed up fully but still the restore may not be possible at this object level. You may have To restore one or more of its children. This Value may be different for replica of the primary backup if the backup only got partially transferred To the secondary.
ObjectId	ObjId	DFM Object ID of the Resource.
ObjectName	ObjName	The application object Name might have changed. This string represents the current Name of the Resource, which might be different From the "ObjectNameWhenBackedUp".
ObjectNameWhenBackedUp	ObjName	Name of the Resource when it was backed up.
ResourceType	ApplicationObjectType	Type of the Resource. This field indicates what Type of application object, a Resource is.
Snapshots	ArrayOfSnapshotMemberInfo optional	Contains information about primary Snapshots for a backup. Present only when 'IsRestorable' is true

Describes the application object Type, for a Resource. This string is the Type Id of the application object that comes From the plug-in. It must contain between 1 and 255 characters.

[none]