Try SpotterManage a DatabaseToolsConnection resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete a DatabaseToolsConnection resource in Oracle Cloud Infrastructure
For I(state=present), creates a new Database Tools connection.
This resource has the following action operations in the M(oracle.oci.oci_database_tools_connection_actions) module: change_compartment, validate.
- 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
type:
choices:
- MYSQL
- ORACLE_DATABASE
description:
- The DatabaseToolsConnection type.
- Required for create using I(state=present), update using I(state=present) with database_tools_connection_id
present.
type: str
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 DatabaseToolsConnection.
- Use I(state=present) to create or update a DatabaseToolsConnection.
- Use I(state=absent) to delete a DatabaseToolsConnection.
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
user_name:
description:
- The user name.
- This parameter is updatable.
type: str
key_stores:
description:
- 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.
elements: dict
suboptions:
key_store_content:
description:
- ''
suboptions:
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the key store.
type: str
value_type:
choices:
- SECRETID
description:
- The value type of the key store content.
required: true
type: str
type: dict
key_store_password:
description:
- ''
suboptions:
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the key store password.
type: str
value_type:
choices:
- SECRETID
description:
- The value type of the key store password.
required: true
type: str
type: dict
key_store_type:
choices:
- CLIENT_CERTIFICATE_PEM
- CLIENT_PRIVATE_KEY_PEM
- CA_CERTIFICATE_PEM
- JAVA_KEY_STORE
- JAVA_TRUST_STORE
- PKCS12
- SSO
description:
- The key store type.
type: str
type: list
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.
Example: `{"foo-namespace": {"bar-key": "value"}}`'
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
confidential information.
- 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 type is one of ['MYSQL', 'ORACLE_DATABASE']
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:
- '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.
type: dict
user_password:
description:
- ''
- This parameter is updatable.
suboptions:
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the user password.
required: true
type: str
value_type:
choices:
- SECRETID
description:
- The value type of the user password.
required: true
type: str
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment containing the Database Tools connection.
- 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
related_resource:
description:
- ''
- This parameter is updatable.
suboptions:
entity_type:
choices:
- MYSQLDBSYSTEM
- AUTONOMOUSDATABASE
- DATABASE
- PLUGGABLEDATABASE
description:
- The resource entity type.
- This parameter is updatable.
- Applicable when type is one of ['MYSQL', 'ORACLE_DATABASE']
type: str
identifier:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the related resource.
- This parameter is updatable.
- Applicable when type is one of ['MYSQL', 'ORACLE_DATABASE']
type: str
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
connection_string:
description:
- The connection string used to connect to the MySQL Server.
- This parameter is updatable.
type: str
advanced_properties:
description:
- The advanced connection properties key-value pair (e.g., `sslMode`).
- This parameter is updatable.
type: dict
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
private_endpoint_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Tools private endpoint used to access the database in the customer
VCN.
- This parameter is updatable.
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
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
database_tools_connection_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of a Database Tools connection.
- 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
database_tools_connection:
contains:
advanced_properties:
description:
- The advanced connection properties key-value pair (for example, `sslMode`).
returned: on success
sample: {}
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment containing the Database Tools connection.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
connection_string:
description:
- The connection string used to connect to the MySQL Server.
returned: on success
sample: connection_string_example
type: str
defined_tags:
description:
- 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 'Simple key-value pair that is applied without any predefined name, type or
scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`'
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 Database Tools connection.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
key_stores:
contains:
key_store_content:
contains:
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the key store.
returned: on success
sample: ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
type: str
value_type:
description:
- The value type of the key store content.
returned: on success
sample: SECRETID
type: str
description:
- ''
returned: on success
type: complex
key_store_password:
contains:
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the key store password.
returned: on success
sample: ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
type: str
value_type:
description:
- The value type of the key store password.
returned: on success
sample: SECRETID
type: str
description:
- ''
returned: on success
type: complex
key_store_type:
description:
- The key store type.
returned: on success
sample: CLIENT_CERTIFICATE_PEM
type: str
description:
- The CA certificate to verify the server's certificate and the client private
key and associated certificate required for client authentication.
returned: on success
type: complex
lifecycle_details:
description:
- 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.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the Database Tools connection.
returned: on success
sample: CREATING
type: str
private_endpoint_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Tools private endpoint used to access the database in the
customer VCN.
returned: on success
sample: ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx
type: str
related_resource:
contains:
entity_type:
description:
- The resource entity type.
returned: on success
sample: MYSQLDBSYSTEM
type: str
identifier:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the related resource.
returned: on success
sample: identifier_example
type: str
description:
- ''
returned: on success
type: complex
system_tags:
description:
- 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`'
returned: on success
sample: {}
type: dict
time_created:
description:
- The time the Database Tools connection was created. An RFC3339 formatted datetime
string.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime
string.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
type:
description:
- The Database Tools connection type.
returned: on success
sample: ORACLE_DATABASE
type: str
user_name:
description:
- The user name.
returned: on success
sample: user_name_example
type: str
user_password:
contains:
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.secret.oc1..xxxxxxEXAMPLExxxxxx
type: str
value_type:
description:
- The value type of the user password.
returned: on success
sample: SECRETID
type: str
description:
- ''
returned: on success
type: complex
description:
- Details of the DatabaseToolsConnection resource acted upon by the current operation
returned: on success
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
type: complex