opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / rds_backup Manage RDS backup | "added in version" 0.2.0 of opentelekomcloud.cloud" Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)opentelekomcloud.cloud.rds_backup (0.6.0) — module
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.6.0
collections: - name: opentelekomcloud.cloud version: 0.6.0
Manage RDS backups
#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: yes 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
auth: description: - Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default I(password) plugin, this would contain I(auth_url), I(username), I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name) or I(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. type: dict name: description: - 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. required: true type: str wait: default: 'yes' description: - If the module should wait for the RDS backup to be created or deleted. type: bool cloud: description: - Named cloud or cloud config to operate against. If I(cloud) is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is provided or if OpenStack OS_* environment variables are present. If I(cloud) is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. type: raw state: choices: - present - absent default: present description: Should the resource be present or absent. type: str ca_cert: aliases: - cacert description: - A path to a CA Cert bundle that can be used as part of verifying SSL API requests. type: str timeout: default: 200 description: - The duration in seconds that module should wait. type: int instance: description: Name or ID of RDS instance. required: true type: str auth_type: description: - 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 I(auth) parameter should be updated accordingly. type: str databases: description: - Specified a list of self-built databases that are partially backed up. - Only Microsoft SQL Server support partial backups. elements: str type: list interface: aliases: - endpoint_type choices: - admin - internal - public default: public description: - Endpoint URL type to fetch from the service catalog. type: str client_key: aliases: - key description: - A path to a client key to use as part of the SSL transaction. type: str api_timeout: description: - 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. type: int client_cert: aliases: - cert description: - A path to a client certificate to use as part of the SSL transaction. type: str description: description: - Backup description contains a maximum of 256 characters. - Backup description can't contain special symbols. type: str region_name: description: - Name of the region. type: str validate_certs: aliases: - verify default: false description: - Whether or not SSL API requests should be verified. - Before Ansible 2.3 this defaulted to C(yes). type: bool
backup: contains: begin_time: description: Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. sample: '2020-09-12T01:17:05' type: str databases: description: Indicates a list of self-built MS SQL Server databases (partial backup). elements: str type: list datastore: contains: type: description: Indicates the DB engine. type: str version: description: Indicates the database version type: str description: Indicates the database version. returned: On Success type: complex description: description: Indicates the backup description. sample: This is a description type: str end_time: description: Indicates the backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. sample: '2020-09-12T01:20:33' type: str id: description: Indicates the backup ID. sample: 2f4ddb93-b901-4b08-93d8-1d2e472f30fe type: str instance_id: description: Indicates the DB instance ID. sample: d8e6ca5a624745bcb546a227aa3ae1cfin01 type: str name: description: Indicates the backup name. sample: backup_test type: str size: description: Indicates the backup size in kB. sample: 220276 type: int status: description: Indicates the backup status. sample: COMPLETED type: str type: description: Indicates the backup type. sample: manual type: str description: Dictionary describing RDS backup. returned: On Success when C(state=present) type: complex