oracle.oci.oci_mysql_replica – Manage a Replica 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_mysql_replica.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a DB System read replica.

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.
compartment_id
string
The compartment OCID.
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.
db_system_id
string
The OCID of the DB System the read replica is associated with.
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.
description
string
User provided description of the read replica.
This parameter is updatable.
display_name
string
The user-friendly name for the read replica. 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 that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
is_delete_protected
boolean
    Choices:
  • no
  • yes
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
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.
replica_id
string
The Replica 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
replica_overrides
dictionary
This parameter is updatable.
configuration_id
string
The OCID of the Configuration to be used by the read replica.
mysql_version
string
The MySQL version to be used by the read replica.
shape_name
string
The shape to be used by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
state
string
    Choices:
  • present ←
  • absent
The state of the Replica.
Use state=present to create or update a Replica.
Use state=absent to delete a Replica.
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 replica
  oci_mysql_replica:
    # required
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_delete_protected: true
    replica_overrides:
      # optional
      mysql_version: mysql_version_example
      shape_name: shape_name_example
      configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update replica
  oci_mysql_replica:
    # required
    replica_id: "ocid1.replica.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_delete_protected: true
    replica_overrides:
      # optional
      mysql_version: mysql_version_example
      shape_name: shape_name_example
      configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"

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

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_delete_protected: true
    replica_overrides:
      # optional
      mysql_version: mysql_version_example
      shape_name: shape_name_example
      configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete replica
  oci_mysql_replica:
    # required
    replica_id: "ocid1.replica.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete replica using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_mysql_replica:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
replica
complex
on success
Details of the Replica resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration_id': 'ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ip_address': 'ip_address_example', 'is_delete_protected': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'mysql_version': 'mysql_version_example', 'port': 56, 'port_x': 56, 'replica_overrides': {'configuration_id': 'ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx', 'mysql_version': 'mysql_version_example', 'shape_name': 'shape_name_example'}, 'shape_name': 'shape_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
availability_domain
string
on success
The name of the Availability Domain the read replica is located in.

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment that contains the read replica.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
configuration_id
string
on success
The OCID of the Configuration currently in use by the read replica.

Sample:
ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx
 
db_system_id
string
on success
The OCID of the DB System the read replica is associated with.

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
User provided description of the read replica.

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

Sample:
display_name_example
 
fault_domain
string
on success
The name of the Fault Domain the read replica is located in.

Sample:
FAULT-DOMAIN-1
 
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 read replica.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ip_address
string
on success
The IP address the read replica is configured to listen on.

Sample:
ip_address_example
 
is_delete_protected
boolean
on success
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

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

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

Sample:
CREATING
 
mysql_version
string
on success
The MySQL version currently in use by the read replica.

Sample:
mysql_version_example
 
port
integer
on success
The port the read replica is configured to listen on.

Sample:
56
 
port_x
integer
on success
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

Sample:
56
 
replica_overrides
complex
on success

   
configuration_id
string
on success
The OCID of the Configuration to be used by the read replica.

Sample:
ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx
   
mysql_version
string
on success
The MySQL version to be used by the read replica.

Sample:
mysql_version_example
   
shape_name
string
on success
The shape to be used by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.

Sample:
shape_name_example
 
shape_name
string
on success
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.

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

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

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


Authors

  • Oracle (@oracle)