Try SpotterGet cbr backup resource list
| "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.2Get cbr backup resource list.
# Getting one cbr backup:
- opentelekomcloud.cloud.cbr_backup_info:
name: "name-or-id"
# Getting cbr backups list for vault:
- opentelekomcloud.cloud.cbr_backup_info:
vault: "name-or-id-vault"
dec:
description:
- Dedicated cloud.
type: bool
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 or id.
type: str
sort:
description:
- A group of properties separated by commas (,) and sorting directions.
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
limit:
description:
- Number of records displayed per page. The value must be a positive integer.
type: int
vault:
description:
- Vault id or name.
type: str
marker:
description:
- ID of the last record displayed on the previous page.
type: str
offset:
description:
- Offset value. The value must be a positive integer.
type: int
status:
choices:
- available
- protecting
- deleting
- restoring
- error
- waiting_protect
- waiting_delete
- waiting_restore
description:
- Status. When the API is called, multiple statuses can be transferred for filtering,
for example, status=available&status=error.
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
end_time:
description:
- Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format.
type: str
own_type:
choices:
- all_granted
- private
- shared
default: private
description:
- Owning type of a backup. private backups are queried by default.
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
parent_id:
description:
- Parent backup id.
type: str
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
image_type:
choices:
- backup
- replication
description:
- Backup type.
type: str
start_time:
description:
- Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example,
2018-02-01T12:00:00Z.
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
resource_az:
description:
- AZ-based filtering is supported.
type: str
resource_id:
description:
- Resource id.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
used_percent:
description:
- Backups are filtered based on the occupied vault capacity. The value ranges
from 1 to 100. For example, if used_percent is set to 80, all backups who occupied
80% or more of the vault capacity are displayed.
type: str
checkpoint_id:
description:
- Restore point ID.
type: str
member_status:
choices:
- pending
- accept
- reject
description:
- Backup sharing status.
type: str
resource_name:
description:
- Resource name.
type: str
resource_type:
choices:
- OS::Cinder::Volume
- OS::Nova::Server
description:
- Resource type.
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
backups:
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:
auto_trigger:
description:
- Whether the backup is automatically generated.
type: bool
bootable:
description:
- Whether the backup is a system disk backup.
type: bool
contain_system_disk:
description:
- Whether the VM backup data contains system disk data.
type: bool
encrypted:
description:
- Whether the backup is encrypted.
type: bool
incremental:
description:
- Whether the backup is an incremental backup.
type: bool
os_images_data:
contains:
image_id:
description:
- Image ID.
type: str
description:
- ID list of images created using backups.
elements: dict
type: list
snapshot_id:
description:
- Snapshot ID of the disk backup.
type: str
support_lld:
description:
- Whether to allow lazyloading for fast restoration.
type: bool
supported_restore_mode:
description:
- Restoration mode. Possible values are na, snapshot, and backup.
snapshot indicates the backup can be used to create a full-server
image. backup indicates the data is restored from backups of
the EVS disks of the server. na indicates the backup cannot
be used for restoration.
type: str
system_disk:
description:
- Whether the disk is a system disk.
type: bool
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