oracle.oci.oci_database_migration_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.10.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure

  • List all Database Connections.

  • 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.

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).
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
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 ID 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 the database connection
Required to get a specific connection.

aliases: id
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETING
  • DELETED
  • FAILED
The current state of the Database Migration Deployment.
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
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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: Get a specific connection
  oci_database_migration_connection_facts:
    # required
    connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"

- name: List connections
  oci_database_migration_connection_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    sort_by: timeCreated
    sort_order: ASC
    lifecycle_state: CREATING

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:
[{'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'}, '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
Returned for get operation

   
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.
Returned for get operation

Sample:
certificate_tdn_example
 
compartment_id
string
on success
OCID of the compartment

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connect_descriptor
complex
on success
Returned for get operation

   
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.
Returned for get operation

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
Returned for get operation

   
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
 
ssh_details
complex
on success
Returned for get operation

   
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
Returned for get operation

   
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)