Orchestration v2 Attributes for BackupConfiguration

The following sample JSON shows the required attributes of the BackupConfiguration object type. A description of each of the required and optional attributes of this object type is provided in the table that follows the JSON sample.

{
       "volumeUri": "{{My_Storage_Volume:uri}}",
       "name": "/Compute-acme/jack.jones@example.com/backupConfigVol1",
       "enabled": false,
       "backupRetentionCount": 2,
       "interval": {
         "Hourly": {
           "hourlyInterval": 1
         }
      }
}
Parameter Required or Optional Description

interval

required

The interval between back ups.

There are two kinds of intervals. Each Interval has its own JSON format. Your Interval field should look like one of the following:

  • "interval":{"Hourly":{"hourlyInterval":2}}

  • {"DailyWeekly":{"daysOfWeek":["MONDAY"],"timeOfDay":"03:15","userTimeZone":"America/Los_Angeles"}}

volumeUri

required

The URI of the storage volume that you want to back up, or a reference to the uri parameter of the StorageVolume object.

name

required

The three-part name of the object (/Compute-identity_domain/user/object).

Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive.

When you specify the object name, ensure that an object of the same type and with the same name doesn’t already exist. If such an object already exists, another object of the same type and with the same name won’t be created and the existing object won’t be updated.

backupRetentionCount

required

The number of backups that should be retained. Minimum is 1.

enabled

optional

Set to true to enable backups. If not specified, the default is true.

description

optional

Description of the backup configuration.