oracle.oci.oci_database_migration_connection_actions – Perform actions on a Connection resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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_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, used to change the Database Connection compartment.

  • For action=connection_diagnostics, perform connection test for a database connection.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • connection_diagnostics
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
    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.
Required for action=change_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.
connection_id
string / required
The OCID of the database connection.

aliases: id
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.
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: Perform action change_compartment on connection
  oci_database_migration_connection_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action connection_diagnostics on connection
  oci_database_migration_connection_actions:
    # required
    connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
    action: connection_diagnostics

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:
{'additional_attributes': [{'name': 'name_example', 'value': 'value_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'connection_type': 'MYSQL', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_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': [], 'password': 'example-password', 'port': 56, 'private_endpoint_id': 'ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx', 'replication_password': 'example-password', 'replication_username': 'replication_username_example', 'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'security_protocol': 'PLAIN', 'ssh_host': 'ssh_host_example', 'ssh_key': 'ssh_key_example', 'ssh_sudo_location': 'ssh_sudo_location_example', 'ssh_user': 'ssh_user_example', 'ssl_mode': 'DISABLED', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'technology_type': 'AMAZON_AURORA_MYSQL', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'username': 'username_example', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}
 
additional_attributes
complex
on success
An array of name-value pair attribute entries.
   
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
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_string
string
on success
Connect descriptor or Easy Connect Naming method used to connect to a database.

Sample:
connection_string_example
 
connection_type
string
on success
Defines the type of connection. For example, ORACLE.

Sample:
MYSQL
 
database_id
string
on success
The OCID of the database being referenced.

Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
 
database_name
string
on success
The name of the database being referenced.

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
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
description_example
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
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"}

Sample:
{'Department': 'Finance'}
 
host
string
on success
The IP Address of the host.

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 to connect 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 key used in cryptographic operations.

Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The Connection's current lifecycle state.

Sample:
CREATING
 
nsg_ids
list / elements=string
on success
An array of Network Security Group OCIDs used to define network access for Connections.
 
password
string
on success
The password (credential) used when creating or updating this resource.

Sample:
example-password
 
port
integer
on success
The port to be used for the connection.

Sample:
56
 
private_endpoint_id
string
on success
The OCID of the resource being referenced.

Sample:
ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx
 
replication_password
string
on success
The password (credential) used when creating or updating this resource.

Sample:
example-password
 
replication_username
string
on success
The username (credential) used when creating or updating this resource.

Sample:
replication_username_example
 
secret_id
string
on success
The OCID of the resource being referenced.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
 
security_protocol
string
on success
Security Protocol to be used for the connection.

Sample:
PLAIN
 
ssh_host
string
on success
Name of the host the SSH key is valid for.

Sample:
ssh_host_example
 
ssh_key
string
on success
Private SSH key string.

Sample:
ssh_key_example
 
ssh_sudo_location
string
on success
Sudo location

Sample:
ssh_sudo_location_example
 
ssh_user
string
on success
The username (credential) used when creating or updating this resource.

Sample:
ssh_user_example
 
ssl_mode
string
on success
SSL mode to be used for the connection.

Sample:
DISABLED
 
subnet_id
string
on success
OCI resource ID.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
technology_type
string
on success
The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service

Sample:
AMAZON_AURORA_MYSQL
 
time_created
string
on success
The time when this resource was created. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when this resource was updated. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
username
string
on success
The username (credential) used when creating or updating this resource.

Sample:
username_example
 
vault_id
string
on success
OCI resource ID.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
diagnostics_result
complex
on success
Details of the Connection resource acted upon by the current operation

Sample:
{'error': {'action': 'action_example', 'code': 'code_example', 'issue': 'issue_example', 'message': 'message_example'}, 'result_type': 'SUCCEEDED'}
 
error
complex
on success

   
action
string
on success
The text describing the action required to fix the issue

Sample:
action_example
   
code
string
on success
A short error code that defines the error, meant for programmatic parsing.

Sample:
code_example
   
issue
string
on success
The text describing the root cause of the reported issue

Sample:
issue_example
   
message
string
on success
A human-readable error string.

Sample:
message_example
 
result_type
string
on success
Type of the Result (i.e. Success or Failure).

Sample:
SUCCEEDED


Authors

  • Oracle (@oracle)