oracle.oci.oci_database_management_external_db_system_connector_facts – Fetches details about one or multiple ExternalDbSystemConnector resources 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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ExternalDbSystemConnector resources in Oracle Cloud Infrastructure

  • Lists the external connectors in the specified external DB system.

  • If external_db_system_connector_id is specified, the details of a single ExternalDbSystemConnector will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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.
compartment_id
string
The OCID of the compartment.
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.
display_name
string
A filter to only return the resources that match the entire display name.

aliases: name
external_db_system_connector_id
string
The OCID of the external connector.
Required to get a specific external_db_system_connector.

aliases: id
external_db_system_id
string
The OCID of the external DB system.
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.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
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

Examples

- name: Get a specific external_db_system_connector
  oci_database_management_external_db_system_connector_facts:
    # required
    external_db_system_connector_id: "ocid1.externaldbsystemconnector.oc1..xxxxxxEXAMPLExxxxxx"

- name: List external_db_system_connectors
  oci_database_management_external_db_system_connector_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    external_db_system_id: "ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
external_db_system_connectors
complex
on success
List of ExternalDbSystemConnector resources

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.
Returned for get operation

Sample:
connection_failure_message_example
 
connection_info
complex
on success
Returned for get operation

   
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.
Returned for get operation

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.
Returned for get operation

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)