describe-restore¶

Description¶

Returns the description of a control plane restore operation.

Synopsis¶

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

Options¶

--restore-crn (string)

The unique CRN of the restore.

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

restore -> (object)

Restore entry

restoreCrn -> (string)

The CRN of the restore.

backupCrn -> (string)

The CRN of the backup.

restoreCreationTime -> (string)

The time when the restore was created.

restoreUpdatedTime -> (string)

The updated time of the restore.

excludedResources -> (array)

The list of resources to be excluded in restore.

item -> (string)

includedNamespaces -> (array)

The list of namespaces to be included in restore.

item -> (string)

successConditions -> (array)

The list of conditions to be met for a successful restore.

item -> (string)

restorePhase -> (string)

The phase of the restore operation. The values are PENDING, PRE_VALIDATION, STOPPING_APPS, DELETING_OBJECTS, DELETING_OBJECTS_PVC, RESTORING_PVC, RESTORING_OBJECTS, STARTING_APPS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before restore. STOPPING_APPS indicates stopping the microservices before data restore. DELETING_OBJECTS indicates deletion of Kubernetes resources other than PersistentVolumeClaims. DELETING_OBJECTS_PVC indicates deletion of Kubernetes PersistentVolumeClaims. RESTORING_PVC indicates creation of Kubernetes PersistentVolumeClaims. RESTORING_OBJECTS indicates creating of Kubernetes objects other than PersistentVolumeClaims. STARTING_APPS indicates starting of the microservices after data restore and FINISHED indicates the restore job has finished.

restoreJobState -> (string)

The current state of the restore 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.

restoreJob -> (string)

The restore job name.

warnings -> (array)

The warnings from restore 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 restore 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