Get Backup Destination details of DR backup destination
Select
Get specific backup destination details for Commserve DR Backups
Path Parameters
- BackupDestinationId int32 required
Id of the backup destination
- 200
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
plan object
id int32name stringplanBackupDestination object
id int32name string- configurable boolean
Flag to specify whether backup destination is configurable (True when it belongs to a base plan or a derived plan with overriden storage pool)
region object
id int32name stringdisplayName stringgeneral object
storage object
id int32Id of Storage Pool
name stringName of Storage Pool
typePossible values: [
DEDUPLICATION
,SECONDARY_COPY
,NON_DEDUPLICATION
,SCALE_OUT
]Type of Storage Pool
retentionPeriodDays int32Retention period of pool in days
wormStoragePoolFlag int32Bit flag indicating WORM configuration of storage pool. 0 means no lock, 1 means compliance lock, 2 means worm storage lock, 4 means Object worm lock and 8 means bucket worm lock.
deviceType object
id int32Device Type Id of the storage.
name stringPossible values: [
DEFAULT
,MAGNETIC
,AMAZON_S3
,MICROSOFT_AZURE_STORAGE
,NIRVANIX_MFS
,RACKSPACE_CLOUD_FILES
,IRON_MOUNTAIN_ARCHIVE
,EMC_ATMOS
,ATT_SYNAPTIC
,CV_OBJECT_SERVER
,HITACHI_CONTENT_PLATFORM
,MEZEO_CS
,OPENSTACK_OBJECT_STORAGE
,AMPLIDATA
,CHINA_MOBILE_ONEST
,HDFS
,VERIZON_CLOUD
,GOOGLE_CLOUD_STORAGE
,VMWARE_CLOUD
,ORACLE_STORAGE_CLOUD_SERVICE
,ORACLE_STORAGE_CLOUD_ARCHIVE_SERVICE
,ALIBABA_CLOUD_OBJECT_STORAGE_SERVICE
,HUAWEI_OBJECT_STORAGE
,ORACLE_CLOUD_INFRASTRUCTURE_OBJECT_STORAGE_S3
,ORACLE_CLOUD_INFRASTRUCTURE_OBJECT_STORAGE
,TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE
,ORACLE_CLOUD_INFRASTRUCTURE_ARCHIVE_STORAGE
,INSPUR_CLOUD
,IBM_CLOUD
,AZURE_DATA_LAKE_STORE
,KINGSOFT_KS3
,MICROSOFT_ONEDRIVE
,IRON_MOUNTAIN_CLOUD
,MICROSOFT_FILE_SHARE
,AZURE_DATA_LAKE_STORE_GEN2
,MICROSOFT_AZURE_COMPATIBLE
,S3_COMPATIBLE_STORAGE
,CARINGO_CASTOR
,DELL_DX_OBJECTSTORAGE
,AMAZON_GLACIER
,DDN_WOS
,GENERIC_HARDWARE_DEDUPE_DEVICE
,BOOST_HARDWARE_DEDUPE_DEVICE
,HPE_CATALYST_STORAGE
,ISILON_ONEFS
,LOCAL_FILE
,LOCAL_FILE_WITH_PROP_S3
,LOCAL_FILE_WITH_PROP_AZURE
,CEPH_OBJECT_GATEWAY_S3
,CLOUDIAN_HYPERSTORE
,DELL_EMC_ECS_S3
,FUJITSU_STORAGE_ETERNUS
,HITACHI_CLOUD_PLATOFORM_CLOUD_SCALE
,IBM_CLOUD_OBJECT_STORAGE_S3
,NETAPP_STORAGEGRID
,CCL_VAULT_V2
,SCALITY_RING
,WASABI_HOT_CLOUD_STORAGE
,NUTANIX_OBJECTS
,NETAPP_ONTAP_S3
,HITACHI_CLOUD_SCALE
,PURE_STORAGE_FLASHBLADE
,VAST_DATA
,METALLIC_RECOVERY_RESERVE
,METALLIC_RECOVERY_RESERVE_AZURE_HOT
,METALLIC_RECOVERY_RESERVE_AZURE_COOL
,METALLIC_RECOVERY_RESERVE_OCI_STANDARD
,METALLIC_RECOVERY_RESERVE_OCI_INFREQUENT_ACCESS
,METALLIC_BUNDLED_STORAGE_O365
,METALLIC_BUNDLED_STORAGE_ENDPOINT
,METALLIC_BUNDLED_STORAGE__SALESFORCE
,METALLIC_BUNDLED_STORAGE_D365
,METALLIC_BUNDLED_STORAGE_AZURE_AD
,METALLIC_BUNDLED_STORAGE_AZURE_MAAS
,MICROSOFT_AZURE_MANAGEMENT
,MICROSOFT_AZURE_MANAGEMENT_BLOB
,MICROSOFT_AZURE_MANAGEMENT_FILE
]Device type of the storage.
storageClass stringPossible values: [
DEFAULT
,AWS_STANDARD
,AWS_REDUNDANCY
,AWS_SIA
,AWS_ONEZONE_IA
,AWS_IT
,AWS_GLACIER
,AWS_GLACIER_STANDARD
,AWS_GLACIER_SIA
,AWS_GLACIER_OZIA
,AWS_GLACIER_IT
,AWS_DEEP_ARCHIVE
,AWS_DA_STANDARD
,AWS_DA_SIA
,AWS_DA_OZIA
,AWS_DA_IT
,AWS_GLACIER_IR
,AWS_GLACIER_IR_STANDARD
,AWS_GLACIER_IR_SIA
,AWS_GLACIER_IR_OZIA
,AWS_GLACIER_IR_IT
,AZURE_DEFAULT
,AZURE_HOT
,AZURE_COOL
,AZURE_ARCHIVE
,AZURE_HOT_ARCHIVE
,AZURE_COOL_ARCHIVE
,AZURE_COLD
,AZURE_HOT_COLD
,AZURE_COOL_COLD
,GOOGLE_STANDARD
,GOOGLE_DR_AVAILABILITY
,GOOGLE_NEARLINE
,GOOGLE_COLDLINE
,GOOGLE_ARCHIVE
,GOOGLE_DEFAULT
,ALI_DEFAULT
,ALI_STANDARD
,ALI_IA
,ALI_ARCHIVE
,ALI_ARCHIVE_STANDARD
,ALI_ARCHIVE_IA
,K3S_STANDARD
,K3S_IA
,ORACLE_STANDARD
,ORACLE_IA
,ORACLE_ARCHIVE
,ORACLE_STANDARD_ARCHIVE
,ORACLE_IA_ARCHIVE
]Storage class of the Storage Pool
isArchiveStorage booleanFlag indicating whether the storage tier is archive.
region object
id int32name stringdisplayName stringstorageType StorageTypePossible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
]source object
id int32name stringnetAppCloudTarget booleanOnly for snap copy. Tells if the snap copy supports SVM Mapping to NetApp cloud targets only.
isImmutableSnapCopy booleanOnly for snap copy. Tells if the snap copy has immutable snap option enabled.
isDefault booleanIs this a default backup destination?
isActive booleanIs this an active backup destination?
isCopyInMaintenanceMode booleanIs this copy in Maintenance mode?
isCopyPromotionRequestSubmitted booleanIs copy promotion request submitted for this copy?
complianceLock booleanIs compliance lock enabled on backup destination?
isSnapCopy booleanIs this a snap copy?
isMirrorCopy booleanIs this a mirror copy?
isAirgapCopy booleanSet to true if this copy uses Airgap storage
copyTypePossible values: [
SYNCHRONOUS
,SELECTIVE
,PRIMARY
]snapCopyTypePossible values: [
DEFAULT_MIRROR
,DEFAULT_VAULT_REPLICA
,MIRROR
,VAULT_REPLICA
,SNAPSHOT_PRIMARY
]copyPrecedence int32Order of backup destinaion copy created in storage policy
backupType object
backupTypesToCopy 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.
backupTypesCopiedFrom int32Tells what start date, backup types should be copied from. The date is provided in unix time format in number of seconds. -1 means initial backup date.
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.
retentionRules object
enableDataAging booleanTells if this copy has data aging 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
Retention period in days
snapRecoveryPoints int32Number of snap recovery points for snap copy for retention
useExtendedRetentionRules booleanShould extended retention rules be used
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.
fullBackupTypesToBeRetained 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.
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
globalConfigInfo object
Only applicable on Global CommCells
id stringname stringcommcells object[]
List of Service CommCells where the global configuration is applied
id int32name stringguid stringscope stringThe entity level at which the config is applied.
scopeFilterQuery stringCommCellEntityCache filter query string used for filtering the scope
applyOnAllCommCells booleanDecides whether the global configuration should be applied to all the Service commcells, including the newly created ones
isMarkedForDeletion booleanIndicates whether global configuration deletion has been started.
status stringsnapOptions object
isSourceBackupCopy booleanIs this the source snap copy for backup copy operations?
{
"plan": {
"id": 0,
"name": "string"
},
"planBackupDestination": {
"id": 0,
"name": "string"
},
"configurable": true,
"region": {
"id": 0,
"name": "string",
"displayName": "string"
},
"general": {
"storage": {
"id": 0,
"name": "string",
"type": "DEDUPLICATION",
"retentionPeriodDays": 0,
"wormStoragePoolFlag": 0,
"deviceType": {
"id": 0,
"name": "DEFAULT"
},
"storageClass": "DEFAULT",
"isArchiveStorage": true,
"region": {
"id": 0,
"name": "string",
"displayName": "string"
}
},
"storageType": "ALL",
"source": {
"id": 0,
"name": "string"
},
"netAppCloudTarget": true,
"isImmutableSnapCopy": true,
"isDefault": true,
"isActive": true,
"isCopyInMaintenanceMode": true,
"isCopyPromotionRequestSubmitted": true,
"complianceLock": true,
"isSnapCopy": true,
"isMirrorCopy": true,
"isAirgapCopy": true,
"copyType": "SYNCHRONOUS",
"snapCopyType": "DEFAULT_MIRROR",
"copyPrecedence": 0
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
},
"subclients": [
{
"id": 0,
"name": "string"
}
],
"mappingType": "DEFAULT_MAPPING"
}
],
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
},
"snapOptions": {
"isSourceBackupCopy": true
}
}
Requested Details not found
Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}