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

appliance recovery backup: backup request

backup_request structure Structure representing requested backup piece

Representations:

{
    "backup_password": "secret string",
    "comment": "string",
    "location": "string",
    "location_password": "secret string",
    "location_type": "FTPS",
    "location_user": "string",
    "parts": [
        "string",
        "string"
    ]
}
<?xml version="1.0" ?>
<ns0:BackupRequest xmlns:ns0="http://vmware.com/appliance/recovery/backup" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <location_type>FTPS</location_type>
  <location>string</location>
  <parts-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </parts-array>
  <location_password>secret string</location_password>
  <comment>string</comment>
  <backup_password>secret string</backup_password>
  <location_user>string</location_user>
</ns0:BackupRequest>

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:
FTPS: Destination is FTPS server
HTTP: Destination is HTTP server
SCP: Destination is SSH server
HTTPS: Destination is HTTPS server
FTP: Destination is FTP server
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.