Input Name	Range	Type	Description
application-policy-description		string optional	Description of the new policy. It may contain from 0 to 255 characters. If the length is greater than 255 characters, the ZAPI fails with error code EINVALIDINPUTERROR. The default value is the empty string "".
application-policy-name		obj-name	Name of the new policy. It must be unique across all application,provisioning and data protection policies.
group-name-or-id		obj-name-or-id optional	Resource group to which the newly created application policy should be added to. User should have DFM.ApplicationPolicy.Write capability on the specified group. Default value: Global group.
source-policy-name-or-id		obj-name-or-id	The name or ID of an existing policy that is copied to create the new policy.
Output Name	Range	Type	Description
application-policy-id		obj-id	An object ID for the newly created policy.

Errno	Description
EACCESSDENIED
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EPOLICYEXISTS
EDATABASEERROR
EINVALIDINPUTERROR

This API creates a new application policy. Error conditions: EACCESSDENIED - User does not have privileges to create policies. EDATABASEERROR - A database error occurred while processing the request. EINVALIDINPUTERROR - Invalid input was provided. EPOLICYEXISTS - An application policy with given name already exists.

Input Name	Range	Type	Description
application-policy-info		application-policy-info	Details of the new policy to be created.
Output Name	Range	Type	Description
application-policy-id		obj-id	Object ID of the newly created policy.

Errno	Description
EACCESSDENIED
EDATABASEERROR
EINVALIDINPUTERROR
EPOLICYEXISTS

Destroy a application policy. This removes it from the database. If the policy has been applied to any dataset nodes, then the destroy operation fails; it must first be disassociated from all the dataset nodes to which it has been associated and then destroyed. Error conditions: EACCESSDENIED - User does not have DFM.Policy.Delete on the policy being destroyed. EOBJECTNOTFOUND - The specified application policy does not exist in the database. EAPPPOLICYINUSE - The policy is assigned to one or more datasets. EDATABASEERROR - A database error occurred while processing the request. EOBJECTAMBIGUOUS - Multiple objects with the given name present in database. EEDITSESSIONINPROGRESS - The application policy being destroyed locked in an edit session.

Input Name	Range	Type	Description
application-policy-name-or-id		obj-name-or-id validate	Name or id of the application policy being destroyed.
force		boolean optional	force delete even if there is an edit session in progress on the application policy.

Errno	Description
EACCESSDENIED
EOBJECTNOTFOUND
EAPPPOLICYINUSE
EDATABASEERROR
EOBJECTAMBIGUOUS
EEDITSESSIONINPROGRESS

Create an edit session and obtain an edit lock on an application policy to begin modifying the policy. An edit lock must be obtained before invoking application-policy-modify. Use application-policy-edit-commit to end the edit session and commit the changes to the database. Use application-policy-edit-rollback to end the edit session and discard any changes made to the policy. 24 hours after an edit session on a policy begins, any subsequent call to application-policy-edit-begin for that same policy automatically rolls back the existing edit session and begins a new edit session, just as if the call had used the force option. If there is no such call, the existing edit session simply continues and retains the edit lock. Error conditions: EEDITINPROGRESS - Another edit session already has an edit lock on the specified application policy. EOBJECTNOTFOUND - No application policy was found that has the given name or ID. EACCESSDENIED - User does not have DFM.Policy.Write privilege on the policy. modify the application policy. EDATABASEERROR - A database error occurred while processing the request.

Input Name	Range	Type	Description
application-policy-name-or-id		obj-name-or-id	Name or ID of an application policy.
force		boolean optional validate	If true, and an edit session is already in progress on the specified policy, then the previous edit is rolled back and a new edit is begun. If false, and an edit is already in progress, then the call fails with error code EEDITINPROGRESS. Default value is false.
Output Name	Range	Type	Description
edit-lock-id		integer validate	Identifier of the edit lock on the policy. Range: [0..(2^31)-1]

Errno	Description
EEDITINPROGRESS
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

Commit changes made to an application policy during an edit session into the database. If all the changes to the policy are performed successfully, the entire edit is committed and the edit lock on the policy is released. If any of the changes to the policy are not performed successfully, then the edit is rolled back (none of the changes are committed) and the edit lock on the policy is released. Use the dry-run option to test the commit. Using this option, the changes to the policy are not committed to the database. Error conditions: EEDITSESSIONNOTFOUND - No edit lock was found that has the given ID. EACCESSDENIED - User does not have DFM.Policy.Write on the policy. EPOLICYEXISTS - The policy's name is being changed, and a policy with the new name already exists. EDATABASEERROR - A database error occurred while processing the request. EAPPPOLICYNOTFOUND - An application policy was not found.

