oracle.oci.oci_golden_gate_connection_actions – Perform actions on a Connection resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Connection resource in Oracle Cloud Infrastructure
For action=change_compartment, moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
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 |
---|---|---|
action
string
/ required
|
|
The action to perform on the Connection.
|
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
|
|
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
/ required
|
The OCID of the compartment being referenced.
|
|
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
/ required
|
The OCID of a Connection.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|
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 |
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action change_compartment on connection
oci_golden_gate_connection_actions:
# required
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
connection
complex
|
on success |
Details of the Connection resource acted upon by the current operation
Sample:
{'access_key_id': 'ocid1.accesskey.oc1..xxxxxxEXAMPLExxxxxx', '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_factory': 'connection_factory_example', 'connection_string': 'connection_string_example', 'connection_type': 'GOLDENGATE', 'connection_url': 'connection_url_example', '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'}], 'jndi_connection_factory': 'jndi_connection_factory_example', 'jndi_initial_context_factory': 'jndi_initial_context_factory_example', 'jndi_provider_url': 'jndi_provider_url_example', 'jndi_security_principal': 'jndi_security_principal_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': 'PLAIN', 'servers': 'servers_example', 'session_mode': 'DIRECT', 'should_use_jndi': True, 'should_validate_server_certificate': True, 'ssl_ca': 'ssl_ca_example', 'ssl_mode': 'DISABLED', 'stream_pool_id': 'ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'technology_type': 'AMAZON_KINESIS', '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'}
|
||
access_key_id
string
|
on success |
Access key ID to access the Amazon Kinesis.
Sample:
ocid1.accesskey.oc1..xxxxxxEXAMPLExxxxxx
|
||
account_name
string
|
on success |
Sets the Azure storage account name.
Sample:
account_name_example
|
||
additional_attributes
complex
|
on success |
An array of name-value pair attribute entries. Used as additional parameters in connection string.
|
||
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.
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
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"`
|
||
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
Sample:
ocid1.client.oc1..xxxxxxEXAMPLExxxxxx
|
||
compartment_id
string
|
on success |
The OCID of the compartment being referenced.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connection_factory
string
|
on success |
The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
Sample:
connection_factory_example
|
||
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;'
Sample:
connection_string_example
|
||
connection_type
string
|
on success |
The connection type.
Sample:
GOLDENGATE
|
||
connection_url
string
|
on success |
Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'
Sample:
connection_url_example
|
||
database_id
string
|
on success |
The OCID of the Oracle Autonomous Json Database.
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_name
string
|
on success |
The name of the database.
Sample:
database_name_example
|
||
db_system_id
string
|
on success |
The OCID of the database system being referenced.
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.
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
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 |
Host and port separated by colon. Example: `"server.example.com:1234"`
For multiple hosts, provide a comma separated list. Example: `"server1.example.com:1000,server1.example.com:2000"`
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. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
|
||
ingress_ip
string
|
on success |
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
Sample:
ingress_ip_example
|
||
jndi_connection_factory
string
|
on success |
The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
Sample:
jndi_connection_factory_example
|
||
jndi_initial_context_factory
string
|
on success |
The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
Sample:
jndi_initial_context_factory_example
|
||
jndi_provider_url
string
|
on success |
The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
Sample:
jndi_provider_url_example
|
||
jndi_security_principal
string
|
on success |
Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
Sample:
jndi_security_principal_example
|
||
key_id
string
|
on success |
Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
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.
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
|
||
region
string
|
on success |
The name of the region. e.g.: us-ashburn-1
Sample:
us-phoenix-1
|
||
security_protocol
string
|
on success |
Security protocol for Elasticsearch
Sample:
PLAIN
|
||
servers
string
|
on success |
Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example: `"server1.example.com:4000,server2.example.com:4000"`
Sample:
servers_example
|
||
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.
Sample:
DIRECT
|
||
should_use_jndi
boolean
|
on success |
If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
Sample:
True
|
||
should_validate_server_certificate
boolean
|
on success |
If set to true, the driver validates the certificate that is sent by the database server.
Sample:
True
|
||
ssl_ca
string
|
on success |
Database Certificate - The base64 encoded content of pem file containing the server public key (for 1-way SSL).
Sample:
ssl_ca_example
|
||
ssl_mode
string
|
on success |
SSL modes for MySQL.
Sample:
DISABLED
|
||
stream_pool_id
string
|
on success |
The OCID of the stream pool being referenced.
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 Amazon Kinesis technology type.
Sample:
AMAZON_KINESIS
|
||
tenancy_id
string
|
on success |
The OCID of the related OCI tenancy.
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'
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.
Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx
|
||
username
string
|
on success |
The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
Sample:
username_example
|
||
vault_id
string
|
on success |
Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)