describe-backup¶

Description¶

Returns the description of an existing control plane backup.

Synopsis¶

  describe-backup
--backup-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--backup-crn (string)

The CRN of the backup.

--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¶

backup -> (object)

Backup entry

backupCrn -> (string)

The unique CRN of the backup.

backupCreationTime -> (string)

The time when the backup was created.

backupName -> (string)

The display name of the backup.

backupUpdatedTime -> (string)

The time when the backup was updated.

backupPhase -> (string)

The phase of the backup operation. The values are PENDING, PRE_VALIDATION, SAVING_OBJECTS, CREATING_SNAPSHOTS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before backup. SAVING_OBJECTS indicates saving all the kubernetes resources related to the backup item. CREATING_SNAPSHOTS indicates creating a snapshot of all Kubernetes PersistentVolumeClaims related to the backup item and FINISHED indicates that the backup job has finished.

backupJobState -> (string)

The current state of the backup job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

backupJob -> (string)

The backup job name.

includedNamespaces -> (array)

The list of namespaces to be included in backup.

item -> (string)

warnings -> (array)

The warnings from backup job.

item -> (object)

The message object used to display warnings and errors during DRS workflows

text -> (string)

The text message of the warning/error.

timestamp -> (string)

The time when the warning/error is hit.

namespace -> (string)

The namespace that has the warning/error.

errors -> (array)

The errors from backup job.

item -> (object)

The message object used to display warnings and errors during DRS workflows

text -> (string)

The text message of the warning/error.

timestamp -> (string)

The time when the warning/error is hit.

namespace -> (string)

The namespace that has the warning/error.

Form Factors¶

private