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_blueprint_package module – Deploys a blue print package on a set of servers in CenturyLink Cloud

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis 

An Ansible module to deploy blue print package on a set of servers in CenturyLink Cloud.

Aliases: cloud.centurylink.clc_blueprint_package

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
package_id string / required	The package id of the blue print.
package_params dictionary	The dictionary of arguments required to deploy the blue print. Default: `{}`
server_ids list / elements=string / required	A list of server Ids to deploy the blue print package.
state string	Whether to install or uninstall the package. Currently it supports only “present” for install action. Choices: `"present"` ← (default)
wait string	Whether to wait for the tasks to finish before returning. Default: `"True"`

Attributes 

Attribute	Support	Description
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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: Deploy package
  community.general.clc_blueprint_package:
        server_ids:
            - UC1TEST-SERVER1
            - UC1TEST-SERVER2
        package_id: 77abb844-579d-478d-3955-c69ab4a7ba1a
        package_params: {}

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-SERVER1", "UC1TEST-SERVER2"]`

Authors

CLC Runner (@clc-runner)

community.general.clc_blueprint_package module – Deploys a blue print package on a set of servers in CenturyLink Cloud

Synopsis

Requirements

Parameters

Attributes

Notes

Examples

Return Values