Input Name	Range	Type	Description
dry-run		boolean optional	If true, return a list of the actions the system would take after committing the changes to the policy, but without actually committing the changes. In addition, the edit lock is not released. By default, dry-run is false.
edit-lock-id		integer	Identifier of the edit lock on the policy. The value must be an edit lock ID that was previously returned by application-policy-edit-begin ZAPI.
Output Name	Range	Type	Description
dry-run-results		dry-run-result[] optional	Results of a dry run. Only returned if dry-run is true.

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED
EPOLICYEXISTS
EDATABASEERROR
EAPPPOLICYNOTFOUND

Roll back changes made to an application policy. The edit lock on the policy will be released after the rollback. Error conditions: EEDITSESSIONNOTFOUND - No edit lock was found that has the given ID. EACCESSDENIED - User does not have privileges to modify the policy.

Input Name	Range	Type	Description
edit-lock-id		integer validate	Identifier of the edit lock on the policy. The value must be an edit lock ID that was previously returned by application-policy-edit-begin ZAPI.

Errno	Description
EEDITSESSIONNOTFOUND
EACCESSDENIED

Terminate a list iteration that had been started by a call to application-policy-list-iter-start. This informs the server that it may now release any resources associated with the temporary store for the list iteration. Error conditions: EINVALIDTAG - The specified tag does not exist.

Input Name	Range	Type	Description
tag		string	The opaque handle returned by the prior call to application-policy-list-iter-start that started this list iteration.

Errno	Description
EINVALIDTAG

Retrieve the next series of policies that are present in a list iteration created by a call to application-policy-list-iter-start. The server maintains an internal cursor pointing to the last record returned. Subsequent calls to application-policy-list-iter-next return the next maximum records after the cursor, or all the remaining records, whichever is fewer. Error conditions: EINVALIDTAG - The specified tag does not exist.

Input Name	Range	Type	Description
maximum		integer validate	The maximum number of policies to return. Range: [1..2^31-1].
tag		string	The opaque handle returned by the prior call to application-policy-list-iter-start that started this list iteration.
Output Name	Range	Type	Description
application-policies		application-policy-info[]	List of information about multiple application policies.
records		integer	Number of records actually returned in the output. Range:[0..2^31-1]

Errno	Description
EINVALIDTAG

Begin a list iteration over application policies. After calling application-policy-list-iter-start, you continue the iteration by calling application-policy-list-iter-next zero or more times, followed by a call to application-policy-list-iter-end to terminate the iteration. Error conditions: EACCESSDENIED - User does not have privileges to read the specified policy. EOBJECTNOTFOUND - No policy or resource group was found that has the given name or ID. EDATABASEERROR - A database error occurred while processing the request.

Input Name	Range	Type	Description
application-policy-type		application-policy-type optional	Filter application policies by type.
object-name-or-id		obj-name-or-id optional	Name or identifier of a application policy or resource group. If a resource group is specified, only the application policies which are members of the group are returned. If application policy name or ID is specified, then application-policy-type filter is ignored.
Output Name	Range	Type	Description
records		integer	Number of items present in the list iteration. Range:[0..2^31-1].
tag		string	An opaque handle used to identify the list iteration. The list content resides in a temporary store in the server.

Errno	Description
EACCESSDENIED
EOBJECTNOTFOUND
EDATABASEERROR
EINVALIDINPUTERROR

This ZAPI modifies the application policy settings of an existing policy in the database with the new values specified in the input. Note: type of application policy cannot be modified after creation. Before modifying the policy, an edit lock has to be obtained on the policy object. Error conditions: EEDITSESSIONNOTFOUND - No edit lock was found that has the given ID. EEDITSESSIONCONFLICTINGOP - current modification made conflicts with previous change in the edit session. EACCESSDENIED - User does not have privileges to modify the policy. EOBJECTNOTFOUND - The policy was already destroyed during this edit session. EOBJECTAMBIGUOUS - Multiple objects with the given name present in database. EINVALIDINPUT - The requested modification is not applicable to the policy being modified. EDATABASEERROR - A database error occurred while processing the request.

