oracle.oci.oci_database_management_external_db_system_connector – Manage an ExternalDbSystemConnector resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

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

  • This resource has the following action operations in the oracle.oci.oci_database_management_external_db_system_connector_actions module: check_external_db_system_connector_connection_status.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
agent_id
string
The OCID of the management agent used for the external DB system connector.
Required for create using state=present.
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
  • security_token
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.
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_info
dictionary
Required for update using state=present with external_db_system_connector_id present.
Applicable when connector_type is 'MACS'
component_type
string / required
    Choices:
  • ASM
  • DATABASE
The component type.
connection_credentials
dictionary / required
credential_name
string
The name of the credential information that used to connect to the DB system resource. 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
  • DETAILS ←
  • SSL_DETAILS
The type of credential used to connect to the ASM instance.
password_secret_id
string
The OCID of the secret containing the user password.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
role
string
    Choices:
  • SYSASM
  • SYSDBA
  • SYSOPER
  • NORMAL
The role of the user connecting to the ASM instance.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
ssl_secret_id
string
The OCID of the secret containing the SSL keystore and truststore details.
Required when credential_type is 'SSL_DETAILS'
user_name
string
The user name used to connect to the ASM instance.
Required when credential_type is one of ['SSL_DETAILS', 'DETAILS']
connection_string
dictionary / required
host_name
string
The host name of the database or the SCAN name in case of a RAC database.
Required when component_type is 'DATABASE'
hosts
list / elements=string
The list of host names of the ASM instances.
Required when component_type is 'ASM'
port
integer / required
The port used to connect to the ASM instance.
protocol
string / required
    Choices:
  • TCP
  • TCPS
The protocol used to connect to the ASM instance.
service
string / required
The service name of the ASM instance.
connector_type
string
    Choices:
  • MACS
The type of connector.
Required for create using state=present, update using state=present with external_db_system_connector_id present.
display_name
string
The user-friendly name for the external connector. The name does not have to be unique.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
external_db_system_connector_id
string
The OCID of the external connector.
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_db_system_id
string
The OCID of the external DB system.
Required for create using state=present.
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.
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.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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 ExternalDbSystemConnector.
Use state=present to create or update an ExternalDbSystemConnector.
Use state=absent to delete an ExternalDbSystemConnector.
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_db_system_connector with connector_type = MACS
  oci_database_management_external_db_system_connector:
    # required
    external_db_system_id: "ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
    connector_type: MACS

    # optional
    display_name: display_name_example
    connection_info:
      # required
      component_type: ASM
      connection_string:
        # required
        port: 56
        service: service_example
        protocol: TCP

        # optional
        hosts: [ "hosts_example" ]
        host_name: host_name_example
      connection_credentials:
        # required
        credential_type: NAME_REFERENCE
        credential_name: credential_name_example

- name: Update external_db_system_connector with connector_type = MACS
  oci_database_management_external_db_system_connector:
    # required
    connector_type: MACS

    # optional
    connection_info:
      # required
      component_type: ASM
      connection_string:
        # required
        port: 56
        service: service_example
        protocol: TCP

        # optional
        hosts: [ "hosts_example" ]
        host_name: host_name_example
      connection_credentials:
        # required
        credential_type: NAME_REFERENCE
        credential_name: credential_name_example

- name: Update external_db_system_connector using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connector_type = MACS
  oci_database_management_external_db_system_connector:
    # required
    connector_type: MACS

    # optional
    display_name: display_name_example
    connection_info:
      # required
      component_type: ASM
      connection_string:
        # required
        port: 56
        service: service_example
        protocol: TCP

        # optional
        hosts: [ "hosts_example" ]
        host_name: host_name_example
      connection_credentials:
        # required
        credential_type: NAME_REFERENCE
        credential_name: credential_name_example

- name: Delete external_db_system_connector
  oci_database_management_external_db_system_connector:
    # required
    external_db_system_connector_id: "ocid1.externaldbsystemconnector.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Sample:
{'agent_id': 'ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_failure_message': 'connection_failure_message_example', 'connection_info': {'component_type': 'DATABASE', 'connection_credentials': {'credential_name': 'credential_name_example', 'credential_type': 'NAME_REFERENCE', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'role': 'SYSASM', 'ssl_secret_id': 'ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx', 'user_name': 'user_name_example'}, 'connection_string': {'host_name': 'host_name_example', 'hosts': [], 'port': 56, 'protocol': 'TCP', 'service': 'service_example'}}, 'connection_status': 'connection_status_example', 'connector_type': 'MACS', 'display_name': 'display_name_example', 'external_db_system_id': 'ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'time_connection_status_last_updated': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
agent_id
string
on success
The OCID of the management agent used for the external DB system connector.

Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_failure_message
string
on success
The error message indicating the reason for connection failure or `null` if the connection was successful.

Sample:
connection_failure_message_example
 
connection_info
complex
on success

   
component_type
string
on success
The component type.

Sample:
DATABASE
   
connection_credentials
complex
on success

     
credential_name
string
on success
The name of the credential information that used to connect to the DB system resource. 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 ASM instance.

Sample:
NAME_REFERENCE
     
password_secret_id
string
on success
The OCID of the secret containing the user password.

Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
     
role
string
on success
The role of the user connecting to the ASM instance.

Sample:
SYSASM
     
ssl_secret_id
string
on success
The OCID of the secret containing the SSL keystore and truststore details.

Sample:
ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx
     
user_name
string
on success
The user name used to connect to the ASM instance.

Sample:
user_name_example
   
connection_string
complex
on success

     
host_name
string
on success
The host name of the database or the SCAN name in case of a RAC database.

Sample:
host_name_example
     
hosts
list / elements=string
on success
The list of host names of the ASM instances.
     
port
integer
on success
The port used to connect to the ASM instance.

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

Sample:
TCP
     
service
string
on success
The service name of the ASM instance.

Sample:
service_example
 
connection_status
string
on success
The status of connectivity to the external DB system component.

Sample:
connection_status_example
 
connector_type
string
on success
The type of connector.

Sample:
MACS
 
display_name
string
on success
The user-friendly name for the external connector. The name does not have to be unique.

Sample:
display_name_example
 
external_db_system_id
string
on success
The OCID of the external DB system that the connector is a part of.

Sample:
ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of the external DB system connector.

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 DB system connector.

Sample:
CREATING
 
time_connection_status_last_updated
string
on success
The date and time the connectionStatus of the external DB system connector was last updated.

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

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the external DB system connector was last updated.

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


Authors

  • Oracle (@oracle)