Skip to main content

Modify ServerPlan BackupDestination​

Select

SaaS
Customer Managed

Modify Backup Destination for a Plan

Path Parameters
  • planId int32 required

    Id of the Plan to modify

  • BackupDestinationId int32 required

    Id of the backupDestination to be modified

Request Body
  • newName string

    New name for backup destination

  • sourceCopy object
  • id int32
  • name string
  • backupsToCopy 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.

  • backupStartTime int32

    Specify the Backup start time in seconds. The time is provided in unix time format.

  • 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. -1 can be specified for infinite retention.

  • snapRecoveryPoints int32

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

    Use extended retention rules. Must specify if updating 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 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.

  • 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

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
PUT /v4/serverplan/:planid/backupdestination/:backupdestinationid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
planId — path required
BackupDestinationId — path required
Body
{

  "newName": "string",

  "sourceCopy": {

    "id": 0,

    "name": "string"

  },

  "backupsToCopy": "All_JOBS",

  "backupStartTime": 0,

  "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"

    }

  },

  "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"

    }

  ]

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "backupsToCopy": "All_JOBS",
  "backupStartTime": 0,
  "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"
    }
  },
  "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"
    }
  ]
}'