opentelekomcloud.cloud.rds_backup_info module – Get RDS Backup info

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

New in version 0.0.3: of opentelekomcloud.cloud

Synopsis

  • Get RDS backup info from the OTC.

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.

backup

string

Name or ID of the RDS Backup

backup_type

string

Backup type

Choices:

  • auto

  • manual

  • fragment

  • incremental

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.

instance

string / required

Name or ID of the RDS instance

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

region_name

string

Name of the region.

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

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

Should ansible wait until the requested resource is complete.

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

# Get RDS Backups (status and names of rds instance and backup are used)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "test_instance_name"
    backup: "test_backup_name"
    backup_type: "auto"
  register: rds_backup

# Get RDS Backups (status and IDs of rds instance and backup are used)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "a11a111a111a11111bbbbb2222ccc3333305"
    backup: "a11a111a111a11111bbbbb2222ccc3333307"
    backup_type: "manual"
  register: rds_backup

# Get RDS Backups (instance name and backup type are specified)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "test_instance_name"
    backup_type: "manual"
  register: rds_backup

# Get RDS Backups (instance id and backup name are specified)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "a11a111a111a11111bbbbb2222ccc3333305"
    backup: "test_backup_name"
  register: rds_backup

# Get RDS Backups (instance name is specified)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "test_instance_name"
  register: rds_backup

Return Values

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

Key

Description

rds_backups

complex

List of dictionaries describing rds backups.

Returned: On Success

begin_time

string

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

Returned: success

Sample: “2018-08-06T12:41:14+0800”

databases

list / elements=string

List of self-built databases that support partial backups.

Returned: success

datastore

dictionary

Indicates the database version.

Returned: success

end_time

string

Indicates the backup end time.

Returned: success

Sample: “2018-08-06T12:43:14+0800”

id

string

Indicates the backup ID.

Returned: success

Sample: “a11a111a111a11111bbbbb2222ccc3333302”

instance_id

string

The ID of the DB instance for which the backup is creates.

Returned: success

Sample: “a11a111a111a11111bbbbb2222ccc3333304”

name

string

Indicates the backup name.

Returned: success

Sample: “test01”

size

integer

Specifies the backup size in kB.

Returned: success

Sample: 2803

status

string

Indicates the backup status.

Returned: success

Sample: “COMPLETED”

type

string

Indicates the backup type.

Returned: success

Sample: “auto”

Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Whats next

last updated: 2022-02-25 12:26