Try SpotterManage CBR Vault
| "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 vault from the OTC.
- name: Create vault
opentelekomcloud.cloud.cbr_vault:
name: "vault-namenew"
resources:
- id: '9f1e2203-f222-490d-8c78-23c01ca4f4b9'
type: "OS::Cinder::Volume"
billing:
consistent_level: "crash_consistent"
object_type: "disk"
protect_type: "backup"
size: 40
register: vault
- name: Associate resources CBR vault
opentelekomcloud.cloud.cbr_vault:
name: "new-vault"
resources:
- id: '9f1e2203-f222-490d-8c78-23c01ca4f4b9'
type: "OS::Cinder::Volume"
action: "associate_resources"
register: vault
- name: Dissociate resources CBR vault
opentelekomcloud.cloud.cbr_vault:
name: "new-vault"
resource_ids:
- '9f1e2203-f222-490d-8c78-23c01ca4f4b9'
action: "dissociate_resources"
register: vault
- name: Delete CBR vault
opentelekomcloud.cloud.cbr_vault:
name: "new-vault"
state: absent
register: vault
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:
- Vault name or id.
required: true
type: str
tags:
description:
- Tag list. This list cannot be an empty list. The list can contain up to 10
keys. Keys in this list must be unique.
elements: dict
suboptions:
key:
description:
- Key. It can contain a maximum of 36 characters.
required: true
type: str
value:
description:
- Value. It is mandatory when a tag is added and optional when a tag
is deleted.
type: str
type: list
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
action:
choices:
- associate_resources
- dissociate_resources
- bind_policy
- unbind_policy
description:
- What needs to be done.
type: str
policy:
description:
- Backup policy name or id. If the value of this parameter is null, automatic
backup is not performed. Can be set during creation and for binding/unbinding
policy to the vault.
type: str
billing:
description:
- Parameter information for creation. Mandatory for creation. Only size can
be updated.
suboptions:
charging_mode:
description:
- Billing mode, which is post_paid.
type: str
cloud_type:
description:
- Cloud type, which is public.
type: str
consistent_level:
description:
- Specification, which is crash_consistent by default (crash consistent backup).
type: str
console_url:
description:
- Redirection URL. Minimum 1, maximum 255.
type: str
is_auto_pay:
description:
- Whether the fee is automatically deducted from the customer's account
balance after an order is submitted. The non-automatic payment mode
is used by default.
type: bool
is_auto_renew:
description:
- Whether to automatically renew the subscription after expiration. By
default, it is not renewed.
type: bool
object_type:
choices:
- server
- disk
description:
- Object type, which can be server or disk.
type: str
protect_type:
description:
- Protection type, which is backup.
type: str
size:
description:
- Capacity, in GB. Minimum 1, maximum 10485760.
type: int
type: dict
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
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
auto_bind:
description:
- Whether automatic association is supported.
type: bool
interface:
aliases:
- endpoint_type
choices:
- admin
- internal
- public
default: public
description:
- Endpoint URL type to fetch from the service catalog.
type: str
resources:
description:
- Associated resources. Set this parameter to [] if no resources are associated
when creating a vault. Mandatory for creation and associating resources.
elements: dict
suboptions:
id:
description:
- ID of the resource to be backed up.
required: true
type: str
name:
description:
- Resource name. Minimum 0, maximum 255.
required: false
type: str
type:
choices:
- OS::Nova::Server
- OS::Cinder::Volume
description:
- Type of the resource to be backed up.
required: true
type: str
type: list
threshold:
description:
- Vault capacity threshold. If the vault capacity usage exceeds this threshold
and smn_notify is true, an exception notification is sent. Can be set only
in update. 80 by default.
- Updating this parameter will not affect the changed state (when value in updated,
changed will be false anyway).
type: int
bind_rules:
description:
- Rules for automatic association. Filters automatically associated resources
by tag.
- Updating this parameter will not affect the changed state (when value in updated,
changed will be false anyway).
elements: dict
suboptions:
key:
description:
- Key. It can contain a maximum of 36 characters.
required: true
type: str
value:
description:
- Value. It is mandatory when a tag is added and optional when a tag
is deleted.
type: str
type: list
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
smn_notify:
description:
- Exception notification function. True by default.
- Updating this parameter will not affect the changed state (when value in updated,
changed will be false anyway).
type: bool
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
auto_expand:
description:
- Whether to enable auto capacity expansion for the vault. Can be set in update.
type: bool
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
description:
description:
- User-defined vault description. Minimum 0, maximum 64.
type: str
region_name:
description:
- Name of the region.
type: str
resource_ids:
description:
- List of resource IDs to be removed. Used for dissociating resources.
elements: str
type: list
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
vault:
contains:
auto_bind:
description: Indicates whether automatic association is enabled.
type: bool
auto_expand:
description: Whether to enable auto capacity expansion for the vault.
type: bool
billing:
contains:
allocated:
description:
- Allocated capacity, in MB.
type: int
charging_mode:
description:
- Billing mode.
type: str
cloud_type:
description:
- Cloud type.
type: str
consistent_level:
description:
- Specification.
type: str
frozen_scene:
description: Scenario when an account is frozen.
type: str
object_type:
description:
- Object type, which can be server or disk.
type: str
order_id:
description:
- Order id.
type: str
product_id:
description:
- Product id.
type: str
protect_type:
description:
- Protection type, which is backup.
type: str
size:
description: Capacity, in GB.
type: int
spec_code:
description: Specification code.
type: str
status:
description: Vault status.
type: str
storage_unit:
description: Name of the bucket for the vault.
type: str
used:
description:
- Used capacity, in MB.
type: int
description: Operation info.
type: complex
bind_rules:
contains:
key:
description: Key.
type: str
value:
description: Value.
type: str
description: Association rule.
elements: dict
type: list
created_at:
description: Creation time.
type: str
description:
description: User-defined vault description.
type: str
id:
description: Vault id.
type: str
name:
description: Vault name.
type: str
project_id:
description: Project ID.
type: str
provider_id:
description: Vault name.
type: list
resources:
description: Vault resources.
type: list
tags:
contains:
key:
description: Key.
type: str
value:
description: Value.
type: str
description: Vault tags.
elements: dict
type: list
user_id:
description: User id.
type: str
description: Vault object.
returned: On Success.
type: complex