opentelekomcloud.cloud.rds_backup_info (0.14.2) — module

Get RDS Backup info

| "added in version" 0.0.3 of opentelekomcloud.cloud"

Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Get RDS backup info from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get RDS Backups (instance id and backup name are specified)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "a11a111a111a11111bbbbb2222ccc3333305"
    backup: "test_backup_name"
  register: rds_backup
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get RDS Backups (instance name is specified)
- opentelekomcloud.cloud.rds_backup_info:
    instance: "test_instance_name"
  register: rds_backup

Inputs

    
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

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    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

backup:
    description: Name or ID of the RDS Backup
    required: false
    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: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

instance:
    description: Name or ID of the 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

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

backup_type:
    choices:
    - auto
    - manual
    - fragment
    - incremental
    description: Backup type
    required: false
    type: str

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

rds_backups:
  contains:
    begin_time:
      description: Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
      sample: 2018-08-06T12:41:14+0800
      type: str
    databases:
      description: List of self-built databases that support partial backups.
      type: list
    datastore:
      description: Indicates the database version.
      type: dict
    end_time:
      description: Indicates the backup end time.
      sample: 2018-08-06T12:43:14+0800
      type: str
    id:
      description: Indicates the backup ID.
      sample: a11a111a111a11111bbbbb2222ccc3333302
      type: str
    instance_id:
      description: The ID of the DB instance for which the backup is creates.
      sample: a11a111a111a11111bbbbb2222ccc3333304
      type: str
    name:
      description: Indicates the backup name.
      sample: test01
      type: str
    size:
      description: Specifies the backup size in kB.
      sample: 2803
      type: int
    status:
      description: Indicates the backup status.
      sample: COMPLETED
      type: str
    type:
      description: Indicates the backup type.
      sample: auto
      type: str
  description: List of dictionaries describing rds backups.
  returned: On Success
  type: complex