clc_server - Create, Delete, Start and Stop servers in CenturyLink Cloud.

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is an Extras Module

Synopsis

An Ansible module to Create, Delete, Start and Stop 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
add_public_ip	no		False True	Whether to add a public ip to the server
additional_disks	no			The list of additional disks for the server
alert_policy_id	no	None		The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_name'.
alert_policy_name	no	None		The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_id'.
alias	no	None		The account alias to provision the servers under.
anti_affinity_policy_id	no	None		The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_name'.
anti_affinity_policy_name	no	None		The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_id'.
configuration_id	no	None		Only required for bare metal servers. Specifies the identifier for the specific configuration type of bare metal server to deploy.
count	no	1		The number of servers to build (mutually exclusive with exact_count)
count_group	no	None		Required when exact_count is specified. The Server Group use to determine how many severs to deploy.
cpu	no	1		How many CPUs to provision on the server
cpu_autoscale_policy_id	no	None		The autoscale policy to assign to the server.
custom_fields	no			The list of custom fields to set on the server.
description	no	None		The description to set for the server.
exact_count	no	None		Run in idempotent mode. Will insure that this exact number of servers are running in the provided group, creating and deleting them to reach that count. Requires count_group to be set.
group	no	Default Group		The Server Group to create servers under.
ip_address	no	None		The IP Address for the server. One is assigned if not provided.
location	no	None		The Datacenter to create servers in.
managed_os	no		True False	Whether to create the server as 'Managed' or not.
memory	no	1		Memory in GB.
name	no	None		A 1 to 6 character identifier to use for the server. This is required when state is 'present'
network_id	no	None		The network UUID on which to create servers.
os_type	no	None	redHat6_64Bit centOS6_64Bit windows2012R2Standard_64Bit ubuntu14_64Bit	Only required for bare metal servers. Specifies the OS to provision with the bare metal server.
packages	no			The list of blue print packages to run on the server after its created.
password	no	None		Password for the administrator / root user
primary_dns	no	None		Primary DNS used by the server.
public_ip_ports	no			A list of ports to allow on the firewall to the servers public ip, if add_public_ip is set to True.
public_ip_protocol	no	TCP	TCP UDP ICMP	The protocol to use for the public ip if add_public_ip is set to True.
secondary_dns	no	None		Secondary DNS used by the server.
server_ids	no			Required for started, stopped, and absent states. A list of server Ids to insure are started, stopped, or absent.
source_server_password	no	None		The password for the source server if a clone is specified.
state	no	present	present absent started stopped	The state to insure that the provided resources are in.
storage_type	no	standard	standard hyperscale	The type of storage to attach to the server.
template	no	None		The template to use for server creation. Will search for a template if a partial string is provided. This is required when state is 'present'
ttl	no	None		The time to live for the server in seconds. The server will be deleted when this time expires.
type	no	standard	standard hyperscale bareMetal	The type of server to create.
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: Provision a single Ubuntu Server
  clc_server:
    name: test
    template: ubuntu-14-64
    count: 1
    group: 'Default Group'
    state: present

- name: Ensure 'Default Group' has exactly 5 servers
  clc_server:
    name: test
    template: ubuntu-14-64
    exact_count: 5
    count_group: 'Default Group'
    group: 'Default Group'

- name: Stop a Server
  clc_server:
    server_ids: ['UC1ACCT-TEST01']
    state: stopped

- name: Start a Server
  clc_server:
    server_ids: ['UC1ACCT-TEST01']
    state: started

- name: Delete a Server
  clc_server:
    server_ids: ['UC1ACCT-TEST01']
    state: absent

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 created	success	list	['UC1TEST-SVR01', 'UC1TEST-SVR02']
changed	A flag indicating if any change was made or not	success	boolean	True
partially_created_server_ids	The list of server ids that are partially created	success	list	['UC1TEST-SVR01', 'UC1TEST-SVR02']
servers	The list of server objects returned from CLC	success	list	[{'status': 'active', 'description': 'test-server', 'changeInfo': {'modifiedBy': 'service.wfad', 'modifiedDate': 1438196820, 'createdBy': 'service.wfad', 'createdDate': 1438196820}, 'ipaddress': '10.120.45.23', 'storageType': 'standard', 'type': 'standard', 'isTemplate': False, 'links': [{'href': '/v2/servers/wfad/test-server', 'id': 'test-server', 'rel': 'self', 'verbs': ['GET', 'PATCH', 'DELETE']}, {'href': '/v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0', 'id': '086ac1dfe0b6411989e8d1b77c4065f0', 'rel': 'group'}, {'href': '/v2/accounts/wfad', 'id': 'wfad', 'rel': 'account'}, {'href': '/v2/billing/wfad/serverPricing/test-server', 'rel': 'billing'}, {'href': '/v2/servers/wfad/test-server/publicIPAddresses', 'verbs': ['POST'], 'rel': 'publicIPAddresses'}, {'href': '/v2/servers/wfad/test-server/credentials', 'rel': 'credentials'}, {'href': '/v2/servers/wfad/test-server/statistics', 'rel': 'statistics'}, {'href': '/v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/upcomingScheduledActivities', 'rel': 'upcomingScheduledActivities'}, {'href': '/v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/scheduledActivities', 'verbs': ['GET', 'POST'], 'rel': 'scheduledActivities'}, {'href': '/v2/servers/wfad/test-server/capabilities', 'rel': 'capabilities'}, {'href': '/v2/servers/wfad/test-server/alertPolicies', 'verbs': ['POST'], 'rel': 'alertPolicyMappings'}, {'href': '/v2/servers/wfad/test-server/antiAffinityPolicy', 'verbs': ['PUT', 'DELETE'], 'rel': 'antiAffinityPolicyMapping'}, {'href': '/v2/servers/wfad/test-server/cpuAutoscalePolicy', 'verbs': ['PUT', 'DELETE'], 'rel': 'cpuAutoscalePolicyMapping'}], 'id': 'test-server', 'locationId': 'UC1', 'details': {'hostName': '', 'powerState': 'started', 'ipAddresses': [{'internal': '10.1.1.1'}], 'disks': [{'partitionPaths': [], 'id': '0:0', 'sizeGB': 1}, {'partitionPaths': [], 'id': '0:1', 'sizeGB': 2}, {'partitionPaths': [], 'id': '0:2', 'sizeGB': 14}], 'diskCount': 3, 'snapshots': [], 'memoryMB': 1024, 'alertPolicies': [], 'memoryGB': 1, 'storageGB': 17, 'customFields': [], 'cpu': 1, 'inMaintenanceMode': False, 'partitions': []}, 'osType': 'Ubuntu 14 64-bit', 'os': 'ubuntu14_64Bit', 'groupId': '086ac1dfe0b6411989e8d1b77c4065f0', 'name': 'test-server'}]

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, Helping Testing PRs and Developing Modules.