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

appliance recovery restore job: restore request

restore_request structure Structure representing requested restore piece

Representation:

{
    "backup_password": "secret string",
    "ignore_warnings": true,
    "location": "string",
    "location_password": "secret string",
    "location_type": "FTP",
    "location_user": "string",
    "sso_admin_user_name": "string",
    "sso_admin_user_password": "secret string"
}

Attributes:

Name Type Description
Required
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
location string path or url
Optional
backup_password secret a password for a backup piece

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

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.
sso_admin_user_name string Administrators Username for SSO. This attribute was added in vSphere API 6.7

Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
sso_admin_user_password secret The password for SSO admin user. This attribute was added in vSphere API 6.7

Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
ignore_warnings boolean The flag to ignore warnings during restore. This attribute was added in vSphere API 6.7

Optional. If unset, validation warnings will fail the restore operation.