oracle.oci.oci_database_tools_connection – Manage a DatabaseToolsConnection 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_tools_connection.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new Database Tools connection.

  • This resource has the following action operations in the oracle.oci.oci_database_tools_connection_actions module: change_compartment, validate.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
advanced_properties
dictionary
The advanced connection properties key-value pair (e.g., `sslMode`).
This parameter is updatable.
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 containing the Database Tools connection.
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_string
string
The connection string used to connect to the MySQL Server.
This parameter is updatable.
database_tools_connection_id
string
The OCID of a Database Tools connection.
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
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 type is one of ['MYSQL', 'ORACLE_DATABASE']

aliases: name
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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
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.
key_stores
list / elements=dictionary
The CA certificate to verify the server's certificate and the client private key and associated certificate required for client authentication.
This parameter is updatable.
key_store_content
dictionary
secret_id
string
The OCID of the secret containing the key store.
value_type
string / required
    Choices:
  • SECRETID
The value type of the key store content.
key_store_password
dictionary
secret_id
string
The OCID of the secret containing the key store password.
value_type
string / required
    Choices:
  • SECRETID
The value type of the key store password.
key_store_type
string
    Choices:
  • CLIENT_CERTIFICATE_PEM
  • CLIENT_PRIVATE_KEY_PEM
  • CA_CERTIFICATE_PEM
  • JAVA_KEY_STORE
  • JAVA_TRUST_STORE
  • PKCS12
  • SSO
The key store type.
private_endpoint_id
string
The OCID of the Database Tools private endpoint used to access the database in the customer VCN.
This parameter is updatable.
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.
related_resource
dictionary
This parameter is updatable.
entity_type
string
    Choices:
  • MYSQLDBSYSTEM
  • AUTONOMOUSDATABASE
  • DATABASE
  • PLUGGABLEDATABASE
The resource entity type.
This parameter is updatable.
Applicable when type is one of ['MYSQL', 'ORACLE_DATABASE']
identifier
string
The OCID of the related resource.
This parameter is updatable.
Applicable when type is one of ['MYSQL', 'ORACLE_DATABASE']
state
string
    Choices:
  • present ←
  • absent
The state of the DatabaseToolsConnection.
Use state=present to create or update a DatabaseToolsConnection.
Use state=absent to delete a DatabaseToolsConnection.
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
type
string
    Choices:
  • MYSQL
  • ORACLE_DATABASE
The DatabaseToolsConnection type.
Required for create using state=present, update using state=present with database_tools_connection_id present.
user_name
string
The user name.
This parameter is updatable.
user_password
dictionary
This parameter is updatable.
secret_id
string / required
The OCID of the secret containing the user password.
value_type
string / required
    Choices:
  • SECRETID
The value type of the user password.
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 database_tools_connection with type = MYSQL
  oci_database_tools_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: MYSQL

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create database_tools_connection with type = ORACLE_DATABASE
  oci_database_tools_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: ORACLE_DATABASE

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update database_tools_connection with type = MYSQL
  oci_database_tools_connection:
    # required
    type: MYSQL

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update database_tools_connection with type = ORACLE_DATABASE
  oci_database_tools_connection:
    # required
    type: ORACLE_DATABASE

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update database_tools_connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = MYSQL
  oci_database_tools_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: MYSQL

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update database_tools_connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = ORACLE_DATABASE
  oci_database_tools_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: ORACLE_DATABASE

    # optional
    display_name: display_name_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    related_resource:
      # optional
      entity_type: MYSQLDBSYSTEM
      identifier: identifier_example
    connection_string: connection_string_example
    user_name: user_name_example
    user_password:
      # required
      value_type: SECRETID
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    advanced_properties: null
    key_stores:
    - # optional
      key_store_type: CLIENT_CERTIFICATE_PEM
      key_store_content:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      key_store_password:
        # required
        value_type: SECRETID

        # optional
        secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete database_tools_connection
  oci_database_tools_connection:
    # required
    database_tools_connection_id: "ocid1.databasetoolsconnection.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete database_tools_connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_tools_connection:
    # 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
database_tools_connection
complex
on success
Details of the DatabaseToolsConnection resource acted upon by the current operation

Sample:
{'advanced_properties': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'key_stores': [{'key_store_content': {'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'value_type': 'SECRETID'}, 'key_store_password': {'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'value_type': 'SECRETID'}, 'key_store_type': 'CLIENT_CERTIFICATE_PEM'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'private_endpoint_id': 'ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx', 'related_resource': {'entity_type': 'MYSQLDBSYSTEM', 'identifier': 'identifier_example'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'ORACLE_DATABASE', 'user_name': 'user_name_example', 'user_password': {'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'value_type': 'SECRETID'}}
 
advanced_properties
dictionary
on success
The advanced connection properties key-value pair (for example, `sslMode`).

 
compartment_id
string
on success
The OCID of the compartment containing the Database Tools connection.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_string
string
on success
The connection string used to connect to the MySQL Server.

Sample:
connection_string_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Database Tools connection.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
key_stores
complex
on success
The CA certificate to verify the server's certificate and the client private key and associated certificate required for client authentication.

   
key_store_content
complex
on success

     
secret_id
string
on success
The OCID of the secret containing the key store.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
     
value_type
string
on success
The value type of the key store content.

Sample:
SECRETID
   
key_store_password
complex
on success

     
secret_id
string
on success
The OCID of the secret containing the key store password.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
     
value_type
string
on success
The value type of the key store password.

Sample:
SECRETID
   
key_store_type
string
on success
The key store type.

Sample:
CLIENT_CERTIFICATE_PEM
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Database Tools connection.

Sample:
CREATING
 
private_endpoint_id
string
on success
The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

Sample:
ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx
 
related_resource
complex
on success

   
entity_type
string
on success
The resource entity type.

Sample:
MYSQLDBSYSTEM
   
identifier
string
on success
The OCID of the related resource.

Sample:
identifier_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The time the Database Tools connection was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The Database Tools connection type.

Sample:
ORACLE_DATABASE
 
user_name
string
on success
The user name.

Sample:
user_name_example
 
user_password
complex
on success

   
secret_id
string
on success
The OCID of the secret containing the user password.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
   
value_type
string
on success
The value type of the user password.

Sample:
SECRETID


Authors

  • Oracle (@oracle)