cloudera.cloud.datalake_backup module – Create a backup of a datalake

Note

This module is part of the cloudera.cloud collection (version 3.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cloudera.cloud.

To use it in a playbook, specify: cloudera.cloud.datalake_backup.

New in cloudera.cloud 3.0.0

Synopsis

• Create a backup of a datalake

• Optionally wait for the backup to complete

Parameters

Parameter	Comments
backup_id string	The Id of the backup to restore Only applicable when state=restore
backup_location string	The location of the backup to use during the restore When not specified the location used will be the backup storage of the environment If provided the backup_id parameter is required Only applicable when state=restore
backup_name string	The name of the backup If state=backup this is the name of the backup to create If state=restore this is the name of the backup to restore
datalake_name string / required	The name of the datalake to backup
skip_atlas_indexes boolean	Skips the restore of the Atlas indexes Only applicable when state=restore Choices: false true
skip_atlas_metadata boolean	Skips the restore of the Atlas metadata Only applicable when state=restore Choices: false true
skip_ranger_audits boolean	Skips the restore of the Ranger audits Only applicable when state=restore Choices: false true
skip_ranger_hms_metadata boolean	Skips the restore of the databases backing HMS/Ranger services Only applicable when state=restore Choices: false true
skip_validation boolean	Skips the validation steps that run prior to the restore Only applicable when state=restore Choices: false true
state string	The declarative state of the datalake backup. Choices: "backup" ← (default) "restore"
wait boolean	Whether to wait for the backup to complete Choices: false true

Examples

# Note: These examples do not set authentication details.

- name: Create a datalake backup
  cloudera.cloud.datalake_backup:
    datalake_name: "datalake"
    backup_name: "my_backup"
    state: "backup"
  register: backup_result

- name: Create a datalake backup and wait for it to complete
  cloudera.cloud.datalake_backup:
    datalake_name: "datalake"
    state: "backup"
    wait: true
  register: backup_result

- name: Restore a named datalake backup wait for it to complete
  cloudera.cloud.datalake_backup:
    datalake_name: "datalake"
    backup_name: "my_backup"
    state: "restore"
    wait: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
backup list / elements=dictionary	The details of the backup or restore operation Returned: always
accountId string	The account id Returned: success
backupId string	The backup id Returned: success
backupLocation string	The backup location Returned: success
backupName string	The name of the backup Returned: success
endTime string	The end time Returned: success
internalState string	The internal state of each backup or restore stage Returned: success
operationStates dictionary	Object representing the state of each service running a backup or restore Returned: success
adminOperations dictionary	The state of Cloudera Manager admin operations Returned: success
dryRunValidation dictionary	Details of the dry run validation admin operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
precheckStoragePermission dictionary	Details of the pre check storage permission admin operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
rangerAuditCollectionValidation dictionary	Details of the Ranger Audit Collection Validation admin operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
startServices dictionary	Details of the start services admin operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
stopServices dictionary	Details of the stop services admin operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
database dictionary	The state of each database backup/restore operation Returned: success
database dictionary	Details of the database operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
hbase dictionary	The state of each HBase backup/restore operation Returned: success
atlasEntityAuditEventTable dictionary	Details of the Atlas entity audit event table HBase operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
atlasJanusTable dictionary	Details of the Atlas Janus HBase operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
solr dictionary	The state of each Solr backup/restore operation Returned: success
edgeIndexCollection dictionary	Details of the edge index collection Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
edgeIndexCollectionDelete dictionary	Details of the edge index collection delete Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
fulltextIndexCollection dictionary	Details of the full text index collection Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
fulltextIndexCollectionDelete dictionary	Details of the full text index collection delete Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
rangerAuditsCollection dictionary	Details of the ranger audits collection Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
rangerAuditsCollectionDelete dictionary	Details of the ranger audits collection delete Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
vertexIndexCollection dictionary	Details of the vertex index collection Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
vertexIndexCollectionDelete dictionary	Details of the vertex index collection delete Solr operation Returned: success
durationInMinutes string	The duration of the operation, in minutes Returned: success
failureReason string	The failure reason if the operation was not successful Returned: success
predictedDurationInMinutes string	Predicted duration of the operation, in minutes Returned: success
status string	The status of the backup or restore operation Returned: success
restoreId string	The restore id Only returned when state=restore Returned: success
runtimeVersion string	Datalake runtime version Returned: success
startTime string	The start time Returned: success
status string	The overall status of the backup or restore operation Returned: success
userCrn string	The crn of the user that initiated the backup operation Returned: success

Authors

• Jim Enright (@jimright)

Collection Links

• Issue Tracker
• Repository (Sources)
• Submit a bug report
• Request a feature