Create Backup Destination (without Plan)
Create backup destination(s) for a plan before creating the plan. The primary backup destination can be then associated with the plan to associate all secondary copies also.
- application/json
Request Body
backupDestinations object[] required
List of backup destinations to create
name string requiredName of backup destination
storagePool object required
id int32name stringstorageType StorageTypePossible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
]netAppCloudTarget booleanOnly for snap copy. Enabling this changes SVM Mapping to NetApp cloud targets only.
isSnapCopy booleanIs this a snap copy? If isMirrorCopy is not set, then default is Vault/Replica.
isMirrorCopy booleanIs this a mirror copy? Only considered when isSnapCopy is true.
region object
id int32name stringsourceCopy object
id int32name stringbackupsToCopy stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
fullBackupTypesToCopy PlanFullBackupTypeToCopyPossible values: [
FIRST
,LAST
]Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.
backupStartTime int32Backup start time in seconds. The time is provided in unix time format.
optimizeForInstantClone booleanFlag to specify if primary storage is copy data management enabled.
overrideRetentionSettings booleanTells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy.
retentionRuleType RententionRuleTypesPossible values: [
RETENTION_PERIOD
,SNAP_RECOVERY_POINTS
]Which type of retention rule should be used for the given backup destination
retentionPeriodDays int32Possible values:
>= 1
and<= 9999
Default value:
30
Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence.
snapRecoveryPoints int32Possible values:
>= 1
Number of snap recovery points for snap copy for retention. Can be specified instead of retention period in Days for snap copy.
useExtendedRetentionRules booleanUse extended retention rules
extendedRetentionRules object
If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.
firstExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
secondExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
thirdExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
mappings object[]
vendorPossible values: [
NETAPP
,AMAZON
]Snapshot vendors available for Snap Copy mappings
source object
id int32name stringtarget object
id int32name stringsourceVendor object
id int32name stringtargetVendor object
id int32name string
- 200
- 400
Success
- application/json
- Schema
- Example (from schema)
Schema
planBackupDestination object[]
List of destinations effected or created
id int32Id of the backup destination affected or created
name stringName of the backup destination affected or created
isDefault booleanTells if this is the default (primary) backup destination
- failedDestinations string[]
List of destinations for which the operation failed
error object
errorMessage stringerrorCode int32
{
"planBackupDestination": [
{
"id": 0,
"name": "string",
"isDefault": true
}
],
"failedDestinations": [
"string"
],
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Bad Request