oci_autonomous_data_warehouse_backup_facts - Fetches details of one or more Autonomous Data Warehouse Backups

New in version 2.5.

Synopsis

  • Fetches details of the Autonomous Data Warehouse Backups.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_type
    Choices:
  • api_key ←
  • instance_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
autonomous_data_warehouse_backup_id
Identifier of the Autonomous Data Warehouse Backup whose details needs to be fetched.

aliases: id
autonomous_data_warehouse_id
Identifier of the Autonomous Data Warehouse whose Backup details needs to be fetched.
compartment_id
Identifier of the compartment from which the details of the Autonomous Data Warehouse Backups should be fetched
config_file_location
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
display_name
Use display_name along with the other options to return only resources that match the given display name exactly.
region
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

#Fetch Autonomous Data Warehouse Backup for a Compartment
- name: List all Autonomous Data Warehouse Backups in a Compartment
  oci_autonomous_data_warehouse_backup_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'

#Fetch Autonomous Data Warehouse Backup for a Compartment, filtered by Display Name
- name: List all Autonomous Data Warehouse Backups in a Compartment, filtered by Display Name
  oci_autonomous_data_warehouse_backup_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      display_name: 'autodbwarehousebackup'

#Fetch Autonomous Data Warehouse Backups for an Autonomous Data Warehouse
- name: List all Autonomous Data Warehouse Backups of an Autonomous Data Warehouse
  oci_autonomous_data_warehouse_backup_facts:
      autonomous_data_warehouse_id: 'ocid1.autonomousdwdatabase..xxxxxEXAMPLExxxxx'

#Fetch Autonomous Data Warehouse Backups for an Autonomous Data Warehouse, filtered by Display Name
- name: List all Autonomous Data Warehouse Backups of an Autonomous Data Warehouse, filtered by Display Name
  oci_autonomous_data_warehouse_backup_facts:
      autonomous_data_warehouse_id: 'ocid1.autonomousdwdatabase..xxxxxEXAMPLExxxxx'
      display_name: 'dbwarehousebackupmanual'

#Fetch a specific Autonomous Data Warehouse Backup
- name: List a specific Autonomous Data Warehouse Backup
  oci_autonomous_data_warehouse_backup_facts:
      autonomous_data_warehouse_backup_id: 'ocid1.autonomousdwbackup..xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
autonomous_data_warehouse_backups
complex
success
Attributes of the Fetched Autonomous Data Warehouse Backup.

Sample:
[{'lifecycle_state': 'AVAILABLE', 'display_name': 'dbwarehousebackup', 'time_started': '2018-09-22T16:38:30.558000+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'autonomous_data_warehouse_id': 'ocid1.autonomousdwdatabase.oc1.iad.xxxxxEXAMPLExxxxx', 'is_automatic': True, 'time_ended': None, 'lifecycle_details': None, 'type': 'FULL', 'id': 'ocid1.autonomousdwbackup.oc1.iad.xxxxxEXAMPLExxxxx'}, {'lifecycle_state': 'AVAILABLE', 'display_name': 'dbwarehousebackupmanual', 'time_started': '2018-09-25T16:38:30.558000+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'autonomous_data_warehouse_id': 'ocid1.autonomousdwdatabase.oc1.iad.xxxxxEXAMPLExxxxx', 'is_automatic': False, 'time_ended': None, 'lifecycle_details': None, 'type': 'FULL', 'id': 'ocid1.autonomousdwbackup.oc1.iad.xxxxxEXAMPLExxxxx'}]
  lifecycle_state
string
always
The current state of the Database Backup.

Sample:
ACTIVE
  display_name
string
always
The user-friendly name for the Autonomous Data Warehouse Backup.

Sample:
manual-backup
  time_started
string
always
The date and time the Autonomous Data Warehouse Backup starts.

Sample:
2018-02-23 06:37:58.669000
  compartment_id
string
always
The identifier of the compartment containing the Autonomous Data Warehouse, whose backup has to be created.

Sample:
ocid1.compartment.oc1.xxxxxEXAMPLExxxxx
  autonomous_data_warehouse_id
string
always
The identifier of the Autonomous Data Warehouse whose backup has to be created.

Sample:
ocid1.autonomousdwdatabase.oc1.iad.xxxxxEXAMPLExxxxx
  time_ended
string
always
The date and time the Autonomous Data Warehouse Backup was completed.

Sample:
2018-02-23 13:50:57.211000
  is_automatic
string
always
Indicates whether the backup is user-initiated or automatic.

  lifecycle_details
string
always
Additional information about the current lifecycle_state of the Database Backup.

Sample:
The backup operation cannot run successfully because the node is STOPPING or STOPPED
  type
string
always
The type of Autonomous Data Warehouse Backup.

Sample:
FULL
  id
string
always
Identifier of the Autonomous Data Warehouse Backup.

Sample:
ocid1.autonomousdwbackup.oc1.iad.xxxxxEXAMPLExxxxx


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.