Documentation

cs_instancegroup - Manages instance groups on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

Create and remove instance groups.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
    Account the instance group is related to.
    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.
              domain
              		 no
                Domain the instance group is related to.
                name
                		 yes
                  Name of the instance group.
                  project
                  		 no
                    Project the instance group is related to.
                    state
                    		 no present
                    • present
                    • absent
                    State of the instance group.

                    Examples

                    # Create an instance group
- local_action:
    module: cs_instancegroup
    name: loadbalancers

# Remove an instance group
- local_action:
    module: cs_instancegroup
    name: loadbalancers
    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
                    project Project the instance group is related to. success string example project
                    account Account the instance group is related to. success string example account
                    name Name of the instance group. success string webservers
                    created Date when the instance group was created. success string 2015-05-03T15:05:51+0200
                    domain Domain the instance group is related to. success string example domain
                    id UUID of the instance group. 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.