community.general.clc_server module – Create, Delete, Start and Stop servers in CenturyLink Cloud.
Note
This module is part of the community.general collection (version 4.8.3).
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.
To use it in a playbook, specify: community.general.clc_server.
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 |
|---|---|
Whether to add a public ip to the server Choices:
|
|
The list of additional disks for the server Default: [] |
|
The alert policy to assign to the server. This is mutually exclusive with ‘alert_policy_name’. |
|
The alert policy to assign to the server. This is mutually exclusive with ‘alert_policy_id’. |
|
The account alias to provision the servers under. |
|
The anti-affinity policy to assign to the server. This is mutually exclusive with ‘anti_affinity_policy_name’. |
|
The anti-affinity policy to assign to the server. This is mutually exclusive with ‘anti_affinity_policy_id’. |
|
Only required for bare metal servers. Specifies the identifier for the specific configuration type of bare metal server to deploy. |
|
The number of servers to build (mutually exclusive with exact_count) Default: 1 |
|
Required when exact_count is specified. The Server Group use to determine how many servers to deploy. |
|
How many CPUs to provision on the server Default: 1 |
|
The autoscale policy to assign to the server. |
|
The list of custom fields to set on the server. Default: [] |
|
The description to set for the server. |
|
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. |
|
The Server Group to create servers under. Default: “Default Group” |
|
The IP Address for the server. One is assigned if not provided. |
|
The Datacenter to create servers in. |
|
Whether to create the server as ‘Managed’ or not. Choices:
|
|
Memory in GB. Default: 1 |
|
A 1 to 6 character identifier to use for the server. This is required when state is ‘present’ |
|
The network UUID on which to create servers. |
|
Only required for bare metal servers. Specifies the OS to provision with the bare metal server. Choices:
|
|
The list of blue print packages to run on the server after its created. Default: [] |
|
Password for the administrator / root user |
|
Primary DNS used by the server. |
|
A list of ports to allow on the firewall to the servers public ip, if add_public_ip is set to True. Default: [] |
|
The protocol to use for the public ip if add_public_ip is set to True. Choices:
|
|
Secondary DNS used by the server. |
|
Required for started, stopped, and absent states. A list of server Ids to insure are started, stopped, or absent. Default: [] |
|
The password for the source server if a clone is specified. |
|
The state to insure that the provided resources are in. Choices:
|
|
The type of storage to attach to the server. Choices:
|
|
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’ |
|
The time to live for the server in seconds. The server will be deleted when this time expires. |
|
The type of server to create. Choices:
|
|
Whether to wait for the provisioning tasks to finish before returning. Choices:
|
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: Provision a single Ubuntu Server
community.general.clc_server:
name: test
template: ubuntu-14-64
count: 1
group: Default Group
state: present
- name: Ensure 'Default Group' has exactly 5 servers
community.general.clc_server:
name: test
template: ubuntu-14-64
exact_count: 5
count_group: Default Group
group: Default Group
- name: Stop a Server
community.general.clc_server:
server_ids:
- UC1ACCT-TEST01
state: stopped
- name: Start a Server
community.general.clc_server:
server_ids:
- UC1ACCT-TEST01
state: started
- name: Delete a Server
community.general.clc_server:
server_ids:
- UC1ACCT-TEST01
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The list of server ids that are partially created Returned: success Sample: [“UC1TEST-SVR01”, “UC1TEST-SVR02”] |
|
The list of server ids that are created Returned: success Sample: [“UC1TEST-SVR01”, “UC1TEST-SVR02”] |
|
The list of server objects returned from CLC Returned: success Sample: [{“changeInfo”: {“createdBy”: “service.wfad”, “createdDate”: 1438196820, “modifiedBy”: “service.wfad”, “modifiedDate”: 1438196820}, “description”: “test-server”, “details”: {“alertPolicies”: [], “cpu”: 1, “customFields”: [], “diskCount”: 3, “disks”: [{“id”: “0:0”, “partitionPaths”: [], “sizeGB”: 1}, {“id”: “0:1”, “partitionPaths”: [], “sizeGB”: 2}, {“id”: “0:2”, “partitionPaths”: [], “sizeGB”: 14}], “hostName”: “”, “inMaintenanceMode”: false, “ipAddresses”: [{“internal”: “10.1.1.1”}], “memoryGB”: 1, “memoryMB”: 1024, “partitions”: [], “powerState”: “started”, “snapshots”: [], “storageGB”: 17}, “groupId”: “086ac1dfe0b6411989e8d1b77c4065f0”, “id”: “test-server”, “ipaddress”: “10.120.45.23”, “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”, “rel”: “publicIPAddresses”, “verbs”: [“POST”]}, {“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”, “rel”: “scheduledActivities”, “verbs”: [“GET”, “POST”]}, {“href”: “/v2/servers/wfad/test-server/capabilities”, “rel”: “capabilities”}, {“href”: “/v2/servers/wfad/test-server/alertPolicies”, “rel”: “alertPolicyMappings”, “verbs”: [“POST”]}, {“href”: “/v2/servers/wfad/test-server/antiAffinityPolicy”, “rel”: “antiAffinityPolicyMapping”, “verbs”: [“PUT”, “DELETE”]}, {“href”: “/v2/servers/wfad/test-server/cpuAutoscalePolicy”, “rel”: “cpuAutoscalePolicyMapping”, “verbs”: [“PUT”, “DELETE”]}], “locationId”: “UC1”, “name”: “test-server”, “os”: “ubuntu14_64Bit”, “osType”: “Ubuntu 14 64-bit”, “status”: “active”, “storageType”: “standard”, “type”: “standard”}] |
Authors
CLC Runner (@clc-runner)
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication