• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible
3

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • User Guide

Contributing to Ansible

  • Ansible Community Guide

Extending Ansible

  • Developer Guide

Common Ansible Scenarios

  • Public Cloud Guides
  • Network Technology Guides
  • Virtualization and Containerization Guides

Network Automation

  • Network Getting Started
  • Network Advanced Topics
  • Network Developer Guide

Ansible Galaxy

  • Galaxy User Guide
  • Galaxy Developer Guide

Reference & Appendices

  • Collection Index
  • Indexes of all modules and plugins
  • Playbook Keywords
  • Return Values
  • Ansible Configuration Settings
  • Controlling how Ansible behaves: precedence rules
  • YAML Syntax
  • Python 3 Support
  • Interpreter Discovery
  • Release and maintenance
  • Testing Strategies
  • Sanity Tests
  • Frequently Asked Questions
  • Glossary
  • Ansible Reference: Module Utilities
  • Special Variables
  • Red Hat Ansible Tower
  • Ansible Automation Hub
  • Logging Ansible output

Roadmaps

  • Ansible Roadmap




Ansible
  • Docs »
  • community.general.clc_blueprint_package – deploys a blue print package on a set of servers in CenturyLink Cloud.


community.general.clc_blueprint_package – deploys a blue print package on a set of servers in CenturyLink Cloud.¶

Note

This plugin is part of the community.general collection (version 2.5.1).

To install it use: ansible-galaxy collection install community.general.

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

  • Synopsis

  • Requirements

  • Parameters

  • Notes

  • Examples

  • Return Values

Synopsis¶

  • An Ansible module to deploy blue print package on a set of servers 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 Choices/Defaults Comments
package_id
string / required
The package id of the blue print.
package_params
dictionary
Default:
{}
The dictionary of arguments required to deploy the blue print.
server_ids
list / elements=string / required
A list of server Ids to deploy the blue print package.
state
string
    Choices:
  • present ←
Whether to install or uninstall the package. Currently it supports only "present" for install action.
wait
string
Default:
"yes"
Whether to wait for the tasks to finish before returning.

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 Returned Description
server_ids
list / elements=string
success
The list of server ids that are changed

Sample:
['UC1TEST-SERVER1', 'UC1TEST-SERVER2']


Authors¶

  • CLC Runner (@clc-runner)


© Copyright 2021 Red Hat, Inc. Last updated on Apr 23, 2021.