opentelekomcloud.cloud.rds_backup module – Manage RDS backup

Note

This module is part of the opentelekomcloud.cloud collection (version 0.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 opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.rds_backup.

New in version 0.2.0: of opentelekomcloud.cloud

Synopsis

  • Manage RDS backups

Requirements

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

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

api_timeout

integer

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

dictionary

Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

string

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

raw

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

databases

list / elements=string

Specified a list of self-built databases that are partially backed up.

Only Microsoft SQL Server support partial backups.

description

string

Backup description contains a maximum of 256 characters.

Backup description can’t contain special symbols.

instance

string / required

Name or ID of RDS instance.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

name

string / required

Name of RDS backup name must be start with letter.

Name must be 4 to 64 characters in length.

The backup name must be unique.

region_name

string

Name of the region.

state

string

Should the resource be present or absent.

Choices:

  • present ← (default)

  • absent

timeout

integer

The duration in seconds that module should wait.

Default: 200

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no ← (default)

  • yes

wait

boolean

If the module should wait for the RDS backup to be created or deleted.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

#Create RDS backup (only required parameters are specified)
- opentelekomcloud.cloud.rds_backup:
    instance: "test-db"
    name: "test_ansible_module"
  register: rds_backup

#Delete RDS backup
- opentelekomcloud.cloud.rds_backup:
    instance: "test-db"
    name: "test_ansible_module"
    state: absent
  register: rds_backup

#Create RDS backup (ID instance is specified)
- opentelekomcloud.cloud.rds_backup:
    instance: 3870b5c9d92643efb078c32d2fcdffbein03
    name: "test_ansible_module"
  register: rds_backup

#Create RDS backup (All parameters are specified)
- opentelekomcloud.cloud.rds_backup:
    instance: "test-db"
    name: "test_ansible_module"
    description: "This is a description"
    state: present
    wait: true
    timeout: 200
  register: rds_backup

#Delete RDS backup (All parameters are specified)
- opentelekomcloud.cloud.rds_backup:
    instance: 3870b5c9d92643efb078c32d2fcdffbein03
    name: "test_ansible_module"
    description: "This is a description"
    state: absent
    wait: no
    timeout: 180
  register: rds_backup

Return Values

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

Key

Description

backup

complex

Dictionary describing RDS backup.

Returned: On Success when state=present

begin_time

string

Indicates the backup start time in the “yyyy-mm-ddThh:mm:ssZ” format.

Returned: success

Sample: “2020-09-12T01:17:05”

databases

list / elements=string

Indicates a list of self-built MS SQL Server databases (partial backup).

Returned: success

datastore

complex

Indicates the database version.

Returned: On Success

type

string

Indicates the DB engine.

Returned: success

version

string

Indicates the database version

Returned: success

description

string

Indicates the backup description.

Returned: success

Sample: “This is a description”

end_time

string

Indicates the backup end time in the “yyyy-mm-ddThh:mm:ssZ” format.

Returned: success

Sample: “2020-09-12T01:20:33”

id

string

Indicates the backup ID.

Returned: success

Sample: “2f4ddb93-b901-4b08-93d8-1d2e472f30fe”

instance_id

string

Indicates the DB instance ID.

Returned: success

Sample: “d8e6ca5a624745bcb546a227aa3ae1cfin01”

name

string

Indicates the backup name.

Returned: success

Sample: “backup_test”

size

integer

Indicates the backup size in kB.

Returned: success

Sample: 220276

status

string

Indicates the backup status.

Returned: success

Sample: “COMPLETED”

type

string

Indicates the backup type.

Returned: success

Sample: “manual”

Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Whats next

last updated: 2022-02-25 12:26