oci_db_home_facts – Fetches details of one or more OCI DB Homes

New in version 2.5.

Synopsis

  • Fetches details of the OCI DB Home.

Requirements

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

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.
compartment_id
-
Identifier of the compartment in which the specified DB System exists
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.
db_home_id
-
Identifier of the DB Home whose details needs to be fetched.

aliases: id
db_system_id
-
Identifier of the DB System under which the DB Home is available.
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

Examples

#Fetch DB Home
- name: List all DB Homes in a DB System
  oci_db_home_facts:
      compartment_id: 'ocid1.compartment..xcds'
      db_system_id: 'ocid1.dbsystem..xcds'
#Fetch a specific DB Home
- name: List a specific DB Home
  oci_db_home_facts:
      db_home_id: 'ocid1.dbhome..xcds'

Return Values

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

Key Returned Description
db_homes
complex
success
Attributes of the Fetched DB Homes

Sample:
[{'db_version': '12.2.0.1.1', 'display_name': 'ansible-db-one', 'compartment_id': 'ocid1.compartment.aaaa', 'lifecycle_state': 'AVAILABLE', 'last_patch_history_entry_id': 'ocid1.dbpatchhistory.aaaa', 'time_created': '2018-02-16T08:44:32.779000+00:00', 'db_system_id': 'ocid1.dbsystem.aaaa', 'id': 'ocid1.dbhome.aaaa'}, {'db_version': '12.2.0.1.1', 'display_name': 'ansible-db-two', 'compartment_id': 'ocid1.compartment.aaaa', 'lifecycle_state': 'AVAILABLE', 'last_patch_history_entry_id': 'ocid1.dbpatchhistory.aaaa', 'time_created': '2018-02-16T08:44:32.779000+00:00', 'db_system_id': 'ocid1.dbsystem.aaaa', 'id': 'ocid1.dbhome.aaaa'}]
  compartment_id
string
always
The identifier of the compartment containing the DB Home

Sample:
ocid1.compartment.oc1.xzvf..oifds
  db_system_id
string
always
Identifier of the DB System under which the DB Home should exists.

Sample:
ocid1.dbsystem.oc1.iad.xxxxxEXAMPLExxxxx
  db_version
string
always
Oracle database version.

Sample:
12.2.0.1.1
  display_name
string
always
The user-friendly name for the DB Home.

Sample:
ansible-db-home
  id
string
always
Identifier of the DB Home.

Sample:
ocid1.dbhome.oc1.iad.xxxxxEXAMPLExxxxx
  last_patch_history_entry_id
string
always
The OCID of the last patch history. This is updated as soon as a patch operation is started.

Sample:
ocid1.lastpatchhistory.aaaa
  lifecycle_state
string
always
The current state of the DB System.

Sample:
AVAILABLE
  time_created
datetime
always
Date and time when the DB System 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.