clc_server_snapshot - Create, Delete and Restore server snapshots in CenturyLink Cloud.¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis ¶

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

Requirements (on host that executes module)¶

python = 2.7

requests >= 2.5.0

clc-sdk

Options ¶

parameter	required	default	choices	comments
expiration_days	no	7		The number of days to keep the server snapshot before it expires.
server_ids	yes			The list of CLC server Ids.
state	no	present	present absent restore	The state to insure that the provided resources are in.
wait	no	True	True False	Whether to wait for the provisioning tasks to finish before returning.

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
  clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    expiration_days: 10
    wait: True
    state: present

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

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

Return Values ¶

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

name	description	returned	type	sample
server_ids	The list of server ids that are changed	success	list	['UC1TEST-SVR01', 'UC1TEST-SVR02']

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.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

clc_server_snapshot - Create, Delete and Restore server snapshots in CenturyLink Cloud.¶

Synopsis¶

Requirements (on host that executes module)¶

Options¶

Examples¶

Return Values¶

Notes¶

Status¶