oracle.oci.oci_mysql_channel_facts – Fetches details about one or multiple Channel resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_mysql_channel_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all the Channels that match the specified filters.

  • If channel_id is specified, the details of a single Channel 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.
channel_id
string
The Channel OCID.
Required to get a specific channel.

aliases: id
compartment_id
string
The compartment OCID.
Required to list multiple channels.
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.
db_system_id
string
The DB System OCID.
display_name
string
A filter to return only the resource matching the given display name exactly.

aliases: name
is_enabled
boolean
    Choices:
  • no
  • yes
If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • NEEDS_ATTENTION
  • INACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
The LifecycleState of the Channel.
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:
  • displayName
  • timeCreated
The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use (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 channel
  oci_mysql_channel_facts:
    # required
    channel_id: "ocid1.channel.oc1..xxxxxxEXAMPLExxxxxx"

- name: List channels
  oci_mysql_channel_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    channel_id: "ocid1.channel.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: CREATING
    is_enabled: true
    sort_by: displayName
    sort_order: ASC

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
channels
complex
on success
List of Channel resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'source': {'anonymous_transactions_handling': {'last_configured_log_filename': 'last_configured_log_filename_example', 'last_configured_log_offset': 56, 'policy': 'ERROR_ON_ANONYMOUS', 'uuid': None}, 'hostname': 'hostname_example', 'port': 56, 'source_type': 'MYSQL', 'ssl_ca_certificate': {'certificate_type': 'PEM', 'contents': 'contents_example'}, 'ssl_mode': 'VERIFY_IDENTITY', 'username': 'username_example'}, 'target': {'applier_username': 'applier_username_example', 'channel_name': 'channel_name_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'filters': [{'type': 'REPLICATE_DO_DB', 'value': 'value_example'}], 'target_type': 'DBSYSTEM'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
User provided description of the Channel.
Returned for get operation

Sample:
description_example
 
display_name
string
on success
The user-friendly name for the Channel. It does not have to be unique.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair 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 Channel.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_enabled
boolean
on success
Whether the Channel has been enabled by the user.

Sample:
True
 
lifecycle_details
string
on success
A message describing the state of the Channel.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The state of the Channel.

Sample:
CREATING
 
source
complex
on success

   
anonymous_transactions_handling
complex
on success

     
last_configured_log_filename
string
on success
Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

Sample:
last_configured_log_filename_example
     
last_configured_log_offset
integer
on success
Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

Sample:
56
     
policy
string
on success
Specifies how the replication channel handles anonymous transactions.

Sample:
ERROR_ON_ANONYMOUS
     
uuid
string
on success
The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

Sample:
null
   
hostname
string
on success
The network address of the MySQL instance.

Sample:
hostname_example
   
port
integer
on success
The port the source MySQL instance listens on.

Sample:
56
   
source_type
string
on success
The specific source identifier.

Sample:
MYSQL
   
ssl_ca_certificate
complex
on success

     
certificate_type
string
on success
The type of CA certificate.

Sample:
PEM
     
contents
string
on success
The string containing the CA certificate in PEM format.

Sample:
contents_example
   
ssl_mode
string
on success
The SSL mode of the Channel.

Sample:
VERIFY_IDENTITY
   
username
string
on success
The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

Sample:
username_example
 
target
complex
on success

   
applier_username
string
on success
The username for the replication applier of the target MySQL DB System.

Sample:
applier_username_example
   
channel_name
string
on success
The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.

Sample:
channel_name_example
   
db_system_id
string
on success
The OCID of the source DB System.

Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
   
filters
complex
on success
Replication filter rules to be applied at the DB System Channel target.

     
type
string
on success
The type of the filter rule.
For details on each type, see Replication Filtering Rules

Sample:
REPLICATE_DO_DB
     
value
string
on success
The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

Sample:
value_example
   
target_type
string
on success
The specific target identifier.

Sample:
DBSYSTEM
 
time_created
string
on success
The date and time the Channel was created, as described by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the Channel was last updated, as described by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)