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

appliance recovery backup schedules: info

The info structure contains information about an existing schedule. The structure includes Schedule ID, parts, location information, encryption password, enable flag, recurrence and retention information. This structure was added in vSphere API 6.7

Representation:

{
    "enable": true,
    "location": "http://myurl.com",
    "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
parts string[] List of optional parts that will be included in backups based on this schedule details. Use the list operation to get information about the supported parts. This attribute was added in vSphere API 6.7
location URI URL of the backup location. This attribute was added in vSphere API 6.7
enable boolean Enable or disable a schedule, by default when created a schedule will be enabled. This attribute was added in vSphere API 6.7
Optional
location_user string Username for the given location. This attribute was added in vSphere API 6.7

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

Optional. If unset backup job is not 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 are retained forever. See appliance.recovery.backup.schedules.retention_info.