opentelekomcloud.cloud.css_snapshot module -- Manage CSS snapshots

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.css_snapshot.

New in opentelekomcloud.cloud 0.10.0

Synopsis

  • Manage CSS snapshots

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

api_timeout

integer

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.

auth

dictionary

Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or 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.

auth_type

string

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 auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

cluster

string / required

Name or ID of CSS cluster.

description

string

Description of a snapshot.

The value contains 0 to 256 characters, and angle brackets (<) and (>) are not allowed.

indices

string

Name of the index to be backed up.

Multiple index names are separated by commas (,).

By default, data of all indices is backed up.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

name

string / required

Name of CSS snapshot name must be start with letter.

Name must be 4 to 64 characters in length.

The backup name must be unique.

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

state

string

Whether css snapshot should be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

The amount of time the module should wait for the snapshot to be created.

Default: 600

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

If the module should wait for the snapshot to be created.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Create css snapshot
- opentelekomcloud.cloud.css_snapshot:
    cluster: "test-css"
    name: "snapshot_01"
  register: css_snapshot

# Delete css snapshot
- opentelekomcloud.cloud.css_snapshot:
    cluster: "test-css"
    name: "snapshot_01"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

css_snapshot

complex

Specifies the CSS snapshot.

Returned: changed

id

string

ID of the snapshot.

Returned: On success when state=present

Sample: "4dae5bac-0925-4d5b-add8-cb6667b8"

name

string

Snapshot name.

Returned: On success when state=present

Sample: "snapshot_101"

Authors

  • Vladimir Vshivkov (@enrrou)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b