ngine_io.cloudstack.cs_pod – Manages pods 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_pod.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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	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.
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	present ← enabled disabled absent	State of the pod.
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	Returned	Description
allocation_state string	success	State of the pod. Sample: Enabled
end_ip string	success	Ending IP of the pod. Sample: 10.100.1.254
gateway string	success	Gateway of the pod. Sample: 10.100.1.1
id string	success	UUID of the pod. Sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name string	success	Name of the pod. Sample: pod01
netmask string	success	Netmask of the pod. Sample: 255.255.255.0
start_ip string	success	Starting IP of the pod. Sample: 10.100.1.101
zone string	success	Name of zone the pod 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_pod_module.html