oracle.oci.oci_database_pluggable_database_facts – Fetches details about one or multiple PluggableDatabase 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_pluggable_database_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple PluggableDatabase resources in Oracle Cloud Infrastructure
Gets a list of the pluggable databases in a database or compartment. You must provide either a databaseId or compartmentId value.
If pluggable_database_id is specified, the details of a single PluggableDatabase 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.
|
|
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 . |
|
database_id
string
|
The OCID of the database.
|
|
lifecycle_state
string
|
|
A filter to return only resources that match the given lifecycle state exactly.
|
pdb_name
string
|
A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.
|
|
pluggable_database_id
string
|
The database OCID.
Required to get a specific pluggable_database.
aliases: id |
|
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 PDBNAME is ascending. The PDBNAME 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 pluggable_database
oci_database_pluggable_database_facts:
# required
pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
- name: List pluggable_databases
oci_database_pluggable_database_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
sort_by: PDBNAME
sort_order: ASC
lifecycle_state: PROVISIONING
pdb_name: pdb_name_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
pluggable_databases
complex
|
on success |
List of PluggableDatabase resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_strings': {'all_connection_strings': {}, 'pdb_default': 'pdb_default_example', 'pdb_ip_default': 'pdb_ip_default_example'}, 'container_database_id': 'ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_restricted': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'open_mode': 'READ_ONLY', 'pdb_name': 'pdb_name_example', 'pdb_node_level_details': [{'node_name': 'node_name_example', 'open_mode': 'READ_ONLY'}], 'pluggable_database_management_config': {'management_status': 'ENABLING'}, 'refreshable_clone_config': {'is_refreshable_clone': True}, 'time_created': '2013-10-20T19:20:30+01:00'}]
|
||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connection_strings
complex
|
on success |
|
||
all_connection_strings
dictionary
|
on success |
All connection strings to use to connect to the pluggable database.
|
||
pdb_default
string
|
on success |
A host name-based PDB connection string.
Sample:
pdb_default_example
|
||
pdb_ip_default
string
|
on success |
An IP-based PDB connection string.
Sample:
pdb_ip_default_example
|
||
container_database_id
string
|
on success |
The OCID of the CDB.
Sample:
ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx
|
||
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'}}
|
||
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 pluggable database.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_restricted
boolean
|
on success |
The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
Sample:
True
|
||
lifecycle_details
string
|
on success |
Detailed message for the lifecycle state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the pluggable database.
Sample:
PROVISIONING
|
||
open_mode
string
|
on success |
**Deprecated.** Use PluggableDatabaseNodeLevelDetails for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
Sample:
READ_ONLY
|
||
pdb_name
string
|
on success |
The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
Sample:
pdb_name_example
|
||
pdb_node_level_details
complex
|
on success |
Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
|
||
node_name
string
|
on success |
The Node name of the Database Instance.
Sample:
node_name_example
|
||
open_mode
string
|
on success |
The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
Sample:
READ_ONLY
|
||
pluggable_database_management_config
complex
|
on success |
|
||
management_status
string
|
on success |
The status of the Pluggable Database Management service.
Sample:
ENABLING
|
||
refreshable_clone_config
complex
|
on success |
|
||
is_refreshable_clone
boolean
|
on success |
Indicates whether the Pluggable Database is a refreshable clone.
Sample:
True
|
||
time_created
string
|
on success |
The date and time the pluggable database was created.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)