Input Name	Range	Type	Description
application-policy-info		application-policy-info	New values for application policy attributes. All the policy attributes are replaced by the new values. If an optional element is absent, then it gets replaced by its default value.
edit-lock-id		integer validate	Identifier of the edit lock on the policy. The value must be an edit lock ID that was previously returned by application-policy-edit-begin.

Errno	Description
EEDITSESSIONNOTFOUND
EEDITSESSIONCONFLICTINGOP
EEDITSESSIONINPROGRESS
EACCESSDENIED
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EINVALIDINPUT
EDATABASEERROR

Contains information about a single application policy.

Name	Range	Type	Description
application-backup-operation-info		application-backup-operation-info	Specifies schedules and settings for the backup operation.
application-policy-description		string optional	Description of the policy. It may contain from 0 to 255 characters. If the length is greater than 255 characters, the ZAPI fails with error code EINVALIDINPUT. The default value is the empty string "".
application-policy-id		obj-id optional	Object ID of the policy, ignored when creating policy.
application-policy-name		obj-name	Name of the policy. Each application policy has a name that is unique among provisioning, application and data protection policies. Must be provided while creating a new policy.
application-policy-settings-info		application-policy-settings-info	Policy level settings.
application-policy-type		application-policy-type	Type of an application policy.
group-name-or-id		obj-name-or-id optional	Resource group to which the newly created application policy should be added to. User should have DFM.ApplicationPolicy.Write capability on the specified group. This input is used by application-policy-create, but ignored by application-policy-modify. Default value: Global group.

Type of an application policy. Possible values are: 'hyperv', 'vmware'.

[none]

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

Name	Range	Type	Description
dry-run-action		string	An action the system would take.
dry-run-effect		string	The predicted effect of the action.
dry-run-reason		string optional	Present only if severity is error or warning. Specifies possible reasons for the error, warning. If there are no reasons to specify, this element will not be present.
dry-run-reason-details		result-detail[] optional	These details apply to the associated dry-run-reason within the same dry-run-result. These offer additional information such as the reasons individual reasources may not have been selected for the dry-run-action in this same dry-run-result.
dry-run-severity		obj-status	severity of the dry-run result. Possible values are "information", "error" or "warning".
dry-run-suggestion		string	Present only if severity is error or warning. Specifies any suggestions to rectify the warnings, errors. If there are no suggestions to specify, this element will not be present.

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]

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]

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]. 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 obj-name-or-id input. 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]

Specifies schedules and settings for the backup operation.

Name	Range	Type	Description
backup-schedules		application-backup-schedule-info[]	One or more schedules for the backup operation.

Policy level settings

Name	Range	Type	Description
backup-script		string optional	Name of the script to invoke on the Host Services station both before and after the backup. The backup-script 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 "". An empty string value "" indicates no script is invoked. The system does not check whether a non-empty path string actually refers to an executable script prior 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
daily-retention-count		integer	Minimum number of daily backups to keep. Range: [0..252].
daily-retention-duration		integer	The age, in seconds, after which a daily backup expires. Range: [0..2^31 - 1].
hourly-retention-count		integer	Minimum number of hourly backups to keep. Range: [0..252].
hourly-retention-duration		integer	The age, in seconds, after which an hourly backup expires. Range: [0..2^31 - 1].
is-lag-error-enabled		boolean	Indicates whether the system should generate an error event when the newest local backup copy is older than lag-error-threshold.
is-lag-warning-enabled		boolean	Indicates whether the system should generate a warning event when the newest local backup copy is older than lag-warning-threshold.
lag-error-threshold		integer optional	Lag, in seconds. If local backup copy is older than this amount and if is-lag-error-enabled is set, the system generates an error event. Range: [1..2^31 - 1].
lag-warning-threshold		integer optional	Lag, in seconds. If local backup copy is older than this amount and if is-lag-warning-enabled is set, the system generates a warning event. Range: [1..2^31 - 1].
monthly-retention-count		integer	Minimum number of monthly backups to keep. Range: [0..252].
monthly-retention-duration		integer	The age, in seconds, after which a monthly backup expires. Range: [0..2^31 - 1].
weekly-retention-count		integer	Minimum number of weekly backups to keep. Range: [0..252].
weekly-retention-duration		integer	The age, in seconds, after which a weekly backup expires. Range: [0..2^31 - 1].

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

[none]

Details on a specific action that adds information intended to explain more about a higher level result. For example, the detail may be used to explain a dry-run result by explaining why resources were not selected.

