1. Types
  2. appliance
  3. recovery
  4. backup
  5. schedules

appliance recovery backup schedules: create spec

The create_spec structure contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag. This structure was added in vSphere API 6.7

Representation:

{
    "backup_password": "secret string",
    "enable": true,
    "location": "http://myurl.com",
    "location_password": "secret string",
    "location_user": "string",
    "parts": [
        "string",
        "string"
    ],
    "recurrence_info": {
        "days": [
            "MONDAY",
            "MONDAY"
        ],
        "hour": 1,
        "minute": 1
    },
    "retention_info": {
        "max_count": 1
    }
}

Attributes:

Name Type Description
Required
location URI URL of the backup location. This attribute was added in vSphere API 6.7
Optional
parts string[] List of optional parts to be backed up. Use the list operation to get information about the supported parts. This attribute was added in vSphere API 6.7

Optional. If unset all the optional parts will not be backed up.
backup_password secret Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). This attribute was added in vSphere API 6.7

Optional. If unset the backup piece will not be encrypted.
location_user string Username for the given location. This attribute was added in vSphere API 6.7

Optional. If unset authentication will not be used for the specified location.
location_password secret Password for the given location. This attribute was added in vSphere API 6.7

Optional. If unset authentication will not be used for the specified location.
enable boolean Enable or disable a schedule. This attribute was added in vSphere API 6.7

Optional. If unset the schedule will be enabled.
recurrence_info recurrence_info Recurrence information for the schedule. This attribute was added in vSphere API 6.7

Optional. If unset backup job will not be scheduled. See appliance.recovery.backup.schedules.recurrence_info.

retention_info retention_info Retention information for the schedule. This attribute was added in vSphere API 6.7

Optional. If unset all the completed backup jobs will be retained forever. See appliance.recovery.backup.schedules.retention_info.