oci_autonomous_database_facts – Fetches details of OCI Autonomous Database instances¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details of all OCI Autonomous Databases in a compartment or a specific OCI Autonomous Database

Requirements ¶

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

python >= 2.7
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user string		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 string		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 string		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 string		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 string	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_database_id -		Identifier of the Autonomous Database whose details needs to be fetched. aliases: id
compartment_id -		Identifier of the compartment from which details of all Autonomous Databases must be fetched.
config_file_location string		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 string		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 string		Use display_name along with the other options to return only resources that match the given display name exactly.
region string		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 string		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

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Fetch Autonomous Database
- name: List all Autonomous Databases in a compartment
  oci_autonomous_database_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'

# Fetch Autonomous Database with specific display name
- name: List all Autonomous Databases in a compartment, filetered by display name
  oci_autonomous_database_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      display_name: 'autodb'

# Fetch a specific Autonomous Database
- name: List a specific Autonomous Database
  oci_autonomous_database_facts:
      autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'

Return Values ¶

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

Key		Returned	Description
autonomous_database complex		success	Attributes of the Fetched Autonomous Database. Sample: [{'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible-autonomous-database-prod', 'cpu_core_count': 1, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'freeform_tags': {'system_license': 'trial'}, 'time_created': '2018-09-22T15:06:55.426000+00:00', 'db_name': 'autodbbackup', 'license_model': 'LICENSE_INCLUDED', 'connection_strings': {'high': 'adwc.EXAMPLE1.oraclecloud.com:1522/EXAMPLE1_autodb_high.atp.oraclecloud.com', 'medium': 'adwc.EXAMPLE3.oraclecloud.com:1522/EXAMPLE3_autodb_medium.atp.oraclecloud.com', 'low': 'adwc.EXAMPLE2.oraclecloud.com:1522/EXAMPLE2_autodb_low.atp.oraclecloud.com'}, 'lifecycle_details': None, 'data_storage_size_in_tbs': 1, 'id': 'ocid1.autonomousdatabase.oc1.iad.xxxxxEXAMPLExxxxx', 'service_console_url': 'https://example1.oraclecloud.com/console/index.html? tenant_name=OCID1.TENANCY.OC1..xxxxxEXAMPLExxxxx &database_name=ANSIBLEAUTODB&service_type=ATP'}, {'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible-autonomous-database-test', 'cpu_core_count': 1, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'freeform_tags': {'system_license': 'trial'}, 'time_created': '2018-09-22T15:06:55.426000+00:00', 'db_name': 'autodbbackup2', 'license_model': 'LICENSE_INCLUDED', 'connection_strings': {'high': 'adwc.EXAMPLE1.oraclecloud.com:1522/EXAMPLE1_autodb_high.atp.oraclecloud.com', 'medium': 'adwc.EXAMPLE3.oraclecloud.com:1522/EXAMPLE3_autodb_medium.atp.oraclecloud.com', 'low': 'adwc.EXAMPLE2.oraclecloud.com:1522/EXAMPLE2_autodb_low.atp.oraclecloud.com'}, 'lifecycle_details': None, 'data_storage_size_in_tbs': 1, 'id': 'ocid1.autonomousdatabase.oc1.iad.xxxxxEXAMPLExxxxx', 'service_console_url': 'https://example1.oraclecloud.com/console/index.html? tenant_name=OCID1.TENANCY.OC1..xxxxxEXAMPLExxxxx &database_name=ANSIBLEAUTODB&service_type=ATP'}]
	compartment_id string	always	The identifier of the compartment containing the Autonomous Database Sample: ocid1.compartment.oc1.xxxxxEXAMPLExxxxx
	connection_strings dictionary	always	The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value. Sample: {'high': 'adwc.EXAMPLE1.oraclecloud.com:1522/EXAMPLE1_autodb_high.atp.oraclecloud.com', 'medium': 'adwc.EXAMPLE3.oraclecloud.com:1522/EXAMPLE3_autodb_medium.atp.oraclecloud.com', 'low': 'adwc.EXAMPLE2.oraclecloud.com:1522/EXAMPLE2_autodb_low.atp.oraclecloud.com'}
	cpu_core_count string	always	The number of CPU cores to enable. Sample: 2
	data_storage_size_in_tbs string	always	Data storage size, in terrabytes, that is currently available to the Autonomous Database. Sample: 2048
	db_name string	always	The database name. Sample: ansible-db-system
	display_name string	always	The user-friendly name for the Autonomous Database. Sample: ansiblea
	id string	always	The identifier of the Autonomous Database Sample: ocid1.autonomousdatabase.oc1.xxxxxEXAMPLExxxxx
	license_model string	always	The Oracle license model that applies to all the databases on the Autonomous Database Sample: LICENSE_INCLUDED
	lifecycle_details string	always	Additional information about the current lifecycle state. Sample: details
	lifecycle_state string	always	The current state of the Autonomous Database. Sample: AVAILABLE
	service_console_url string	always	The URL of the Service Console for the Autonomous Database. Sample: https://example1.oraclecloud.com/console/index.html? tenant_name=OCID1.TENANCY.OC1..xxxxxEXAMPLExxxxx &database_name=ANSIBLEAUTODB&service_type=ATP
	time_created datetime	always	Date and time when the Autonomous Database was created, in the format defined by RFC3339 Sample: 2016-08-25 21:10:29.600000

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Debayan Gupta(@debayan_gupta)

Hint

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

oci_autonomous_database_facts – Fetches details of OCI Autonomous Database instances¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