backup-datalake¶

Description¶

Takes a backup of all the data in the datalake.

Synopsis¶

  backup-datalake
--datalake-name <value>
[--backup-location <value>]
[--backup-name <value>]
[--close-db-connections | --no-close-db-connections]
[--skip-ranger-hms-metadata | --no-skip-ranger-hms-metadata]
[--skip-atlas-metadata | --no-skip-atlas-metadata]
[--skip-ranger-audits | --no-skip-ranger-audits]
[--skip-atlas-indexes | --no-skip-atlas-indexes]
[--skip-validation | --no-skip-validation]
[--validation-only | --no-validation-only]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-name (string)

The name of the datalake.

--backup-location (string)

Location where the back-up has to be stored. For example s3a://Location/of/the/backup.

--backup-name (string)

The name of the backup.

--close-db-connections | --no-close-db-connections (boolean)

Close the database connections while performing backup. Default is true.

--skip-ranger-hms-metadata | --no-skip-ranger-hms-metadata (boolean)

Skips the backup of the databases backing HMS/Ranger services. If this option is not provided, the HMS/Ranger services are backed up by default.

--skip-atlas-metadata | --no-skip-atlas-metadata (boolean)

Skips the backup of the Atlas metadata. If this option is not provided, the Atlas metadata is backed up by default.

--skip-ranger-audits | --no-skip-ranger-audits (boolean)

Skips the backup of the Ranger audits. If this option is not provided, Ranger audits are backed up by default.

--skip-atlas-indexes | --no-skip-atlas-indexes (boolean)

Skips the backup of the Atlas indexes. If this option or –skipAtlasMetadata is not provided, Atlas indexes are backed up by default. Redundant if –skipAtlasMetadata is included.

--skip-validation | --no-skip-validation (boolean)

Skips the validation steps that run prior to the backup. If this option is not provided, the validations are performed by default.

--validation-only | --no-validation-only (boolean)

Runs only the validation steps and then returns. If this option is not provided, the backup is performed as normal by default.

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

accountId -> (string)

Account where the datalake exists.

backupId -> (string)

Unique identifier for the backup requested.

userCrn -> (string)

Crn of the user who triggered this operation.

internalState -> (string)

Provides the details of the internal state where the backup operation stands.

status -> (string)

Provide the current status.

startTime -> (string)

Time when the backup operation started.

endTime -> (string)

Time when the backup operation ended.

backupLocation -> (string)

Location of the backup to be used to perform restore.

operationStates -> (object)

Object representing the state of each service running a backup.

adminOperations -> (object)

The state of Cloudera Manager admin operations.

stopServices -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

startServices -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

precheckStoragePermission -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditCollectionValidation -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

hbase -> (object)

The state of each HBase backup/restore operation.

atlasEntityAuditEventTable -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

atlasJanusTable -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

solr -> (object)

The state of each Solr backup/restore operation.

edgeIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

fulltextIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditsCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

vertexIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

edgeIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

fulltextIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditsCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

vertexIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

database -> (object)

The state of the database backup/restore operation.

database -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

runtimeVersion -> (string)

The runtime version of the datalake when the backup was taken.

backupName -> (string)

Name of the backup.

failureReason -> (string)

Reason for the failure.

Form Factors¶

public