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

appliance recovery backup: backup request

backup_request structure Structure representing 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[] a list of optional parts. Run backup parts APIs to get list of optional parts and description
location_type string a type of location

Defines type of all locations for backup/restore 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
Optional
backup_password secret a 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 location

Optional. locationUser User name for this location if login is required.
location_password secret password for location

Optional. locationPassword Password for the specified user if login is required at this location.
comment string Custom comment

Optional. comment an optional comment.