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.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_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 | |
---|---|---|---|
admin_credentials
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
||
password
string
|
Administrator password
This parameter is updatable.
|
||
username
string
|
Administrator username
This parameter is updatable.
|
||
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.
|
||
certificate_tdn
string
|
This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.
This parameter is updatable.
|
||
compartment_id
string
|
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 . |
||
connect_descriptor
dictionary
|
This parameter is updatable.
|
||
connect_string
string
|
Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: <host>:<port>/<db_service_name> Long format: (description= (address=(port=<port>)(host=<host>))(connect_data=(service_name=<db_service_name>)))
This parameter is updatable.
|
||
database_service_name
string
|
Database service name. Required if no connectString was specified.
This parameter is updatable.
|
||
host
string
|
Host or IP address of the connect descriptor. Required if no connectString was specified.
This parameter is updatable.
|
||
port
integer
|
Port of the connect descriptor. Required if no connectString was specified.
This parameter is updatable.
|
||
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 |
||
database_id
string
|
The OCID of the cloud database. Required if the database connection type is Autonomous.
This parameter is updatable.
|
||
database_type
string
|
|
Database connection type.
Required for create using state=present.
|
|
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.
|
||
display_name
string
|
Database Connection display name identifier.
Required for create, 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.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
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||
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.
|
||
manual_database_sub_type
string
|
|
Database manual connection subtype. This value can only be specified for manual connections.
|
|
nsg_ids
list
/ elements=string
|
An array of Network Security Group OCIDs used to define network access for Connections.
This parameter is updatable.
|
||
private_endpoint
dictionary
|
This parameter is updatable.
|
||
compartment_id
string
|
The OCID of the compartment to contain the private endpoint.
This parameter is updatable.
|
||
subnet_id
string
|
The OCID of the customer's subnet where the private endpoint VNIC will reside.
This parameter is updatable.
|
||
vcn_id
string
|
The OCID of the VCN where the Private Endpoint will be bound to.
This parameter is updatable.
|
||
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_credentials
dictionary
|
This parameter is updatable.
|
||
password
string
|
Administrator password
This parameter is updatable.
|
||
username
string
|
Administrator username
This parameter is updatable.
|
||
ssh_details
dictionary
|
This parameter is updatable.
|
||
host
string
|
Name of the host the SSH key is valid for.
This parameter is updatable.
|
||
sshkey
string
|
Private SSH key string.
This parameter is updatable.
|
||
sudo_location
string
|
Sudo location
This parameter is updatable.
|
||
user
string
|
SSH user
This parameter is updatable.
|
||
state
string
|
|
The state of the Connection.
Use state=present to create or update a Connection.
Use state=absent to delete a Connection.
|
|
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 |
||
tls_keystore
string
|
keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
This parameter is updatable.
|
||
tls_wallet
string
|
cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
This parameter is updatable.
|
||
vault_details
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
||
compartment_id
string
|
OCID of the compartment where the secret containing the credentials will be created.
This parameter is updatable.
|
||
key_id
string
|
OCID of the vault encryption key
This parameter is updatable.
|
||
vault_id
string
|
OCID of the vault
This parameter is updatable.
|
||
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: Create connection
oci_database_migration_connection:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
database_type: MANUAL
admin_credentials:
# optional
username: username_example
password: example-password
vault_details:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
# optional
manual_database_sub_type: ORACLE
display_name: display_name_example
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
connect_descriptor:
# optional
host: host_example
port: 56
database_service_name: database_service_name_example
connect_string: connect_string_example
certificate_tdn: certificate_tdn_example
tls_wallet: tls_wallet_example
tls_keystore: tls_keystore_example
ssh_details:
# optional
host: host_example
sshkey: sshkey_example
user: user_example
sudo_location: sudo_location_example
replication_credentials:
# optional
username: username_example
password: example-password
private_endpoint:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
- name: Update connection
oci_database_migration_connection:
# required
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
connect_descriptor:
# optional
host: host_example
port: 56
database_service_name: database_service_name_example
connect_string: connect_string_example
certificate_tdn: certificate_tdn_example
tls_wallet: tls_wallet_example
tls_keystore: tls_keystore_example
ssh_details:
# optional
host: host_example
sshkey: sshkey_example
user: user_example
sudo_location: sudo_location_example
admin_credentials:
# optional
username: username_example
password: example-password
replication_credentials:
# optional
username: username_example
password: example-password
private_endpoint:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
vault_details:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
- name: Update 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
# optional
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
connect_descriptor:
# optional
host: host_example
port: 56
database_service_name: database_service_name_example
connect_string: connect_string_example
certificate_tdn: certificate_tdn_example
tls_wallet: tls_wallet_example
tls_keystore: tls_keystore_example
ssh_details:
# optional
host: host_example
sshkey: sshkey_example
user: user_example
sudo_location: sudo_location_example
admin_credentials:
# optional
username: username_example
password: example-password
replication_credentials:
# optional
username: username_example
password: example-password
private_endpoint:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
vault_details:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
- 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:
Key | Returned | Description | ||
---|---|---|---|---|
connection
complex
|
on success |
Details of the Connection resource acted upon by the current operation
Sample:
{'admin_credentials': {'username': 'username_example'}, 'certificate_tdn': 'certificate_tdn_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connect_descriptor': {'connect_string': 'connect_string_example', 'database_service_name': 'database_service_name_example', 'host': 'host_example', 'port': 56}, 'credentials_secret_id': 'ocid1.credentialssecret.oc1..xxxxxxEXAMPLExxxxxx', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_type': 'MANUAL', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_dedicated': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'manual_database_sub_type': 'ORACLE', 'nsg_ids': [], 'private_endpoint': {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}, 'replication_credentials': {'username': 'username_example'}, 'ssh_details': {'host': 'host_example', 'sudo_location': 'sudo_location_example', 'user': 'user_example'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vault_details': {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}}
|
||
admin_credentials
complex
|
on success |
|
||
username
string
|
on success |
Administrator username
Sample:
username_example
|
||
certificate_tdn
string
|
on success |
This name is the distinguished name used while creating the certificate on target database.
Sample:
certificate_tdn_example
|
||
compartment_id
string
|
on success |
OCID of the compartment
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connect_descriptor
complex
|
on success |
|
||
connect_string
string
|
on success |
Connect string.
Sample:
connect_string_example
|
||
database_service_name
string
|
on success |
Database service name.
Sample:
database_service_name_example
|
||
host
string
|
on success |
Host of the connect descriptor.
Sample:
host_example
|
||
port
integer
|
on success |
Port of the connect descriptor.
Sample:
56
|
||
credentials_secret_id
string
|
on success |
OCID of the Secret in the OCI vault containing the Database Connection credentials.
Sample:
ocid1.credentialssecret.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_id
string
|
on success |
The OCID of the cloud database.
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
||
database_type
string
|
on success |
Database connection type.
Sample:
MANUAL
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
Database Connection display name identifier.
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
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'}
|
||
id
string
|
on success |
The OCID of the resource
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_dedicated
boolean
|
on success |
True if the Autonomous Connection is dedicated. Not provided for Non-Autonomous Connections.
Sample:
True
|
||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the Connection resource.
Sample:
CREATING
|
||
manual_database_sub_type
string
|
on success |
Database manual connection subtype. This value can only be specified for manual connections.
Sample:
ORACLE
|
||
nsg_ids
list
/ elements=string
|
on success |
An array of Network Security Group OCIDs used to define network access for Connections.
|
||
private_endpoint
complex
|
on success |
|
||
compartment_id
string
|
on success |
The OCID of the compartment to contain the private endpoint.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
id
string
|
on success |
OCID of a previously created Private Endpoint.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
subnet_id
string
|
on success |
The OCID of the customer's subnet where the private endpoint VNIC will reside.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||
vcn_id
string
|
on success |
The OCID of the VCN where the Private Endpoint will be bound to.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
||
replication_credentials
complex
|
on success |
|
||
username
string
|
on success |
Administrator username
Sample:
username_example
|
||
ssh_details
complex
|
on success |
|
||
host
string
|
on success |
Name of the host the SSH key is valid for.
Sample:
host_example
|
||
sudo_location
string
|
on success |
Sudo location
Sample:
sudo_location_example
|
||
user
string
|
on success |
SSH user
Sample:
user_example
|
||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||
time_created
string
|
on success |
The time the Connection resource was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time of the last Connection resource details update. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
vault_details
complex
|
on success |
|
||
compartment_id
string
|
on success |
OCID of the compartment where the secret containing the credentials will be created.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
key_id
string
|
on success |
OCID of the vault encryption key
Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
|
||
vault_id
string
|
on success |
OCID of the vault
Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)