Skip to main content

Update Backup Destination details of DR backup destination​

Select

SaaS
Customer Managed

Modify Backup Destination details for CommServe DR backups

Path Parameters
  • BackupDestinationId int32 required

    Id of the backupDestination to be modified

Request Body
  • newName string

    New name for backup destination

  • general object
  • source object
  • id int32
  • name string
  • isActive boolean

    Toggle to keep backup destination active

  • complianceLock boolean

    Toggle to enable compliance lock on backup destination. One time operation, once enabled cannot be disabled and if it is enabled retention on backup destination cannot be lowered.

  • isImmutableSnapCopy boolean

    Toggle to enable immutable snap for snap copy

  • backupType object
  • backupTypesToCopy string

    Possible 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 int32

    Tells 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 PlanFullBackupTypeToCopy

    Possible 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 boolean

    Tells if this copy has data aging enabled

  • overrideRetentionSettings boolean

    Tells 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 RententionRuleTypes

    Possible values: [RETENTION_PERIOD, SNAP_RECOVERY_POINTS]

    Which type of retention rule should be used for the given backup destination

  • retentionPeriodDays int32

    Possible values: >= 1 and <= 9999

    Retention period in days

  • snapRecoveryPoints int32

    Number of snap recovery points for snap copy for retention

  • useExtendedRetentionRules boolean

    Should 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 boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible 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 boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible 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 boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible 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 PlanFullBackupTypeToCopy

    Possible 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.

  • copyPromotionOptions object
  • immediate boolean

    Tells if the copy has to be promoted immediately.

  • hours int32

    Tells the number of hours to wait before failing/killing jobs for copy promotion

  • waitForRunningJobs boolean

    Tells if copy promotion needs to wait for running jobs

  • waitForSynchronize boolean

    Tells if copy promotion needs to wait for synchronization of copies.

  • forceKill boolean

    Tells if we need to force kill jobs and promote copy after waiting.

  • mappings object[]
  • vendor

    Possible values: [NETAPP, AMAZON, PURE, AZURE]

    Snapshot vendors available for Snap Copy mappings

  • source object
  • id int32
  • name string
  • target object
  • id int32
  • name string
  • sourceVendor object
  • id int32
  • name string
  • targetVendor object
  • id int32
  • name string
  • subclients object[]
  • id int32
  • name string
  • mappingType

    Possible values: [DEFAULT_MAPPING, SUBCLIENT_MAPPING]

    Mapping type for pure storage replicaton

  • snapOptions object
  • isSourceBackupCopy boolean

    Is this the source snap copy for backup copy operations?

Responses

Success

Schema
  • planBackupDestination object[]

    List of destinations effected or created

  • id int32
  • name string
  • failedDestinations string[]

    List of destinations for which the operation failed

  • error object
  • errorMessage string
  • errorCode int32
Loading...