oracle.oci.oci_golden_gate_connection_facts – Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_golden_gate_connection_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure
Lists the Connections in the compartment.
If connection_id is specified, the details of a single Connection will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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 ). |
|
assignable_deployment_id
string
|
Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
|
|
assignable_deployment_type
string
|
|
Filters for connections which can be assigned to the latest version of the specified deployment type.
|
assigned_deployment_id
string
|
The OCID of the deployment which for the connection must be assigned.
|
|
auth_purpose
string
|
|
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
|
|
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 in which to list resources.
Required to list multiple connections.
|
|
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 . |
|
connection_id
string
|
The OCID of a Connection.
Required to get a specific connection.
aliases: id |
|
connection_type
list
/ elements=string
|
|
The array of connection types.
|
display_name
string
|
A filter to return only the resources that match the entire 'displayName' given.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only connections having the 'lifecycleState' given.
|
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
|
|
The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default.
|
sort_order
string
|
|
The sort order to use, either 'asc' or 'desc'.
|
technology_type
list
/ elements=string
|
|
The array of technology types.
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific connection
oci_golden_gate_connection_facts:
# required
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: List connections
oci_golden_gate_connection_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
technology_type: [ "GOLDENGATE" ]
connection_type: [ "GOLDENGATE" ]
assigned_deployment_id: "ocid1.assigneddeployment.oc1..xxxxxxEXAMPLExxxxxx"
assignable_deployment_id: "ocid1.assignabledeployment.oc1..xxxxxxEXAMPLExxxxxx"
assignable_deployment_type: OGG
lifecycle_state: CREATING
display_name: display_name_example
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
connections
complex
|
on success |
List of Connection resources
Sample:
[{'account_name': 'account_name_example', 'additional_attributes': [{'name': 'name_example', 'value': 'value_example'}], 'authentication_type': 'SHARED_KEY', 'azure_tenant_id': 'ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx', 'bootstrap_servers': [{'host': 'host_example', 'port': 56, 'private_ip': 'private_ip_example'}], 'client_id': 'ocid1.client.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'connection_type': 'GOLDENGATE', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'endpoint': 'endpoint_example', 'freeform_tags': {'Department': 'Finance'}, 'host': 'host_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ingress_ips': [{'ingress_ip': 'ingress_ip_example'}], 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'nsg_ids': [], 'port': 56, 'private_ip': 'private_ip_example', 'region': 'us-phoenix-1', 'security_protocol': 'SSL', 'session_mode': 'DIRECT', 'ssl_mode': 'DISABLED', 'stream_pool_id': 'ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'technology_type': 'AZURE_DATA_LAKE_STORAGE', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'url': 'url_example', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx', 'username': 'username_example', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}]
|
||
account_name
string
|
on success |
Sets the Azure storage account name.
Returned for get operation
Sample:
account_name_example
|
||
additional_attributes
complex
|
on success |
An array of name-value pair attribute entries. Used as additional parameters in connection string.
Returned for get operation
|
||
name
string
|
on success |
The name of the property entry.
Sample:
name_example
|
||
value
string
|
on success |
The value of the property entry.
Sample:
value_example
|
||
authentication_type
string
|
on success |
Used authentication mechanism to access Azure Data Lake Storage.
Returned for get operation
Sample:
SHARED_KEY
|
||
azure_tenant_id
string
|
on success |
Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
Returned for get operation
Sample:
ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx
|
||
bootstrap_servers
complex
|
on success |
Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: `"server1.example.com:9092,server2.example.com:9092"`
Returned for get operation
|
||
host
string
|
on success |
The name or address of a host.
Sample:
host_example
|
||
port
integer
|
on success |
The port of an endpoint usually specified for a connection.
Sample:
56
|
||
private_ip
string
|
on success |
The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
Sample:
private_ip_example
|
||
client_id
string
|
on success |
Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
Returned for get operation
Sample:
ocid1.client.oc1..xxxxxxEXAMPLExxxxxx
|
||
compartment_id
string
|
on success |
The OCID of the compartment being referenced.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connection_string
string
|
on success |
JDBC connection string. e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db- name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
Returned for get operation
Sample:
connection_string_example
|
||
connection_type
string
|
on success |
The connection type.
Sample:
GOLDENGATE
|
||
database_id
string
|
on success |
The OCID of the database being referenced.
Returned for get operation
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_name
string
|
on success |
The name of the database.
Returned for get operation
Sample:
database_name_example
|
||
db_system_id
string
|
on success |
The OCID of the database system being referenced.
Returned for get operation
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
deployment_id
string
|
on success |
The OCID of the deployment being referenced.
Returned for get operation
Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
|
||
description
string
|
on success |
Metadata about this specific object.
Sample:
description_example
|
||
display_name
string
|
on success |
An object's Display Name.
Sample:
display_name_example
|
||
endpoint
string
|
on success |
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
Returned for get operation
Sample:
endpoint_example
|
||
freeform_tags
dictionary
|
on success |
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
host
string
|
on success |
The name or address of a host.
Returned for get operation
Sample:
host_example
|
||
id
string
|
on success |
The OCID of the connection being referenced.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
ingress_ips
complex
|
on success |
List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
|
||
ingress_ip
string
|
on success |
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
Sample:
ingress_ip_example
|
||
key_id
string
|
on success |
The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_details
string
|
on success |
Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
Possible lifecycle states for connection.
Sample:
CREATING
|
||
nsg_ids
list
/ elements=string
|
on success |
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
|
||
port
integer
|
on success |
The port of an endpoint usually specified for a connection.
Returned for get operation
Sample:
56
|
||
private_ip
string
|
on success |
The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
Returned for get operation
Sample:
private_ip_example
|
||
region
string
|
on success |
The name of the region. e.g.: us-ashburn-1
Returned for get operation
Sample:
us-phoenix-1
|
||
security_protocol
string
|
on success |
Kafka security protocol.
Returned for get operation
Sample:
SSL
|
||
session_mode
string
|
on success |
The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
Returned for get operation
Sample:
DIRECT
|
||
ssl_mode
string
|
on success |
SSL modes for MySQL.
Returned for get operation
Sample:
DISABLED
|
||
stream_pool_id
string
|
on success |
The OCID of the stream pool being referenced.
Returned for get operation
Sample:
ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx
|
||
subnet_id
string
|
on success |
The OCID of the subnet being referenced.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||
system_tags
dictionary
|
on success |
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: `{orcl-cloud: {free-tier-retain: true}}`
|
||
technology_type
string
|
on success |
The Azure Data Lake Storage technology type.
Returned for get operation
Sample:
AZURE_DATA_LAKE_STORAGE
|
||
tenancy_id
string
|
on success |
The OCID of the related OCI tenancy.
Returned for get operation
Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
url
string
|
on success |
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
Returned for get operation
Sample:
url_example
|
||
user_id
string
|
on success |
The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
Returned for get operation
Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx
|
||
username
string
|
on success |
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
Returned for get operation
Sample:
username_example
|
||
vault_id
string
|
on success |
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)