ngine_io.cloudstack.cs_cluster – Manages host clusters on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.0.0).

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_cluster.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Create, update and remove clusters.

Requirements

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

python >= 2.6
cs >= 0.9.0

Parameters

Parameter	Choices/Defaults	Comments
api_http_method string	get ← post	HTTP method used to query the API endpoint. If not given, the `CLOUDSTACK_METHOD` env variable is considered.
api_key string / required		API key of the CloudStack API. If not given, the `CLOUDSTACK_KEY` env variable is considered.
api_secret string / required		Secret key of the CloudStack API. If not set, the `CLOUDSTACK_SECRET` env variable is considered.
api_timeout integer	Default: 10	HTTP timeout in seconds. If not given, the `CLOUDSTACK_TIMEOUT` env variable is considered.
api_url string / required		URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the `CLOUDSTACK_ENDPOINT` env variable is considered.
api_verify_ssl_cert string		Verify CA authority cert file. If not given, the `CLOUDSTACK_VERIFY` env variable is considered.
cluster_type string	CloudManaged ExternalManaged	Type of the cluster. Required if state=present
guest_vswitch_name string		Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.
guest_vswitch_type string	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 string		Name the hypervisor to be used. Required if state=present. Possible values are `KVM`, `VMware`, `BareMetal`, `XenServer`, `LXC`, `HyperV`, `UCS`, `OVM`, `Simulator`.
name string / required		name of the cluster.
ovm3_cluster string		Ovm3 native OCFS2 clustering enabled for cluster.
ovm3_pool string		Ovm3 native pooling enabled for cluster.
ovm3_vip string		Ovm3 vip to use for pool (and cluster).
password string		Password for the cluster.
pod string		Name of the pod in which the cluster belongs to.
public_vswitch_name string		Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.
public_vswitch_type string	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 string	present ← absent disabled enabled	State of the cluster.
url string		URL for the cluster
username string		Username for the cluster.
vms_ip_address string		IP address of the VSM associated with this cluster.
vms_password string		Password for the VSM associated with this cluster.
vms_username string		Username for the VSM associated with this cluster.
zone string / required		Name of the zone in which the cluster belongs to.

Notes

Note

A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.

Examples

- name: Ensure a cluster is present
  ngine_io.cloudstack.cs_cluster:
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    hypervisor: KVM
    cluster_type: CloudManaged

- name: Ensure a cluster is disabled
  ngine_io.cloudstack.cs_cluster:
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    state: disabled

- name: Ensure a cluster is enabled
  ngine_io.cloudstack.cs_cluster:
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
    state: enabled

- name: Ensure a cluster is absent
  ngine_io.cloudstack.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

Authors

René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_cluster_module.html