Try SpotterFetches details about one or multiple DatabaseToolsConnection resources 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.0Fetches details about one or multiple DatabaseToolsConnection resources in Oracle Cloud Infrastructure
Returns a list of Database Tools connections.
If I(database_tools_connection_id) is specified, the details of a single DatabaseToolsConnection will be returned.
- name: Get a specific database_tools_connection
oci_database_tools_connection_facts:
# required
database_tools_connection_id: "ocid1.databasetoolsconnection.oc1..xxxxxxEXAMPLExxxxxx"
- name: List database_tools_connections
oci_database_tools_connection_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
lifecycle_state: CREATING
display_name: display_name_example
type: [ "ORACLE_DATABASE" ]
sort_order: ASC
sort_by: timeCreated
type:
choices:
- ORACLE_DATABASE
- MYSQL
description:
- A filter to return only resources their type matches the specified type.
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
sort_by:
choices:
- timeCreated
- displayName
description:
- The field to sort by. Only one sort order may be provided. Default order for timeCreated
is descending. Default order for displayName is ascending. If no value is specified
timeCreated is default.
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either 'asc' or 'desc'.
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:
- A filter to return only resources that match the entire specified display name.
type: str
compartment_id:
description:
- The ID of the compartment in which to list resources.
- Required to list multiple database_tools_connections.
type: str
lifecycle_state:
choices:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
description:
- A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`.
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
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
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 to get a specific database_tools_connection.
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_connections:
contains:
advanced_properties:
description:
- The advanced connection properties key-value pair (for example, `sslMode`).
- Returned for get operation
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 for get operation
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 for get operation
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 for get operation
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 for get operation
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 for get operation
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 for get operation
returned: on success
type: complex
description:
- List of DatabaseToolsConnection resources
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