cs_cluster - Manages host clusters on Apache CloudStack based clouds.¶

New in version 2.1.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Create, update and remove clusters.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
cs >= 0.6.10

Parameters ¶

Parameter	Choices/Defaults	Comments
api_http_method	Choices: get post	HTTP method used to query the API endpoint. If not given, the `CLOUDSTACK_METHOD` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes. Fallback value is `get` if not specified.
api_key		API key of the CloudStack API. If not given, the `CLOUDSTACK_KEY` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
api_region	Default: cloudstack	Name of the ini section in the `cloustack.ini` file. If not given, the `CLOUDSTACK_REGION` env variable is considered.
api_secret		Secret key of the CloudStack API. If not set, the `CLOUDSTACK_SECRET` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
api_timeout		HTTP timeout in seconds. If not given, the `CLOUDSTACK_TIMEOUT` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes. Fallback value is 10 seconds if not specified.
api_url		URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the `CLOUDSTACK_ENDPOINT` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
cluster_type	Choices: CloudManaged ExternalManaged	Type of the cluster. Required if `state=present`
guest_vswitch_name		Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.
guest_vswitch_type	Choices: vmwaresvs vmwaredvs	Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
hypervisor	Choices: KVM VMware BareMetal XenServer LXC HyperV UCS OVM	Name the hypervisor to be used. Required if `state=present`.
name required		name of the cluster.
ovm3_cluster		Ovm3 native OCFS2 clustering enabled for cluster.
ovm3_pool		Ovm3 native pooling enabled for cluster.
ovm3_vip		Ovm3 vip to use for pool (and cluster).
password		Password for the cluster.
pod		Name of the pod in which the cluster belongs to.
public_vswitch_name		Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.
public_vswitch_type	Choices: vmwaresvs vmwaredvs	Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
state	Choices: present ← absent disabled enabled	State of the cluster.
url		URL for the cluster
username		Username for the cluster.
vms_ip_address		IP address of the VSM associated with this cluster.
vms_password		Password for the VSM associated with this cluster.
vms_username		Username for the VSM associated with this cluster.
zone		Name of the zone in which the cluster belongs to. If not set, default zone is used.

Notes ¶

Note

Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. A CLOUDSTACK_CONFIG environment variable pointing to an .ini file. A cloudstack.ini file in the current working directory. A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.

Examples ¶

# Ensure a cluster is present
- local_action:
    module: cs_cluster
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    hypervisor: KVM
    cluster_type: CloudManaged

# Ensure a cluster is disabled
- local_action:
    module: cs_cluster
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    state: disabled

# Ensure a cluster is enabled
- local_action:
    module: cs_cluster
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    state: enabled

# Ensure a cluster is absent
- local_action:
    module: cs_cluster
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
allocation_state string	success	State of the cluster. Sample: Enabled
cluster_type string	success	Type of the cluster. Sample: ExternalManaged
cpu_overcommit_ratio string	success	The CPU overcommit ratio of the cluster. Sample: 1.0
hypervisor string	success	Hypervisor of the cluster Sample: VMware
id string	success	UUID of the cluster. Sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
managed_state string	success	Whether this cluster is managed by CloudStack. Sample: Managed
memory_overcommit_ratio string	success	The memory overcommit ratio of the cluster. Sample: 1.0
name string	success	Name of the cluster. Sample: cluster01
ovm3_vip string	success	Ovm3 VIP to use for pooling and/or clustering Sample: 10.10.10.101
pod string	success	Name of pod the cluster is in. Sample: pod01
zone string	success	Name of zone the cluster is in. Sample: ch-gva-2

Status ¶

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.