cs_pod – Manages pods on Apache CloudStack based clouds.

New in version 2.1.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

Create, update, delete pods.

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.
end_ip -		Ending IP address for the Pod.
gateway -		Gateway for the Pod. Required on `state=present`
id -		uuid of the existing pod.
name - / required		Name of the pod.
netmask -		Netmask for the Pod. Required on `state=present`
start_ip -		Starting IP address for the Pod. Required on `state=present`
state -	Choices: present ← enabled disabled absent	State of the pod.
zone -		Name of the zone in which the pod 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

- name: Ensure a pod is present
  local_action:
    module: 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
  local_action:
    module: cs_pod
    name: pod1
    zone: ch-zrh-ix-01
    state: disabled

- name: Ensure a pod is enabled
  local_action:
    module: cs_pod
    name: pod1
    zone: ch-zrh-ix-01
    state: enabled

- name: Ensure a pod is absent
  local_action:
    module: 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

Status

This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
This module is maintained by the Ansible Community. [community]

Authors

René Moser (@resmo)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cs_pod_module.html