opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / volume_backup Add/Delete Volume backup | "added in version" 0.0.1 of opentelekomcloud.cloud" Authors: Artem Goncharov (@gtema)opentelekomcloud.cloud.volume_backup (0.6.0) — module
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.6.0
collections: - name: opentelekomcloud.cloud version: 0.6.0
Add or Remove Volume Backup in OTC.
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: 'yes' description: - If the module should wait for the cluster 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 force: default: false description: - Indicates whether to backup, even if the volume is attached. type: bool state: choices: - present - absent default: present description: - Should the resource be present or absent. type: str volume: description: - Name or ID of the volume - Required when state = present 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: - The amount of time the module should wait. type: int metadata: description: Metadata for the backup type: dict snapshot: description: Name or ID of the Snapshot to take backup of 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 client_cert: aliases: - cert description: - A path to a client certificate to use as part of the SSL transaction. type: str incremental: default: false description: The backup mode type: bool region_name: description: - Name of the region. type: str display_name: aliases: - name description: - Name that has to be given to the backup required: true 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 display_description: aliases: - description description: - String describing the backup required: false type: str
backup: contains: id: description: Unique UUID. sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 type: str name: description: Name given to the load balancer. sample: elb_test type: str description: Dictionary describing the Cluster. returned: On success when C(state=present) type: complex id: description: The Volume backup ID. returned: On success when C(state=present) sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 type: str