restore-cluster¶

Description¶

Restores the cluster from a backup data made by “backup-cluster” command. The operation restores the default DbCatalog configuration, the Virtual Warehouses and the Data Visualisation Apps. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html

Synopsis¶

  restore-cluster
--cluster-id <value>
--data <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

The ID of the cluster.

--data (string)

Dump of configuration received by calling “dump-cluster” command.

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

clusterId -> (string)

The ID of the cluster.

operationId -> (string)

The ID of the restore operation.

action -> (string)

The cluster action. Possible actions: Create, Skip

message -> (string)

The description of the cluster action.

dbcRestorePlans -> (array)

Information about the restore-plan of the DbCatalogs.

item -> (object)

Entity status after the restore operation.

ref -> (string)

The reference of the entity in the backup data.

id -> (string)

The ID of the entity.

action -> (string)

The action associated with the plan. Possible actions: Create, Update, Skip

message -> (string)

The description of the plan.

hueRestorePlans -> (array)

Information about the restore-plan of Hue.

item -> (object)

Entity status after the restore operation.

ref -> (string)

The reference of the entity in the backup data.

id -> (string)

The ID of the entity.

action -> (string)

The action associated with the plan. Possible actions: Create, Update, Skip

message -> (string)

The description of the plan.

hiveRestorePlans -> (array)

Information about the restore-plan of the Hive Virtual Warehouses.

item -> (object)

Entity status after the restore operation.

ref -> (string)

The reference of the entity in the backup data.

id -> (string)

The ID of the entity.

action -> (string)

The action associated with the plan. Possible actions: Create, Update, Skip

message -> (string)

The description of the plan.

impalaRestorePlans -> (array)

Information about the restore-plan of the Impala Virtual Warehouses.

item -> (object)

Entity status after the restore operation.

ref -> (string)

The reference of the entity in the backup data.

id -> (string)

The ID of the entity.

action -> (string)

The action associated with the plan. Possible actions: Create, Update, Skip

message -> (string)

The description of the plan.

vizRestorePlans -> (array)

Information about the restore-plan of the Data Visualization Apps.

item -> (object)

Entity status after the restore operation.

ref -> (string)

The reference of the entity in the backup data.

id -> (string)

The ID of the entity.

action -> (string)

The action associated with the plan. Possible actions: Create, Update, Skip

message -> (string)

The description of the plan.

Form Factors¶

public, private