oracle.oci.oci_database_pluggable_database – Manage a PluggableDatabase resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a PluggableDatabase resource in Oracle Cloud Infrastructure

  • For state=present, creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the StartPluggableDatabase and StopPluggableDatabase APIs to start and stop the pluggable database.

  • This resource has the following action operations in the oracle.oci.oci_database_pluggable_database_actions module: convert_to_regular, disable_pluggable_database_management, enable_pluggable_database_management, local_clone, modify_pluggable_database_management, refresh, remote_clone, rotate_pluggable_database_encryption_key, start, stop.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
container_database_admin_password
string
The DB system administrator password of the Container Database.
container_database_id
string
The OCID of the CDB
Required for create using state=present.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
pdb_admin_password
string
A strong password for PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
pdb_creation_type_details
dictionary
creation_type
string / required
    Choices:
  • RELOCATE_PDB
  • REMOTE_CLONE_PDB
  • LOCAL_CLONE_PDB
The Pluggable Database creation type.
dblink_user_password
string
The DB link user password.
Applicable when creation_type is one of ['REMOTE_CLONE_PDB', 'RELOCATE_PDB']
dblink_username
string
The name of the DB link user.
Applicable when creation_type is one of ['REMOTE_CLONE_PDB', 'RELOCATE_PDB']
refreshable_clone_details
dictionary
Applicable when creation_type is 'REMOTE_CLONE_PDB'
is_refreshable_clone
boolean
    Choices:
  • no
  • yes
Indicates whether Pluggable Database is a refreshable clone.
Applicable when creation_type is 'REMOTE_CLONE_PDB'
source_container_database_admin_password
string
The DB system administrator password of the source Container Database.
Required when creation_type is one of ['REMOTE_CLONE_PDB', 'RELOCATE_PDB']
source_pluggable_database_id
string / required
The OCID of the Source Pluggable Database.
pdb_name
string
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.
Required for create using state=present.
pluggable_database_id
string
The database OCID.
Required for update using state=present.
Required for delete using state=absent.

aliases: id
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
should_create_pdb_backup
boolean
    Choices:
  • no
  • yes
Indicates whether to take Pluggable Database Backup after the operation.
should_pdb_admin_account_be_locked
boolean
    Choices:
  • no
  • yes
The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
state
string
    Choices:
  • present ←
  • absent
The state of the PluggableDatabase.
Use state=present to create or update a PluggableDatabase.
Use state=absent to delete a PluggableDatabase.
tde_wallet_password
string
The existing TDE wallet password of the CDB.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create pluggable_database
  oci_database_pluggable_database:
    # required
    pdb_name: pdb_name_example
    container_database_id: "ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    pdb_admin_password: example-password
    tde_wallet_password: example-password
    should_pdb_admin_account_be_locked: true
    container_database_admin_password: example-password
    should_create_pdb_backup: true
    pdb_creation_type_details:
      # required
      source_container_database_admin_password: example-password
      creation_type: RELOCATE_PDB
      source_pluggable_database_id: "ocid1.sourcepluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      dblink_username: dblink_username_example
      dblink_user_password: example-password
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update pluggable_database
  oci_database_pluggable_database:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete pluggable_database
  oci_database_pluggable_database:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
pluggable_database
complex
on success
Details of the PluggableDatabase resource acted upon by the current operation

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)