oracle / oracle.oci / 4.43.0 / module / oci_database_external_database_connector Manage an ExternalDatabaseConnector 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_database_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 ExternalDatabaseConnector resource in Oracle Cloud Infrastructure
For I(state=present), creates a new external database connector.
This resource has the following action operations in the M(oracle.oci.oci_database_external_database_connector_actions) module: check_external_database_connector_connection_status.
- 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 ssl_secret_id: "ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx" credential_type: SSL_DETAILS username: username_example password: example-password role: SYSDBA # optional 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 ssl_secret_id: "ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx" credential_type: SSL_DETAILS username: username_example password: example-password role: SYSDBA # optional 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 ssl_secret_id: "ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx" credential_type: SSL_DETAILS username: username_example password: example-password role: SYSDBA # optional 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
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 ExternalDatabaseConnector. - Use I(state=present) to create or update an ExternalDatabaseConnector. - Use I(state=absent) to delete an ExternalDatabaseConnector. 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 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 L(external database connector,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Applicable when connector_type is 'MACS' 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 compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - 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 connector_type: choices: - MACS default: MACS description: - The type of connector used by the external database resource. - This parameter is updatable. 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 connection_string: description: - '' - Required for create using I(state=present). - This parameter is updatable. - Applicable when connector_type is 'MACS' suboptions: hostname: description: - The host name of the database. required: true type: str port: description: - The port used to connect to the database. required: true type: int protocol: choices: - TCP - TCPS description: - The protocol used to connect to the database. required: true type: str service: description: - The name of the service alias used to connect to the database. required: true type: str type: dict connector_agent_id: description: - The ID of the agent used for the L(external database connector,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). - Required for create using I(state=present). 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_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external database resource. - 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 connection_credentials: description: - '' - Required for create using I(state=present). - This parameter is updatable. - Applicable when connector_type is 'MACS' suboptions: credential_name: description: - 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' type: str credential_type: choices: - SSL_DETAILS - NAME_REFERENCE - DETAILS default: DETAILS description: - The type of credential used to connect to the database. type: str password: description: - The password that will be used to connect to the database. - Required when credential_type is one of ['SSL_DETAILS', 'DETAILS'] type: str role: choices: - SYSDBA - NORMAL description: - The role of the user that will be connecting to the database. - 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 Oracle Cloud Infrastructure L(secret,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). - Required when credential_type is 'SSL_DETAILS' type: str username: description: - The username that will be used to connect to the database. - Required when credential_type is one of ['SSL_DETAILS', 'DETAILS'] type: str type: dict 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_database_connector_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external database connector resource (`ExternalDatabaseConnectorId`). - 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_database_connector: contains: 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_credentials: contains: credential_name: description: - 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' returned: on success sample: credential_name_example type: str credential_type: description: - The type of credential used to connect to the database. returned: on success sample: NAME_REFERENCE type: str password: description: - The password that will be used to connect to the database. returned: on success sample: example-password type: str role: description: - The role of the user that will be connecting to the database. returned: on success sample: SYSDBA type: str ssl_secret_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure L(secret,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). returned: on success sample: ocid1.sslsecret.oc1..xxxxxxEXAMPLExxxxxx type: str username: description: - The username that will be used to connect to the database. returned: on success sample: username_example type: str description: - '' returned: on success type: complex connection_status: description: - The status of connectivity to the external database. returned: on success sample: connection_status_example type: str connection_string: contains: hostname: description: - The host name of the database. returned: on success sample: hostname_example type: str port: description: - The port used to connect to the database. returned: on success sample: 56 type: int protocol: description: - The protocol used to connect to the database. returned: on success sample: TCP type: str service: description: - The name of the service alias used to connect to the database. returned: on success sample: service_example type: str description: - '' returned: on success type: complex connector_agent_id: description: - The ID of the agent used for the L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). returned: on success sample: ocid1.connectoragent.oc1..xxxxxxEXAMPLExxxxxx type: str connector_type: description: - The type of connector used by the external database resource. returned: on success sample: MACS 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 L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. returned: on success sample: display_name_example type: str external_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external database resource. returned: on success sample: ocid1.externaldatabase.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 L(external database connector,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). 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 database connector resource. returned: on success sample: PROVISIONING type: str time_connection_status_last_updated: description: - The date and time the connectionStatus of this external 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 connector was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the ExternalDatabaseConnector resource acted upon by the current operation returned: on success 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' type: complex