oracle.oci.oci_database_external_pluggable_database – Manage an ExternalPluggableDatabase 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_external_pluggable_database.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, registers a new ExternalPluggableDatabase resource.

  • This resource has the following action operations in the oracle.oci.oci_database_external_pluggable_database_actions module: change_compartment, disable_external_pluggable_database_database_management, disable_external_pluggable_database_operations_insights, disable_external_pluggable_database_stack_monitoring, enable_external_pluggable_database_database_management, enable_external_pluggable_database_operations_insights, enable_external_pluggable_database_stack_monitoring.

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
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 OCID of the compartment.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
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.
display_name
string
The user-friendly name for the external database. The name does not have to be unique.
Required for create using state=present, update using state=present with external_pluggable_database_id present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
external_container_database_id
string
The OCID of the external container database that contains the specified external pluggable database resource.
Required for create using state=present.
external_pluggable_database_id
string
The ExternalPluggableDatabaseId OCID.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
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.
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.
source_id
string
The OCID of the the non-container database that was converted to a pluggable database to create this resource.
state
string
    Choices:
  • present ←
  • absent
The state of the ExternalPluggableDatabase.
Use state=present to create or update an ExternalPluggableDatabase.
Use state=absent to delete an ExternalPluggableDatabase.
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 external_pluggable_database
  oci_database_external_pluggable_database:
    # required
    external_container_database_id: "ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update external_pluggable_database
  oci_database_external_pluggable_database:
    # required
    display_name: display_name_example
    external_pluggable_database_id: "ocid1.externalpluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"

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

- name: Update external_pluggable_database using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_external_pluggable_database:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

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

- name: Delete external_pluggable_database
  oci_database_external_pluggable_database:
    # required
    external_pluggable_database_id: "ocid1.externalpluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete external_pluggable_database using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_external_pluggable_database:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
external_pluggable_database
complex
on success
Details of the ExternalPluggableDatabase resource acted upon by the current operation

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
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
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
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)