oracle.oci.oci_database_db_home_facts – Fetches details about one or multiple DbHome resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
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 oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_database_db_home_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DbHome resources in Oracle Cloud Infrastructure
Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.
If db_home_id is specified, the details of a single DbHome will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
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_ID 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_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
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. |
backup_id
string
|
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
|
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
compartment_id
string
|
The compartment OCID.
Required to list multiple db_homes.
|
|
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
string
|
The Database Home OCID.
Required to get a specific db_home.
aliases: id |
|
db_system_id
string
|
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
|
|
db_version
string
|
A filter to return only DB Homes that match the specified dbVersion.
|
|
display_name
string
|
A filter to return only resources that match the entire display name given. The match is not case sensitive.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only resources that match the given lifecycle state exactly.
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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. |
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
|
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 |
|
vm_cluster_id
string
|
The OCID of the VM cluster.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific db_home
oci_database_db_home_facts:
# required
db_home_id: "ocid1.dbhome.oc1..xxxxxxEXAMPLExxxxxx"
- name: List db_homes
oci_database_db_home_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"
backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
db_version: db_version_example
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
display_name: display_name_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
db_homes
complex
|
on success |
List of DbHome resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_software_image_id': 'ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx', 'db_home_location': 'db_home_location_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'db_version': 'db_version_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'last_patch_history_entry_id': 'ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'one_off_patches': [], 'time_created': '2013-10-20T19:20:30+01:00', 'vm_cluster_id': 'ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
database_software_image_id
string
|
on success |
The database software image OCID
Sample:
ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx
|
|
db_home_location
string
|
on success |
The location of the Oracle Database Home.
Sample:
db_home_location_example
|
|
db_system_id
string
|
on success |
The OCID of the DB system.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
|
db_version
string
|
on success |
The Oracle Database version.
Sample:
db_version_example
|
|
display_name
string
|
on success |
The user-provided name for the Database Home. The name does not need to be unique.
Sample:
display_name_example
|
|
id
string
|
on success |
The OCID of the Database Home.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
kms_key_id
string
|
on success |
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
|
last_patch_history_entry_id
string
|
on success |
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
Sample:
ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_details
string
|
on success |
Additional information about the current lifecycle state.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of the Database Home.
Sample:
PROVISIONING
|
|
one_off_patches
list
/ elements=string
|
on success |
List of one-off patches for Database Homes.
|
|
time_created
string
|
on success |
The date and time the Database Home was created.
Sample:
2013-10-20T19:20:30+01:00
|
|
vm_cluster_id
string
|
on success |
The OCID of the VM cluster.
Sample:
ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)