oracle / oracle.oci / 4.43.0 / module / oci_database_management_external_db_system_connector Manage an ExternalDbSystemConnector resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_external_db_system_connector (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
This module allows the user to create, update and delete an ExternalDbSystemConnector resource in Oracle Cloud Infrastructure
For I(state=present), creates a new external connector.
This resource has the following action operations in the M(oracle.oci.oci_database_management_external_db_system_connector_actions) module: check_external_db_system_connector_connection_status.
- 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
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 ExternalDbSystemConnector. - Use I(state=present) to create or update an ExternalDbSystemConnector. - Use I(state=absent) to delete an ExternalDbSystemConnector. 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 agent_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. - Required for create using I(state=present). 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 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 display_name: aliases: - name description: - The user-friendly name for the external connector. The name does not have to be unique. - Required for create, update, 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 connector_type: choices: - MACS description: - The type of connector. - Required for create using I(state=present), update using I(state=present) with external_db_system_connector_id present. type: str connection_info: description: - '' - Required for update using I(state=present) with external_db_system_connector_id present. - Applicable when connector_type is 'MACS' suboptions: component_type: choices: - ASM - DATABASE description: - The component type. required: true type: str connection_credentials: description: - '' required: true suboptions: credential_name: description: - 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' type: str credential_type: choices: - NAME_REFERENCE - DETAILS - SSL_DETAILS default: DETAILS description: - The type of credential used to connect to the ASM instance. type: str password_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the secret containing the user password. - Required when credential_type is one of ['SSL_DETAILS', 'DETAILS'] type: str role: choices: - SYSASM - SYSDBA - SYSOPER - NORMAL description: - The role of the user connecting to the ASM instance. - Required when credential_type is one of ['SSL_DETAILS', 'DETAILS'] type: str ssl_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. - Required when credential_type is 'SSL_DETAILS' type: str user_name: description: - The user name used to connect to the ASM instance. - Required when credential_type is one of ['SSL_DETAILS', 'DETAILS'] type: str type: dict connection_string: description: - '' required: true suboptions: host_name: description: - The host name of the database or the SCAN name in case of a RAC database. - Required when component_type is 'DATABASE' type: str hosts: description: - The list of host names of the ASM instances. - Required when component_type is 'ASM' elements: str type: list port: description: - The port used to connect to the ASM instance. required: true type: int protocol: choices: - TCP - TCPS description: - The protocol used to connect to the ASM instance. required: true type: str service: description: - The service name of the ASM instance. required: true type: str type: dict type: dict 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 external_db_system_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system. - Required for create using I(state=present). 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_db_system_connector_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external connector. - 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_db_system_connector: contains: agent_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. returned: on success sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx 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 connection_failure_message: description: - The error message indicating the reason for connection failure or `null` if the connection was successful. returned: on success sample: connection_failure_message_example type: str connection_info: contains: component_type: description: - The component type. returned: on success sample: DATABASE type: str connection_credentials: contains: credential_name: description: - 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' returned: on success sample: credential_name_example type: str credential_type: description: - The type of credential used to connect to the ASM instance. returned: on success sample: NAME_REFERENCE type: str password_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the secret containing the user password. returned: on success sample: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx type: str role: description: - The role of the user connecting to the ASM instance. returned: on success sample: SYSASM type: str ssl_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. returned: on success sample: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx type: str user_name: description: - The user name used to connect to the ASM instance. returned: on success sample: user_name_example type: str description: - '' returned: on success type: complex connection_string: contains: host_name: description: - The host name of the database or the SCAN name in case of a RAC database. returned: on success sample: host_name_example type: str hosts: description: - The list of host names of the ASM instances. returned: on success sample: [] type: list port: description: - The port used to connect to the ASM instance. returned: on success sample: 56 type: int protocol: description: - The protocol used to connect to the ASM instance. returned: on success sample: TCP type: str service: description: - The service name of the ASM instance. returned: on success sample: service_example type: str description: - '' returned: on success type: complex description: - '' returned: on success type: complex connection_status: description: - The status of connectivity to the external DB system component. returned: on success sample: connection_status_example type: str connector_type: description: - The type of connector. returned: on success sample: MACS type: str display_name: description: - The user-friendly name for the external connector. The name does not have to be unique. returned: on success sample: display_name_example type: str external_db_system_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system that the connector is a part of. returned: on success sample: ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system connector. 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 lifecycle state of the external DB system connector. returned: on success sample: CREATING type: str time_connection_status_last_updated: description: - The date and time the connectionStatus of the external DB system connector was last updated. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_created: description: - The date and time the external DB system connector was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The date and time the external DB system connector was last updated. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the ExternalDbSystemConnector resource acted upon by the current operation returned: on success 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' type: complex