oracle.oci.oci_mysql_channel – Manage a Channel 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_mysql_channel.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Channel resource in Oracle Cloud Infrastructure

  • For state=present, creates a Channel to establish replication from a source to a target.

  • This resource has the following action operations in the oracle.oci.oci_mysql_channel_actions module: reset, resume.

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
  • 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.
channel_id
string
The Channel OCID.
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
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.
defined_tags
dictionary
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
description
string
User provided information about the Channel.
This parameter is updatable.
display_name
string
The user-friendly name for the Channel. It does not have to be unique.
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
    Choices:
  • no ←
  • yes
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 applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
is_enabled
boolean
    Choices:
  • no
  • yes
Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
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.
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.
source
dictionary
Required for create using state=present.
This parameter is updatable.
anonymous_transactions_handling
dictionary
last_configured_log_filename
string
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.
Applicable when policy is one of ['ASSIGN_TARGET_UUID', 'ASSIGN_MANUAL_UUID']
last_configured_log_offset
integer
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.
Applicable when policy is one of ['ASSIGN_TARGET_UUID', 'ASSIGN_MANUAL_UUID']
policy
string / required
    Choices:
  • ERROR_ON_ANONYMOUS
  • ASSIGN_MANUAL_UUID
  • ASSIGN_TARGET_UUID
Specifies how the replication channel handles anonymous transactions.
uuid
string
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.
Applicable when policy is 'ASSIGN_MANUAL_UUID'
hostname
string
The network address of the MySQL instance.
This parameter is updatable.
Applicable when source_type is 'MYSQL'
password
string
The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
This parameter is updatable.
Applicable when source_type is 'MYSQL'
port
integer
The port the source MySQL instance listens on.
This parameter is updatable.
source_type
string / required
    Choices:
  • MYSQL
The specific source identifier.
This parameter is updatable.
ssl_ca_certificate
dictionary
certificate_type
string / required
    Choices:
  • PEM
The type of CA certificate.
contents
string / required
The string containing the CA certificate in PEM format.
ssl_mode
string
The SSL mode of the Channel.
This parameter is updatable.
Applicable when source_type is 'MYSQL'
username
string
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
This parameter is updatable.
Applicable when source_type is 'MYSQL'
state
string
    Choices:
  • present ←
  • absent
The state of the Channel.
Use state=present to create or update a Channel.
Use state=absent to delete a Channel.
target
dictionary
Required for create using state=present.
This parameter is updatable.
applier_username
string
The username for the replication applier of the target MySQL DB System.
This parameter is updatable.
channel_name
string
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.
This parameter is updatable.
db_system_id
string
The OCID of the target DB System.
delay_in_seconds
integer
Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
This parameter is updatable.
filters
list / elements=dictionary
Replication filter rules to be applied at the DB System Channel target.
type
string / required
    Choices:
  • REPLICATE_DO_DB
  • REPLICATE_IGNORE_DB
  • REPLICATE_DO_TABLE
  • REPLICATE_IGNORE_TABLE
  • REPLICATE_WILD_DO_TABLE
  • REPLICATE_WILD_IGNORE_TABLE
  • REPLICATE_REWRITE_DB
The type of the filter rule.
For details on each type, see Replication Filtering Rules
value
string / required
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.
tables_without_primary_key_handling
string
Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
This parameter is updatable.
target_type
string / required
    Choices:
  • DBSYSTEM
The specific target identifier.
This parameter is updatable.
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
wait
boolean
    Choices:
  • no
  • yes ←
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.

Examples

- name: Create channel
  oci_mysql_channel:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    source:
      # required
      source_type: MYSQL
      hostname: hostname_example
      username: username_example
      password: example-password
      ssl_mode: ssl_mode_example

      # optional
      port: 56
      ssl_ca_certificate:
        # required
        certificate_type: PEM
        contents: contents_example
      anonymous_transactions_handling:
        # required
        policy: ERROR_ON_ANONYMOUS
    target:
      # required
      db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
      target_type: DBSYSTEM

      # optional
      channel_name: channel_name_example
      applier_username: applier_username_example
      filters:
      - # required
        type: REPLICATE_DO_DB
        value: value_example
      tables_without_primary_key_handling: tables_without_primary_key_handling_example
      delay_in_seconds: 56

    # optional
    display_name: display_name_example
    is_enabled: true
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel
  oci_mysql_channel:
    # required
    channel_id: "ocid1.channel.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    source:
      # required
      source_type: MYSQL
      hostname: hostname_example
      username: username_example
      password: example-password
      ssl_mode: ssl_mode_example

      # optional
      port: 56
      ssl_ca_certificate:
        # required
        certificate_type: PEM
        contents: contents_example
      anonymous_transactions_handling:
        # required
        policy: ERROR_ON_ANONYMOUS
    target:
      # required
      db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
      target_type: DBSYSTEM

      # optional
      channel_name: channel_name_example
      applier_username: applier_username_example
      filters:
      - # required
        type: REPLICATE_DO_DB
        value: value_example
      tables_without_primary_key_handling: tables_without_primary_key_handling_example
      delay_in_seconds: 56
    display_name: display_name_example
    is_enabled: true
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_mysql_channel:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    source:
      # required
      source_type: MYSQL
      hostname: hostname_example
      username: username_example
      password: example-password
      ssl_mode: ssl_mode_example

      # optional
      port: 56
      ssl_ca_certificate:
        # required
        certificate_type: PEM
        contents: contents_example
      anonymous_transactions_handling:
        # required
        policy: ERROR_ON_ANONYMOUS
    target:
      # required
      db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
      target_type: DBSYSTEM

      # optional
      channel_name: channel_name_example
      applier_username: applier_username_example
      filters:
      - # required
        type: REPLICATE_DO_DB
        value: value_example
      tables_without_primary_key_handling: tables_without_primary_key_handling_example
      delay_in_seconds: 56
    is_enabled: true
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete channel
  oci_mysql_channel:
    # required
    channel_id: "ocid1.channel.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_mysql_channel:
    # 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
channel
complex
on success
Details of the Channel resource acted upon by the current operation

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', 'delay_in_seconds': 56, 'filters': [{'type': 'REPLICATE_DO_DB', 'value': 'value_example'}], 'tables_without_primary_key_handling': 'RAISE_ERROR', '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.

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
   
delay_in_seconds
integer
on success
Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.

Sample:
56
   
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
   
tables_without_primary_key_handling
string
on success
Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.

Sample:
RAISE_ERROR
   
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)