W3cubDocs

/Ansible

clc_blueprint_package - deploys a blue print package on a set of servers in CenturyLink Cloud.

Synopsis

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

Requirements (on host that executes module)

  • python = 2.7
  • requests >= 2.5.0
  • clc-sdk

Options

parameter required default choices comments
package_id
 yes
The package id of the blue print.
package_params
 no
The dictionary of arguments required to deploy the blue print.
server_ids
 yes
A list of server Ids to deploy the blue print package.
state
 no present
  • present
Whether to install or un-install the package. Currently it supports only "present" for install action.
wait
 no True
  • True
  • False
Whether to wait for the 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: Deploy package
      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 Common 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-SERVER1', 'UC1TEST-SERVER2']

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

Note

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

Note

Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment.

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/clc_blueprint_package_module.html