ngine_io.cloudstack.cluster_info module – Gathering information about clusters from Apache CloudStack based clouds.

Note

This module is part of the ngine_io.cloudstack collection (version 3.3.0).

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 ngine_io.cloudstack. You need further requirements to be able to use this module, see Requirements for details.

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

New in ngine_io.cloudstack 3.1.0

Synopsis

• Gathering information from the API of a cluster.

Requirements

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

• python >= 2.6

• cs >= 0.9.0

Parameters

Parameter	Comments
api_http_method string	HTTP method used to query the API endpoint. If not given, the CLOUDSTACK_METHOD env variable is considered. Choices: "get" ← (default) "post"
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	HTTP timeout in seconds. If not given, the CLOUDSTACK_TIMEOUT env variable is considered. Default: 10
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.
name string	Name of the cluster. If not specified, information about all clusters is gathered.
pod string	Name of the pod in which the cluster belongs to.
validate_certs boolean added in ngine_io.cloudstack 2.4.0	If false, SSL certificates will not be validated. If not given, the CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY env variable is considered. This should only be used on personally controlled sites using self-signed certificates. Choices: false true ← (default)
zone string	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: Gather information from a cluster
  ngine_io.cloudstack.cluster_info:
    name: kvm-cluster-01
    zone: ch-zrh-ix-01
  register: cluster

- name: Show the returned results of the registered variable
  debug:
    msg: "{{ cluster }}"

- name: Gather information from all clusters
  ngine_io.cloudstack.cluster_info:
  register: clusters

Return Values

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

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

Authors

• René Moser (@resmo)

Collection links

• Issue Tracker
• Repository (Sources)