VcenterSettingsV1ConfigComponentsApplmgmtBackupSchedule

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


Properties

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


boolean
enable Optional

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


string
location Required

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


string
location_password Optional

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


string
location_user Optional

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


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.


recurrence_info Optional

Recurrence information for the schedule. If unset backup job will not be scheduled. See RecurrenceInfo


retention_info Optional

Retention information for the schedule. If unset all the completed backup jobs will be retained forever. See RetentionInfo


string
schedule_id Required

Identifier of the schedule.

JSON Example

{
    "location": "string",
    "schedule_id": "string"
}
Feedback

Was this page helpful?