oracle / oracle.oci / 4.21.0 / module / oci_database_db_home_facts Fetches details about one or multiple DbHome resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_db_home_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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 I(db_home_id) is specified, the details of a single DbHome will be returned.
- 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
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str sort_by: choices: - TIMECREATED - DISPLAYNAME description: - 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. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str backup_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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. type: str db_home_id: aliases: - id description: - The Database Home L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to get a specific db_home. type: str db_version: description: - A filter to return only DB Homes that match the specified dbVersion. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str db_system_id: description: - The DB system L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system. type: str display_name: aliases: - name description: - A filter to return only resources that match the entire display name given. The match is not case sensitive. type: str vm_cluster_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VM cluster. type: str compartment_id: description: - The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to list multiple db_homes. type: str lifecycle_state: choices: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED description: - A filter to return only resources that match the given lifecycle state exactly. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
db_homes: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str database_software_image_id: description: - The database software image L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) returned: on success sample: ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx type: str db_home_location: description: - The location of the Oracle Database Home. returned: on success sample: db_home_location_example type: str db_system_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the DB system. returned: on success sample: ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx type: str db_version: description: - The Oracle Database version. returned: on success sample: db_version_example type: str display_name: description: - The user-provided name for the Database Home. The name does not need to be unique. returned: on success sample: display_name_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Database Home. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_id: description: - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. returned: on success sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx type: str last_patch_history_entry_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started. returned: on success sample: ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Database Home. returned: on success sample: PROVISIONING type: str one_off_patches: description: - List of one-off patches for Database Homes. returned: on success sample: [] type: list time_created: description: - The date and time the Database Home was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vm_cluster_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VM cluster. returned: on success sample: ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx type: str description: - List of DbHome resources returned: on success 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 type: complex