oracle.oci.oci_database_migration_connection – Manage a Connection resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_migration_connection.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Connection resource in Oracle Cloud Infrastructure
For state=present, create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.
This resource has the following action operations in the oracle.oci.oci_database_migration_connection_actions module: change_compartment, connection_diagnostics.
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 | |
|---|---|---|---|
|
additional_attributes
list
/ elements=dictionary
|
An array of name-value pair attribute entries.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
name
string
/ required
|
The name of the property entry.
Required when connection_type is 'MYSQL'
|
||
|
value
string
/ required
|
The value of the property entry.
Required when connection_type is 'MYSQL'
|
||
|
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
|
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
|
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 the database connection.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
|
connection_string
string
|
Connect descriptor or Easy Connect Naming method used to connect to a database.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
connection_type
string
|
|
Defines the type of connection. For example, ORACLE.
Required for create using state=present, update using state=present with connection_id present.
Applicable when connection_type is one of ['MYSQL', 'ORACLE']
|
|
|
database_id
string
|
The OCID of the database being referenced.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
database_name
string
|
The name of the database being referenced.
This parameter is updatable.
Required when connection_type is 'MYSQL'
|
||
|
db_system_id
string
|
The OCID of the database system being referenced.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
|
description
string
|
A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This parameter is updatable.
|
||
|
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.Applicable when connection_type is one of ['MYSQL', 'ORACLE']
aliases: name |
||
|
force_create
boolean
|
|
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 key_by.
|
|
|
freeform_tags
dictionary
|
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
This parameter is updatable.
|
||
|
host
string
|
The IP Address of the host.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
key_by
list
/ elements=string
|
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.
|
||
|
key_id
string
|
The OCID of the key used in cryptographic operations.
Required for create using state=present.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'ORACLE']
|
||
|
nsg_ids
list
/ elements=string
|
An array of Network Security Group OCIDs used to define network access for Connections.
This parameter is updatable.
|
||
|
password
string
|
The password (credential) used when creating or updating this resource.
Required for create using state=present.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'ORACLE']
|
||
|
port
integer
|
The port to be used for the connection.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
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. |
||
|
replication_password
string
|
The password (credential) used when creating or updating this resource.
This parameter is updatable.
|
||
|
replication_username
string
|
The username (credential) used when creating or updating this resource.
This parameter is updatable.
|
||
|
security_protocol
string
|
Security Type for MySQL.
This parameter is updatable.
Required when connection_type is 'MYSQL'
|
||
|
ssh_host
string
|
Name of the host the SSH key is valid for.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
ssh_key
string
|
Private SSH key string.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
ssh_sudo_location
string
|
Sudo location
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
ssh_user
string
|
The username (credential) used when creating or updating this resource.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
|
ssl_ca
string
|
Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
ssl_cert
string
|
Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
ssl_crl
string
|
Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
ssl_key
string
|
Client Key - The client-key.pem containing the client private key (for 2-way SSL).
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
ssl_mode
string
|
SSL modes for MySQL.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
|
||
|
state
string
|
|
The state of the Connection.
Use state=present to create or update a Connection.
Use state=absent to delete a Connection.
|
|
|
subnet_id
string
|
OCI resource ID.
This parameter is updatable.
|
||
|
technology_type
string
|
The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service
Required for create using state=present.
|
||
|
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 |
||
|
username
string
|
The username (credential) used when creating or updating this resource.
Required for create using state=present.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'ORACLE']
|
||
|
vault_id
string
|
OCI resource ID.
Required for create using state=present.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'ORACLE']
|
||
|
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.
|
||
|
wallet
string
|
The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
|
||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create connection with connection_type = MYSQL
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
technology_type: technology_type_example
connection_type: MYSQL
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
host: host_example
port: 56
database_name: database_name_example
security_protocol: security_protocol_example
ssl_mode: ssl_mode_example
ssl_ca: ssl_ca_example
ssl_crl: ssl_crl_example
ssl_cert: ssl_cert_example
ssl_key: ssl_key_example
additional_attributes:
- # required
name: name_example
value: value_example
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
- name: Create connection with connection_type = ORACLE
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
technology_type: technology_type_example
connection_type: ORACLE
# optional
connection_string: connection_string_example
wallet: wallet_example
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
ssh_host: ssh_host_example
ssh_key: ssh_key_example
ssh_user: ssh_user_example
ssh_sudo_location: ssh_sudo_location_example
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
- name: Update connection with connection_type = MYSQL
oci_database_migration_connection:
# required
connection_type: MYSQL
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
host: host_example
port: 56
database_name: database_name_example
security_protocol: security_protocol_example
ssl_mode: ssl_mode_example
ssl_ca: ssl_ca_example
ssl_crl: ssl_crl_example
ssl_cert: ssl_cert_example
ssl_key: ssl_key_example
additional_attributes:
- # required
name: name_example
value: value_example
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update connection with connection_type = ORACLE
oci_database_migration_connection:
# required
connection_type: ORACLE
# optional
connection_string: connection_string_example
wallet: wallet_example
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
ssh_host: ssh_host_example
ssh_key: ssh_key_example
ssh_user: ssh_user_example
ssh_sudo_location: ssh_sudo_location_example
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = MYSQL
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
connection_type: MYSQL
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
host: host_example
port: 56
database_name: database_name_example
security_protocol: security_protocol_example
ssl_mode: ssl_mode_example
ssl_ca: ssl_ca_example
ssl_crl: ssl_crl_example
ssl_cert: ssl_cert_example
ssl_key: ssl_key_example
additional_attributes:
- # required
name: name_example
value: value_example
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = ORACLE
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
connection_type: ORACLE
# optional
connection_string: connection_string_example
wallet: wallet_example
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
ssh_host: ssh_host_example
ssh_key: ssh_key_example
ssh_user: ssh_user_example
ssh_sudo_location: ssh_sudo_location_example
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
nsg_ids: [ "nsg_ids_example" ]
username: username_example
password: example-password
replication_username: replication_username_example
replication_password: example-password
- name: Delete connection
oci_database_migration_connection:
# required
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)