oracle / oracle.oci / 5.0.0 / module / oci_database_external_pluggable_database Manage an ExternalPluggableDatabase resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_external_pluggable_database (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to create, update and delete an ExternalPluggableDatabase resource in Oracle Cloud Infrastructure
For I(state=present), registers a new L(ExternalPluggableDatabase,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.
This resource has the following action operations in the M(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.
- 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
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the ExternalPluggableDatabase. - Use I(state=present) to create or update an ExternalPluggableDatabase. - Use I(state=absent) to delete an ExternalPluggableDatabase. required: false type: str key_by: description: 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. elements: str type: list 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 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 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 source_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. 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 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 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). - This parameter is updatable. type: dict display_name: aliases: - name description: - The user-friendly name for the external database. The name does not have to be unique. - Required for create using I(state=present), update using I(state=present) with external_pluggable_database_id present. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int 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"}`' - This parameter is updatable. type: dict compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. 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 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 external_container_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the L(external container database,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified L(external pluggable database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. - Required for create using I(state=present). type: str external_pluggable_database_id: aliases: - id description: - The ExternalPluggableDatabaseId L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. 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
external_pluggable_database: contains: character_set: description: - The character set of the external database. returned: on success sample: character_set_example type: str 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 database_configuration: description: - The Oracle Database configuration returned: on success sample: RAC type: str database_edition: description: - The Oracle Database edition. returned: on success sample: STANDARD_EDITION type: str database_management_config: contains: database_management_connection_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). returned: on success sample: ocid1.databasemanagementconnection.oc1..xxxxxxEXAMPLExxxxxx type: str database_management_status: description: - The status of the Database Management service. returned: on success sample: ENABLING type: str license_model: description: - The Oracle license model that applies to the external database. returned: on success sample: LICENSE_INCLUDED type: str description: - '' returned: on success type: complex database_version: description: - The Oracle Database version. returned: on success sample: database_version_example type: str db_id: description: - The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. returned: on success sample: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx type: str db_packs: description: - The database packs licensed for the external Oracle Database. returned: on success sample: db_packs_example type: str db_unique_name: description: - The `DB_UNIQUE_NAME` of the external database. returned: on success sample: db_unique_name_example 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 display_name: description: - The user-friendly name for the external database. The name does not have to be unique. returned: on success sample: display_name_example type: str external_container_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the L(external container database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified L(external pluggable database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. returned: on success sample: ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str 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 Oracle Cloud Infrastructure external database resource. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Oracle Cloud Infrastructure external database resource. returned: on success sample: PROVISIONING type: str ncharacter_set: description: - The national character of the external database. returned: on success sample: ncharacter_set_example type: str operations_insights_config: contains: operations_insights_connector_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). returned: on success sample: ocid1.operationsinsightsconnector.oc1..xxxxxxEXAMPLExxxxxx type: str operations_insights_status: description: - The status of Operations Insights returned: on success sample: ENABLING type: str description: - '' returned: on success type: complex source_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. returned: on success sample: ocid1.source.oc1..xxxxxxEXAMPLExxxxxx type: str stack_monitoring_config: contains: stack_monitoring_connector_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). returned: on success sample: ocid1.stackmonitoringconnector.oc1..xxxxxxEXAMPLExxxxxx type: str stack_monitoring_status: description: - The status of Stack Monitoring. returned: on success sample: ENABLING type: str description: - '' returned: on success type: complex time_created: description: - The date and time the database was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_zone: description: - 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. returned: on success sample: time_zone_example type: str description: - Details of the ExternalPluggableDatabase resource acted upon by the current operation returned: on success 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 type: complex