ngine_io.cloudstack.cs_pod module – Manages pods on Apache CloudStack based clouds.

Note

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

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.cs_pod.

New in ngine_io.cloudstack 0.1.0

Synopsis

  • Create, update, delete pods.

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.

end_ip

string

Ending IP address for the Pod.

gateway

string

Gateway for the Pod.

Required on state=present

id

string

uuid of the existing pod.

name

string / required

Name of the pod.

netmask

string

Netmask for the Pod.

Required on state=present

start_ip

string

Starting IP address for the Pod.

Required on state=present

state

string

State of the pod.

Choices:

  • "present" ← (default)

  • "enabled"

  • "disabled"

  • "absent"

zone

string / required

Name of the zone in which the pod 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 pod is present
  ngine_io.cloudstack.cs_pod:
    name: pod1
    zone: ch-zrh-ix-01
    start_ip: 10.100.10.101
    gateway: 10.100.10.1
    netmask: 255.255.255.0

- name: Ensure a pod is disabled
  ngine_io.cloudstack.cs_pod:
    name: pod1
    zone: ch-zrh-ix-01
    state: disabled

- name: Ensure a pod is enabled
  ngine_io.cloudstack.cs_pod:
    name: pod1
    zone: ch-zrh-ix-01
    state: enabled

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

Description

allocation_state

string

State of the pod.

Returned: success

Sample: "Enabled"

end_ip

string

Ending IP of the pod.

Returned: success

Sample: "10.100.1.254"

gateway

string

Gateway of the pod.

Returned: success

Sample: "10.100.1.1"

id

string

UUID of the pod.

Returned: success

Sample: "04589590-ac63-4ffc-93f5-b698b8ac38b6"

name

string

Name of the pod.

Returned: success

Sample: "pod01"

netmask

string

Netmask of the pod.

Returned: success

Sample: "255.255.255.0"

start_ip

string

Starting IP of the pod.

Returned: success

Sample: "10.100.1.101"

zone

string

Name of zone the pod is in.

Returned: success

Sample: "ch-gva-2"

Authors

  • René Moser (@resmo)