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

appliance recovery backup job: backup request

The backup_request structure represents a requested backup piece.

Representation:

{
    "backup_password" : "secret string",
    "parts" : [
        "string",
        "string"
    ],
    "location" : "string",
    "location_password" : "secret string",
    "comment" : "string",
    "location_type" : "FTP",
    "location_user" : "string"
}

Attributes:

Name Type Description
Required
parts string[] List of optional parts that will be included in the backup. Use the list operation to get information about the supported parts.
location_type string Type of backup location.

Defines the type of destination location for backup/restore. You specify the location type when you create a backup job. See appliance.recovery.backup.job.backup_request. Value is one of:
FTP: Destination is FTP server.
HTTP: Destination is HTTP server.
FTPS: Destination is FTPS server.
HTTPS: Destination is HTTPS server.
SCP: Destination is SSH server.
SFTP: Destination is SFTP server.
NFS: Destination is NFS server. This constant was added in vSphere API 6.7.2.
SMB: Destination is SMB server. This constant was added in vSphere API 6.7.2.
location string Path or URL of the backup location.
Optional
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).

Optional. backupPassword If no password then the piece will not be encrypted.

location_user string Username for the given location.

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

Optional. If unset authentication will not be used for the specified location.
comment string Custom comment provided by the user.

Optional. If unset comment will be empty.