Documentation

cs_pod - Manages pods on Apache CloudStack based clouds.

New in version 2.1.

Synopsis

Create, update, delete pods.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
api_http_method
 no get
  • get
  • post
HTTP method used.
api_key
 no
    API key of the CloudStack API.
    api_region
    		 no cloudstack
      Name of the ini section in the cloustack.ini file.
      api_secret
      		 no
        Secret key of the CloudStack API.
        api_timeout
        		 no 10
          HTTP timeout.
          api_url
          		 no
            URL of the CloudStack API e.g. https://cloud.example.com/client/api.
            end_ip
            		 no
              Ending IP address for the Pod.
              gateway
              		 no
                Gateway for the Pod.
                Required on state=present
                id
                		 no
                  uuid of the exising pod.
                  name
                  		 yes
                    Name of the pod.
                    netmask
                    		 no
                      Netmask for the Pod.
                      Required on state=present
                      start_ip
                      		 no
                        Starting IP address for the Pod.
                        Required on state=present
                        state
                        		 no present
                        • present
                        • enabled
                        • disabled
                        • absent
                        State of the pod.
                        zone
                        		 no
                          Name of the zone in which the pod belongs to.
                          If not set, default zone is used.

                          Examples

                          # 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

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

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

# 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 Common Return Values, the following are the fields unique to this module:

                          name description returned type sample
                          name Name of the pod. success string pod01
                          zone Name of zone the pod is in. success string ch-gva-2
                          gateway Gateway of the pod. success string 10.100.1.1
                          netmask Netmask of the pod. success string 255.255.255.0
                          end_ip Ending IP of the pod. success string 10.100.1.254
                          start_ip Starting IP of the pod. success string 10.100.1.101
                          allocation_state State of the pod. success string Enabled
                          id UUID of the pod. success string 04589590-ac63-4ffc-93f5-b698b8ac38b6


                          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.

                          Note

                          This module supports check mode.

                          This is an Extras Module

                          For more information on what this means please read Extras Modules

                          For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.