Try SpotterManage CBR Backup Resource
| "added in version" 0.12.4 of opentelekomcloud.cloud"
Authors: Gubina Polina (@Polina-Gubina)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2Manage CBR backup resource from the OTC.
# Restore backup:
- name:
opentelekomcloud.cloud.cbr_backup:
name: "backup-name-or-id"
volume_id: "volume-id"
# Delete backup:
- name:
opentelekomcloud.cloud.cbr_backup:
name: "backup-name-or-id"
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: Backup name of id.
required: true
type: str
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
state:
choices:
- present
- absent
default: present
description:
- Whether resource should 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: 180
description:
- How long should ansible wait for the requested resource.
type: int
mappings:
description:
- Restored mapping relationship. This parameter is mandatory for VM restoration and
optional for disk restoration.
elements: dict
suboptions:
backup_id:
description:
- backup_id
required: true
type: str
volume_id:
description:
- ID of the disk to which data is restored.
required: true
type: str
type: list
power_on:
default: true
description:
- Whether the server is powered on after restoration. By default it is powered
on after restoration.
type: bool
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
server_id:
description:
- ID of the target VM to be restored. This parameter is mandatory for VM restoration.
type: str
volume_id:
description:
- ID of the target disk to be restored. This parameter is mandatory for disk
restoration.
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
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
backup:
contains:
checkpoint_id:
description: Restore point ID.
type: str
created_at:
description: Creation time.
type: str
description:
description: Backup description.
type: str
expired_at:
description: Expiration time.
type: str
extend_info:
contains:
allocated:
description:
- Allocated capacity, in MB.
type: int
charging_mode:
description:
- Billing mode.
type: str
description: Extended information.
type: complex
id:
description: Backup id.
type: str
image_type:
description: Backup type.
type: str
name:
description: Backup name.
type: str
parent_id:
description: Parent backup ID.
type: str
project_id:
description: Project ID.
type: str
protected_at:
description: Backup time.
type: str
provider_id:
description: Backup provider ID, which is used to distinguish backup objects.
The value can be as follows:.
type: str
resource_az:
description: Resource availability zone.
type: str
resource_id:
description: Resource ID.
type: str
resource_name:
description: Resource name.
type: str
resource_size:
description: Resource size, in GB.
type: str
resource_type:
description: Resource type.
type: str
status:
description: Backup status.
type: str
updated_at:
description: Update time.
type: str
vault_id:
description: Vault id.
type: str
description: CBR backups list.
returned: On Success.
type: complex