create-backup¶

Description¶

Initiates service backup and returns a backup ID, which can be used for log retrieval, restoration, deletion, and backup cancellation. Service backup includes the definition of the Service and its Virtual Clusters along with Virtual Clusters contents (jobs, resources, and credentials).

Synopsis¶

  create-backup
--service-id <value>
[--description <value>]
[--backup-path <value>]
[--include-vc | --no-include-vc]
[--timeout <value>]
[--backup-vc-content-options <value>]
[--force | --no-force]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--service-id (string)

Service ID of the service to backup.

--description (string)

Backup description.

--backup-path (string)

Backup file relative path. The path should not include file name, and be relative to the service backup location. The service backup location can be found in the service description obtained via the ‘describe-service’ command.

--include-vc | --no-include-vc (boolean)

Whether to backup service virtual clusters. By default, virtual clusters are backed up.

--timeout (integer)

Backup operation timeout in seconds.

--backup-vc-content-options (object)

Backup virtual cluster content options.

includeJobs -> (boolean)

Whether to backup jobs. By default, jobs are backed up.

includeJobResources -> (boolean)

Whether to backup job resources. By default, job resources are backed up.

includeResources -> (boolean)

Whether to backup resources. By default, resources are backed up.

includeResourceCredentials -> (boolean)

Whether to backup resource credentials. By default, resource credentials are backed up.

includeCredentials -> (boolean)

Whether to backup credentials. By default, credentials are backed up.

includeCredentialSecrets -> (boolean)

Whether to backup credential secrets. Secrets are obfuscated while storing. By default, credential secrets are backed up.

includeJobRuns -> (boolean)

Whether to backup job runs. By default, job runs are backed up.

jobFilter -> (array)

Filter jobs for backup using ‘fieldname(operator)argument’ syntax. Here, ‘fieldname’ is one of the job fields (e.g. name, type, etc.), and ‘operator’ is one of (‘eq’, ‘noteq’, ‘lte’, ‘lt’, ‘gte’, ‘gt’, ‘in’, ‘notin’, ‘like’, ‘rlike’, ‘is’, ‘isnot’). Multiple filters are ANDed. For example, ‘name(eq)SparkPi’. This will only take effect if jobs are backed up, as controlled by the ‘includeJobs’ option.

item -> (string)

resourceFilter -> (array)

Filter resources for backup using ‘fieldname(operator)argument’ syntax. Here, ‘fieldname’ is one of the resource fields (e.g. name, type, status, etc.), and ‘operator’ is one of (‘eq’, ‘noteq’, ‘lte’, ‘lt’, ‘gte’, ‘gt’, ‘in’, ‘notin’, ‘like’, ‘rlike’, ‘is’, ‘isnot’). Multiple filters are ANDed. For example, ‘name(eq)test-resource’. This will only take effect if resources are backed up, as controlled by the ‘includeResources’ option.

item -> (string)

credentialFilter -> (array)

Filter credentials for backup using ‘fieldname(operator)argument’ syntax. Here, ‘fieldname’ is one of the credential fields (e.g. name, type, etc.), and ‘operator’ is one of (‘eq’, ‘noteq’, ‘lte’, ‘lt’, ‘gte’, ‘gt’, ‘in’, ‘notin’, ‘like’, ‘rlike’, ‘is’, ‘isnot’). Multiple filters are ANDed. For example, ‘name(eq)test-credential’. This will only take effect if credentials are backed up, as controlled by the ‘includeCredentials’ option.

item -> (string)

validateArchive -> (boolean)

Whether to validate backup archive. By default, backup archive is not validated.

Shorthand Syntax:

includeJobs=boolean,includeJobResources=boolean,includeResources=boolean,includeResourceCredentials=boolean,includeCredentials=boolean,includeCredentialSecrets=boolean,includeJobRuns=boolean,jobFilter=string,string,resourceFilter=string,string,credentialFilter=string,string,validateArchive=boolean

JSON Syntax:

{
  "includeJobs": true|false,
  "includeJobResources": true|false,
  "includeResources": true|false,
  "includeResourceCredentials": true|false,
  "includeCredentials": true|false,
  "includeCredentialSecrets": true|false,
  "includeJobRuns": true|false,
  "jobFilter": ["string", ...],
  "resourceFilter": ["string", ...],
  "credentialFilter": ["string", ...],
  "validateArchive": true|false
}

--force | --no-force (boolean)

Whether to ignore validation errors and proceed with the backup forcefully. By default, the backup operation is not forced.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

backupID -> (integer)

Backup ID, which can be used for log retrieval, restoration, deletion, and backup cancellation.

Form Factors¶

public, private