oracle / oracle.oci / 5.0.0 / module / oci_database_pluggable_database_facts Fetches details about one or multiple PluggableDatabase resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_pluggable_database_facts (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
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 I(pluggable_database_id) is specified, the details of a single PluggableDatabase will be returned.
- 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
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: - PDBNAME - TIMECREATED description: - 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. 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 pdb_name: description: - A filter to return only pluggable databases that match the entire name given. The match is not case sensitive. type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token 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 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 database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database. 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 compartment_id: description: - The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). type: str lifecycle_state: choices: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - UPDATING - FAILED - RELOCATING - RELOCATED - REFRESHING - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - DISABLED 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 pluggable_database_id: aliases: - id description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to get a specific pluggable_database. 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
pluggable_databases: 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 connection_strings: contains: all_connection_strings: description: - All connection strings to use to connect to the pluggable database. returned: on success sample: {} type: dict pdb_default: description: - A host name-based PDB connection string. returned: on success sample: pdb_default_example type: str pdb_ip_default: description: - An IP-based PDB connection string. returned: on success sample: pdb_ip_default_example type: str description: - '' returned: on success type: complex container_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the CDB. returned: on success sample: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: Operations: CostCenter: US type: dict freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the pluggable database. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_restricted: description: - 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. returned: on success sample: true type: bool lifecycle_details: description: - Detailed message for the lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the pluggable database. returned: on success sample: PROVISIONING type: str open_mode: description: - '**Deprecated.** Use L(PluggableDatabaseNodeLevelDetails,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/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).' returned: on success sample: READ_ONLY type: str pdb_name: description: - The name for the pluggable database (PDB). The name is unique in the context of a L(container database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/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. returned: on success sample: pdb_name_example type: str pdb_node_level_details: contains: node_name: description: - The Node name of the Database Instance. returned: on success sample: node_name_example type: str open_mode: description: - 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). returned: on success sample: READ_ONLY type: str description: - 'Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]' returned: on success type: complex pluggable_database_management_config: contains: management_status: description: - The status of the Pluggable Database Management service. returned: on success sample: ENABLING type: str description: - '' returned: on success type: complex refreshable_clone_config: contains: is_refreshable_clone: description: - Indicates whether the Pluggable Database is a refreshable clone. returned: on success sample: true type: bool description: - '' returned: on success type: complex time_created: description: - The date and time the pluggable database was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of PluggableDatabase resources returned: on success 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' type: complex