oracle.oci.oci_database_external_pluggable_database_facts – Fetches details about one or multiple ExternalPluggableDatabase 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_external_pluggable_database_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ExternalPluggableDatabase resources in Oracle Cloud Infrastructure
Gets a list of the ExternalPluggableDatabase resources in the specified compartment.
If external_pluggable_database_id is specified, the details of a single ExternalPluggableDatabase 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. |
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 external_pluggable_databases.
|
|
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
|
A filter to return only resources that match the entire display name given. The match is not case sensitive.
aliases: name |
|
external_container_database_id
string
|
The ExternalContainerDatabase OCID.
|
|
external_pluggable_database_id
string
|
The ExternalPluggableDatabaseId OCID.
Required to get a specific external_pluggable_database.
aliases: id |
|
lifecycle_state
string
|
|
A filter to return only resources that match the specified lifecycle state.
|
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 |
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 external_pluggable_database
oci_database_external_pluggable_database_facts:
# required
external_pluggable_database_id: "ocid1.externalpluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
- name: List external_pluggable_databases
oci_database_external_pluggable_database_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
external_container_database_id: "ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
sort_by: DISPLAYNAME
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 | ||
---|---|---|---|---|
external_pluggable_databases
complex
|
on success |
List of ExternalPluggableDatabase resources
Sample:
[{'character_set': 'character_set_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_configuration': 'RAC', 'database_edition': 'STANDARD_EDITION', 'database_management_config': {'database_management_connection_id': 'ocid1.databasemanagementconnection.oc1..xxxxxxEXAMPLExxxxxx', 'database_management_status': 'ENABLING', 'license_model': 'LICENSE_INCLUDED'}, 'database_version': 'database_version_example', 'db_id': 'ocid1.db.oc1..xxxxxxEXAMPLExxxxxx', 'db_packs': 'db_packs_example', 'db_unique_name': 'db_unique_name_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'external_container_database_id': 'ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'ncharacter_set': 'ncharacter_set_example', 'operations_insights_config': {'operations_insights_connector_id': 'ocid1.operationsinsightsconnector.oc1..xxxxxxEXAMPLExxxxxx', 'operations_insights_status': 'ENABLING'}, 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'stack_monitoring_config': {'stack_monitoring_connector_id': 'ocid1.stackmonitoringconnector.oc1..xxxxxxEXAMPLExxxxxx', 'stack_monitoring_status': 'ENABLING'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_zone': 'time_zone_example'}]
|
||
character_set
string
|
on success |
The character set of the external database.
Sample:
character_set_example
|
||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_configuration
string
|
on success |
The Oracle Database configuration
Sample:
RAC
|
||
database_edition
string
|
on success |
The Oracle Database edition.
Sample:
STANDARD_EDITION
|
||
database_management_config
complex
|
on success |
|
||
database_management_connection_id
string
|
on success |
The OCID of the external database connector.
Sample:
ocid1.databasemanagementconnection.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_management_status
string
|
on success |
The status of the Database Management service.
Sample:
ENABLING
|
||
license_model
string
|
on success |
The Oracle license model that applies to the external database.
Sample:
LICENSE_INCLUDED
|
||
database_version
string
|
on success |
The Oracle Database version.
Sample:
database_version_example
|
||
db_id
string
|
on success |
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
Sample:
ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
|
||
db_packs
string
|
on success |
The database packs licensed for the external Oracle Database.
Sample:
db_packs_example
|
||
db_unique_name
string
|
on success |
The `DB_UNIQUE_NAME` of the external database.
Sample:
db_unique_name_example
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
The user-friendly name for the external database. The name does not have to be unique.
Sample:
display_name_example
|
||
external_container_database_id
string
|
on success |
The OCID of the external container database that contains the specified external pluggable database resource.
Sample:
ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx
|
||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the Oracle Cloud Infrastructure external database resource.
Sample:
ocid1.resource.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 Oracle Cloud Infrastructure external database resource.
Sample:
PROVISIONING
|
||
ncharacter_set
string
|
on success |
The national character of the external database.
Sample:
ncharacter_set_example
|
||
operations_insights_config
complex
|
on success |
|
||
operations_insights_connector_id
string
|
on success |
The OCID of the external database connector.
Sample:
ocid1.operationsinsightsconnector.oc1..xxxxxxEXAMPLExxxxxx
|
||
operations_insights_status
string
|
on success |
The status of Operations Insights
Sample:
ENABLING
|
||
source_id
string
|
on success |
The OCID of the the non-container database that was converted to a pluggable database to create this resource.
Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
|
||
stack_monitoring_config
complex
|
on success |
|
||
stack_monitoring_connector_id
string
|
on success |
The OCID of the external database connector.
Sample:
ocid1.stackmonitoringconnector.oc1..xxxxxxEXAMPLExxxxxx
|
||
stack_monitoring_status
string
|
on success |
The status of Stack Monitoring.
Sample:
ENABLING
|
||
time_created
string
|
on success |
The date and time the database was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_zone
string
|
on success |
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
Sample:
time_zone_example
|
Authors¶
Oracle (@oracle)