cloudera.cloud.datalake_backup_info module – Gather information about a Datalake backup

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_info.

New in cloudera.cloud 3.0.0

Synopsis

  • Gather information about a Datalake backup

  • Optionally filter by backup name or backup id

Parameters

Parameter

Comments

backup_id

string

The id of the backup

backup_name

string

The name of the backup

datalake_name

string / required

The name of the datalake to backup

Examples

# Note: These examples do not set authentication details.

- name: Gather information about all backups for a Datalake
  cloudera.cloud.datalake_backup_info:
    datalake_name: "datalake"
  register: backup_result

- name: Gather information about a specific backup name for a Datalake
  cloudera.cloud.datalake_backup_info:
    datalake_name: "datalake"
    backup_name: "backup"
  register: backup_result

- name: Gather information about a specific backup id for a Datalake
  cloudera.cloud.datalake_backup_info:
    datalake_name: "datalake"
    backup_id: "backup_id"
  register: backup_result

Return Values

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

Key

Description

backups

list / elements=dictionary

Information about the backup

Returned: always

accountId

string

The account id

Returned: always

backupId

string

The backup id

Returned: always

backupLocation

string

The location of the backup

Returned: always

backupName

string

The name of the backup

Returned: always

endTime

string

The end time of the backup

Returned: always

internalState

string

The state of each internal backup components

Returned: always

startTime

string

The start time of the backup

Returned: always

status

string

The status of the backup

Returned: always

userCrn

string

The user crn

Returned: always

Authors

  • Jim Enright (@jimright)