You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.clc_server_snapshot module – Create, Delete and Restore server snapshots in CenturyLink Cloud.

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. 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 community.general.

To use it in a playbook, specify: community.general.clc_server_snapshot.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

An Ansible module to Create, Delete and Restore server snapshots in CenturyLink Cloud.

Requirements 

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

python = 2.7
requests >= 2.5.0
clc-sdk

Parameters 

Parameter	Comments
expiration_days integer	The number of days to keep the server snapshot before it expires. Default: 7
server_ids list / elements=string / required	The list of CLC server Ids.
state string	The state to insure that the provided resources are in. Choices: present ← (default) absent restore
wait string	Whether to wait for the provisioning tasks to finish before returning. Default: “True”

Notes 

Note

To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud - CLC_V2_API_USERNAME, the account login id for the centurylink cloud - CLC_V2_API_PASSWORD, the account password for the centurylink cloud
Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account login and password via the HTTP api call @ https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, the API token generated from https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, the account alias associated with the centurylink cloud
Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment.

Examples 

# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples

- name: Create server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    expiration_days: 10
    wait: True
    state: present

- name: Restore server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    wait: True
    state: restore

- name: Delete server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    wait: True
    state: absent

Return Values 

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

Key	Description
server_ids list / elements=string	The list of server ids that are changed Returned: success Sample: [“UC1TEST-SVR01”, “UC1TEST-SVR02”]

Authors

CLC Runner (@clc-runner)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication

community.general.clc_server_snapshot module – Create, Delete and Restore server snapshots in CenturyLink Cloud.

Synopsis

Requirements

Parameters

Notes

Examples

Return Values