oracle.oci.oci_database_pluggable_database_actions – Perform actions on a PluggableDatabase resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a PluggableDatabase resource in Oracle Cloud Infrastructure

  • For action=disable_pluggable_database_management, disables the Database Management service for the pluggable database.

  • For action=enable_pluggable_database_management, enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.

  • For action=local_clone, clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the READ_WRITE openMode to perform the clone operation.

  • For action=modify_pluggable_database_management, updates one or more attributes of the Database Management service for the pluggable database.

  • For action=remote_clone, clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the READ_WRITE openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone.

  • For action=start, starts a stopped pluggable database. The openMode value of the pluggable database will be READ_WRITE upon completion.

  • For action=stop, stops a pluggable database. The openMode value of the pluggable database will be MOUNTED upon completion.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • disable_pluggable_database_management
  • enable_pluggable_database_management
  • local_clone
  • modify_pluggable_database_management
  • remote_clone
  • start
  • stop
The action to perform on the PluggableDatabase.
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
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.
cloned_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 action=local_clone, action=remote_clone.
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.
credential_details
dictionary
Required for action=enable_pluggable_database_management.
password_secret_id
string / required
The OCID of the Oracle Cloud Infrastructure secret.
user_name
string / required
The name of the Oracle Database user that will be used to connect to the database.
pdb_admin_password
string
A strong password for PDB Admin of the newly cloned PDB. 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 -.
Applicable only for action=local_cloneaction=remote_clone.
pluggable_database_id
string / required
The database OCID.

aliases: id
port
integer
The port used to connect to the pluggable database.
Applicable only for action=enable_pluggable_database_managementaction=modify_pluggable_database_management.
private_end_point_id
string
The OCID of the private endpoint.
Required for action=enable_pluggable_database_management.
protocol
string
    Choices:
  • TCP
  • TCPS
Protocol used by the database connection.
Applicable only for action=enable_pluggable_database_managementaction=modify_pluggable_database_management.
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.
role
string
    Choices:
  • SYSDBA
  • NORMAL
The role of the user that will be connecting to the pluggable database.
Applicable only for action=enable_pluggable_database_managementaction=modify_pluggable_database_management.
service_name
string
The name of the Oracle Database service that will be used to connect to the database.
Required for action=enable_pluggable_database_management.
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.
Applicable only for action=local_cloneaction=remote_clone.
source_container_db_admin_password
string
The DB system administrator password of the source CDB.
Required for action=remote_clone.
ssl_secret_id
string
The OCID of the Oracle Cloud Infrastructure secret.
Applicable only for action=enable_pluggable_database_managementaction=modify_pluggable_database_management.
target_container_database_id
string
The OCID of the target CDB
Required for action=remote_clone.
target_tde_wallet_password
string
The existing TDE wallet password of the target CDB.
Applicable only for action=local_cloneaction=remote_clone.
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: Perform action disable_pluggable_database_management on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: disable_pluggable_database_management

- name: Perform action enable_pluggable_database_management on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    credential_details:
      # required
      user_name: user_name_example
      password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
    private_end_point_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    service_name: service_name_example
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: enable_pluggable_database_management

    # optional
    protocol: TCP
    port: 56
    ssl_secret_id: "ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx"
    role: SYSDBA

- name: Perform action local_clone on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    cloned_pdb_name: cloned_pdb_name_example
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: local_clone

    # optional
    pdb_admin_password: example-password
    target_tde_wallet_password: example-password
    should_pdb_admin_account_be_locked: true

- name: Perform action modify_pluggable_database_management on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: modify_pluggable_database_management

    # optional
    credential_details:
      # required
      user_name: user_name_example
      password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
    private_end_point_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    service_name: service_name_example
    protocol: TCP
    port: 56
    ssl_secret_id: "ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx"
    role: SYSDBA

- name: Perform action remote_clone on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    target_container_database_id: "ocid1.targetcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
    source_container_db_admin_password: example-password
    cloned_pdb_name: cloned_pdb_name_example
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: remote_clone

    # optional
    pdb_admin_password: example-password
    target_tde_wallet_password: example-password
    should_pdb_admin_account_be_locked: true

- name: Perform action start on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: start

- name: Perform action stop on pluggable_database
  oci_database_pluggable_database_actions:
    # required
    pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    action: stop

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', 'pluggable_database_management_config': {'management_status': 'ENABLING'}, '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
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
 
pluggable_database_management_config
complex
on success

   
management_status
string
on success
The status of the Pluggable Database Management service.

Sample:
ENABLING
 
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)