oracle.oci.oci_database_external_database_connector – Manage an ExternalDatabaseConnector resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new external database connector.

  • This resource has the following action operations in the oracle.oci.oci_database_external_database_connector_actions module: check_external_database_connector_connection_status.

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 compartment OCID.
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.
connection_credentials
dictionary
Required for create using state=present.
This parameter is updatable.
Applicable when connector_type is 'MACS'
credential_name
string
The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name.
For example: inventorydb.abc112233445566778899
Required when credential_type is 'NAME_REFERENCE'
credential_type
string
    Choices:
  • NAME_REFERENCE
  • SSL_DETAILS
  • DETAILS ←
The type of credential used to connect to the database.
password
string
The password that will be used to connect to the database.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
role
string
    Choices:
  • SYSDBA
  • NORMAL
The role of the user that will be connecting to the database.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
ssl_secret_id
string
The OCID of the Oracle Cloud Infrastructure secret.
Required when credential_type is 'SSL_DETAILS'
username
string
The username that will be used to connect to the database.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
connection_string
dictionary
Required for create using state=present.
This parameter is updatable.
Applicable when connector_type is 'MACS'
hostname
string / required
The host name of the database.
port
integer / required
The port used to connect to the database.
protocol
string / required
    Choices:
  • TCP
  • TCPS
The protocol used to connect to the database.
service
string / required
The name of the service alias used to connect to the database.
connector_agent_id
string
The ID of the agent used for the external database connector.
Required for create using state=present.
connector_type
string
    Choices:
  • MACS ←
The type of connector used by the external database resource.
This parameter is updatable.
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 connector. The name does not have to be unique.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.
Applicable when connector_type is 'MACS'

aliases: name
external_database_connector_id
string
The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
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
external_database_id
string
The OCID of the external database resource.
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.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the ExternalDatabaseConnector.
Use state=present to create or update an ExternalDatabaseConnector.
Use state=absent to delete an ExternalDatabaseConnector.
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_database_connector with connector_type = MACS
  oci_database_external_database_connector:
    # required
    external_database_id: "ocid1.externaldatabase.oc1..xxxxxxEXAMPLExxxxxx"
    connector_agent_id: "ocid1.connectoragent.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    connector_type: MACS
    connection_string:
      # required
      hostname: hostname_example
      port: 56
      service: service_example
      protocol: TCP
    connection_credentials:
      # required
      credential_type: NAME_REFERENCE
      credential_name: credential_name_example

- name: Update external_database_connector with connector_type = MACS
  oci_database_external_database_connector:

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    connector_type: MACS
    connection_string:
      # required
      hostname: hostname_example
      port: 56
      service: service_example
      protocol: TCP
    connection_credentials:
      # required
      credential_type: NAME_REFERENCE
      credential_name: credential_name_example

- name: Update external_database_connector using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connector_type = MACS
  oci_database_external_database_connector:
    # required
    external_database_id: "ocid1.externaldatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    connector_type: MACS
    connection_string:
      # required
      hostname: hostname_example
      port: 56
      service: service_example
      protocol: TCP
    connection_credentials:
      # required
      credential_type: NAME_REFERENCE
      credential_name: credential_name_example

- name: Delete external_database_connector
  oci_database_external_database_connector:
    # required
    external_database_connector_id: "ocid1.externaldatabaseconnector.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Return Values

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

Key Returned Description
external_database_connector
complex
on success
Details of the ExternalDatabaseConnector resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_credentials': {'credential_name': 'credential_name_example', 'credential_type': 'NAME_REFERENCE', 'password': 'example-password', 'role': 'SYSDBA', 'ssl_secret_id': 'ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx', 'username': 'username_example'}, 'connection_status': 'connection_status_example', 'connection_string': {'hostname': 'hostname_example', 'port': 56, 'protocol': 'TCP', 'service': 'service_example'}, 'connector_agent_id': 'ocid1.connectoragent.oc1..xxxxxxEXAMPLExxxxxx', 'connector_type': 'MACS', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'external_database_id': 'ocid1.externaldatabase.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'time_connection_status_last_updated': '2013-10-20T19:20:30+01:00', '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_credentials
complex
on success

   
credential_name
string
on success
The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name.
For example: inventorydb.abc112233445566778899

Sample:
credential_name_example
   
credential_type
string
on success
The type of credential used to connect to the database.

Sample:
NAME_REFERENCE
   
password
string
on success
The password that will be used to connect to the database.

Sample:
example-password
   
role
string
on success
The role of the user that will be connecting to the database.

Sample:
SYSDBA
   
ssl_secret_id
string
on success
The OCID of the Oracle Cloud Infrastructure secret.

Sample:
ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
   
username
string
on success
The username that will be used to connect to the database.

Sample:
username_example
 
connection_status
string
on success
The status of connectivity to the external database.

Sample:
connection_status_example
 
connection_string
complex
on success

   
hostname
string
on success
The host name of the database.

Sample:
hostname_example
   
port
integer
on success
The port used to connect to the database.

Sample:
56
   
protocol
string
on success
The protocol used to connect to the database.

Sample:
TCP
   
service
string
on success
The name of the service alias used to connect to the database.

Sample:
service_example
 
connector_agent_id
string
on success
The ID of the agent used for the external database connector.

Sample:
ocid1.connectoragent.oc1..xxxxxxEXAMPLExxxxxx
 
connector_type
string
on success
The type of connector used by the external database resource.

Sample:
MACS
 
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 connector. The name does not have to be unique.

Sample:
display_name_example
 
external_database_id
string
on success
The OCID of the external database resource.

Sample:
ocid1.externaldatabase.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
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 lifecycle state of the external database connector resource.

Sample:
PROVISIONING
 
time_connection_status_last_updated
string
on success
The date and time the connectionStatus of this external connector was last updated.

Sample:
2013-10-20T19:20:30+01:00
 
time_created
string
on success
The date and time the external connector was created.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)