Create a backup destination for CommServe DR Backups
Select
Create a backup destination for CommServe DR Backups
- application/json
Request Body
destinations object[] required
List of backup destinations to create
backupDestinationName string requiredBackup destination details. Enter the name during creation.
storagePool object
id int32name stringstorageTemplateTags object[]
It is used in Global config template plan creation. Needs in plan creation on global commcell
id int32name stringvalue stringstorageType StorageTypePossible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
]netAppCloudTarget booleanOnly for snap copy. Enabling this changes SVM Mapping to NetApp cloud targets only.
isConfiguredForReplication booleanUsed if the copy is used for replication group
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 int32GUID stringname 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
,PURE
,AZURE
]Snapshot vendors available for Snap Copy mappings
source object
id int32name stringtarget object
id int32name stringsourceVendor object
id int32name stringtargetVendor object
id int32name stringsubclients object[]
id int32name stringmappingTypePossible values: [
DEFAULT_MAPPING
,SUBCLIENT_MAPPING
]Mapping type for pure storage replicaton
snapshotOptions object
This feature applies only to File System Agents
snapRecoveryPoints int32Possible values:
>= 1
Number of snap recovery points for default snap copy for retention. Can be specified instead of retention period in Days for default snap copy.
retentionPeriodDays int32Default value:
30
Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence.
enableBackupCopy booleanFlag to enable backup copy
backupCopyRPOMins int32Default value:
240
Backup copy RPO in minutes
enableSnapCatalog booleanFlag to enable deferred snapshot cataloging
backupCopyOptions object
Options for snap management with backup copy
backupTypeToCopy BackupCopyFullBackupTypePossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
]Backup type to copy for backup copy operation
backupFullToCopy 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.
startTime int32Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap copy.
enableAlert booleanFlag to enable backup copy fallen behind alert
alertInHours int32Default value:
48
Alert to throw when backup copy falls behind in hours
action backupCopyFallenBehindActionPossible values: [
BASED_ON_RETENTION
,SKIP_IF_PENDING
,WAIT_FOR_COMPLETION
]Which type of action should be followed if backup copy falls behind
skipAfterThresholdDays int32Default value:
14
The allowable delay in days before a backup copy job is considered overdue
region object
id int32GUID stringname string
- 200
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
planBackupDestination object[]
List of destinations effected or created
id int32name string- failedDestinations string[]
List of destinations for which the operation failed
error object
errorMessage stringerrorCode int32
{
"planBackupDestination": [
{
"id": 0,
"name": "string"
}
],
"failedDestinations": [
"string"
],
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Requested Details not found
Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}