Vcenter_Settings_V1_Config_Components_Applmgmt_BackupSchedule

The BackupSchedule structure contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag.

JSON Example

{
    "parts": [
        "string"
    ],
    "backup_password": "string",
    "location": "string",
    "location_user": "string",
    "location_password": "string",
    "enable": false,
    "recurrence_info": {
        "minute": 0,
        "hour": 0,
        "days": [
            "string"
        ]
    },
    "retention_info": {
        "max_count": 0
    },
    "schedule_id": "string"
}

array of string

parts

Optional

List of optional parts to be backed up. Use the com.vmware.appliance.recovery.backup.Parts#list operation to get information about the supported parts. If unset all the optional parts will not be backed up.

string As password

backup_password

Optional

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). If unset the backup piece will not be encrypted.

string As uri

location

Required

URL of the backup location. Only set if URL is set in BackupSchedule

string

location_user

Optional

Username for the given location. If unset authentication will not be used for the specified location.

string As password

location_password

Optional

Password for the given location. If unset authentication will not be used for the specified location.

boolean

enable

Optional

Enable or disable a schedule. If unset the schedule will be enabled.

Vcenter_Settings_V1_Config_Components_Applmgmt_RecurrenceInfo

recurrence_info

Optional

The RecurrenceInfo structure contains the recurrence information associated with a schedule.

Vcenter_Settings_V1_Config_Components_Applmgmt_RetentionInfo

retention_info

Optional

The RetentionInfo structure contains retention information associated with a schedule.

string

schedule_id

Required

Identifier of the schedule.