Name	Range	Type	Description
action		string	An action or check the system had taken.
effect		string	The result of the action or check.
reason		string optional	Specifies possible reasons for the this result. If there are no reasons to specify, this element will not be present.
severity		obj-status	severity of the result result. Possible values are "information", "error" "warning". It is normal for "information" to be used to explain why a resource was not selected.
suggestion		string	Specifies any suggestions to rectify the information, warnings, errors. If there are no suggestions to specify, this element will not be present.

One or more application specific operational values, schedules and associated backup retention type created by the schedule.

Name	Range	Type	Description
hyperv-backup-schedule-settings-info		hyperv-backup-schedule-settings-info optional	Hyper-V specific settings for the backup operation. These settings apply to this backup schedule only. Must be present if and only if the containing policy type is 'hyperv'.
retention-type		dp-backup-retention-type	Retention type for the backup created by this schedule. Retention type must match appropriate schedule events. Hourly retention type must have the schedule containing start-time, end-time, frequency and all days for days-of-week. Example schedule: Backup, Sunday through Saturday, every hour between 7 am and 7 pm. Daily retention type must have the schedule containing start-time and all days for days-of-week. Daily schedule will be executed Sunday through Saturday, once a day at a specified start time. Example schedule: Backup 10 PM every night, Sunday through Saturday. Weekly retention type must have the schedule containing start-time and days-of-week. Example schedule: Backup every Sunday midnight. Monthly retention type must have the schedule containing start-time and days-of-month. Example schedule: Backup 10 PM on 1st and 15th day of each month. Unlimited retention is not supported for scheduled backups. On Demand backup supports 'unlimited' option to retain backups for unlimited duration.
schedule-id		integer optional	Identifier of the schedule. Should not be specified when creating a new policy. During the modify, schedule-id must be specified when changing an existing schedule and must be omitted when adding a new schedule.
simple-schedule-info		simple-schedule-info	Schedule for creating local backups.
start-remote-backup-after-local-backup		boolean optional	This setting applies to backup schedule only and it is valid for both vmware and hyperv policies. Setting this option to 'true' requires administrator to have DFM.BackupManager.OnDemandRemoteBackup privilege on the application policy. Default value for this option would be 'false'. During policy modification administrator must have DFM.BackupManager.OnDemandRemoteBackup privilege on the application policy to change this setting's original value. For example, if the original version of the policy has this option set to true, changing it to false would require DFM.BackupManager.OnDemandRemoteBackup privilege. Enabling this option would initiate on demand transfer on the local backup to a remote storage system.
vmware-backup-schedule-settings-info		vmware-backup-schedule-settings-info optional	VMware specific settings for the backup operation. These settings apply to this backup schedule only. Must be present if and only if the containing policy type is 'vmware'.

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

[none]

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

[none]

Schedule level settings for the Hyper-V backup operation.

Name	Range	Type	Description
allow-saved-state-backup		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.

Simple schedule.

Name	Range	Type	Description
days-of-month		day-of-month[] optional	Days of a month on which the scheduled event occurs. Must not be present if days-of-week is present.
days-of-week		day-of-week[] optional	Days of a week on which the scheduled event occurs. Must not be present if days-of-month is present.
times-of-day-info		times-of-day-info	Times of a day on which the scheduled event occurs. If none of the other elements are specified, scheduled event occurs on every day at the specified times.

Schedule level settings for the VMware backup operation.

Name	Range	Type	Description
create-vmware-snapshot		boolean	If true VMware snapshot will be taken to create a VM consistent backup. If false, only a crash-consistent backup will be created.
include-independent-disks		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.

Day of month. If day-of-month is 29, 30, or 31, it will be interpreted as the last day of the month for months with fewer than that many days. Range: [1..31]

[none]

Day of week. Range: [0..6] (0 = "Sunday")

[none]

Times of day on which the scheduled event occurs.

Name	Range	Type	Description
end-time		time-of-day-info optional	End time for a series of scheduled events separated by "frequency".
frequency		integer optional	Number of minutes between scheduled events. Must be specified when end-time is present. Should not be specified if end-time is not present. Should be a factor of 60 minutes [5,6,10,12 ...] or a multiple of 60 minutes [60,120,240, ...]. Range: [5..1440]
start-time		time-of-day-info	Start time of the schedule. If end-time is not present, this specifies a single occurrence of a scheduled event. Otherwise, this specifies a series of scheduled events between start-time and end-time at a specified "frequency".

Time of day.

Name	Range	Type	Description
hour		integer	Hour. Range: [0..23]
minute		integer	Minute. Range: [0..59]