This is an archive version of the document. To get the most up-to-date information, see the current version.

Destination Type

Depending on the value of the destinationType property the /backupPolicies/{ID} resource can have additional properties.

If the destinationType property has value localStorage the /backupPolicies/{ID} resource has the following additional properties:

Property	Type	Description
path	String	Indicates the path at which a local storage is located.

If the destinationType property has value sharedFolder the /backupPolicies/{ID} resource has the following additional properties:

Property	Type	Description
path	String	Indicates the path at which a shared folder is located.
credentials	Credentials	Indicates credentials to access a shared folder.
cacheEnabled	Boolean	Indicates whether backup cache is enabled for a job. Backup cache has a number of limitations. For more details, see Limitations for Backup Cache.
cachePath	String	Path at which a cache folder is located. Only present if the cacheEnabled property has value true.
cacheSize	integer	Backup cache size. Only present if the cacheEnabled property has value true.
cacheSizeUnits	String	Measurement units for backup cache size. Possible values: GB TB Only present if the cacheEnabled property has value true.

BackupRepository

If the destinationType property has value backupRepository the /backupPolicies/{ID} resource has the following additional properties:

Property	Type	Description
credentials	Credentials	Indicates credentials to access a backup repository.
serverName	String	Name or IP address of a Veeam Backup Server that manages a backup repository.
serverPort	integer	Connection port of a Veeam Backup Server that manages a backup repository.
repositoryName	String	Name of a backup repository.
cacheEnabled	Boolean	Indicates whether backup cache is enabled for a job.
cachePath	String	Indicates the path at which a cache folder is located. Only present if the cacheEnabled property has value true.
cacheSize	integer	Backup cache size. Only present if the cacheEnabled property has value true.
cacheSizeUnits	String	Measurement units for backup cache size. Possible values: GB TB Only present if the cacheEnabled property has value true.

CloudRepository

If the destinationType property has value cloudRepository the /backupPolicies/{ID} resource has the following additional properties:

Property	Type	Description
quotaSize	integer	Size of quota for each backup agent pointed to the cloud repository.
quotaSizeUnits	String	Measurement units for size of quota for each backup agent pointed to the cloud repository. Possible values: GB TB
enableSubtenants	Boolean	Indicates whether subtenant accounts for each Veeam backup agent must be created.
cacheEnabled	Boolean	Indicates whether backup cache is enabled for a job.
cachePath	String	Indicates the path at which a cache folder is located. Only present if the cacheEnabled property has value true.
cacheSize	integer	Backup cache size. Only present if the cacheEnabled property has value true.
cacheSizeUnits	String	Measurement units for backup cache size. Possible values: GB TB Only present if the cacheEnabled property has value true.