W3cubDocs

/Ansible

ngine_io.cloudstack.cs_instancegroup – Manages instance groups on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).

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.

To use it in a playbook, specify: ngine_io.cloudstack.cs_instancegroup.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • Create and remove instance groups.

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
account
string
Account the instance group is related to.
api_http_method
string
    Choices:
  • 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.
domain
string
Domain the instance group is related to.
name
string / required
Name of the instance group.
project
string
Project the instance group is related to.
state
string
    Choices:
  • present ←
  • absent
State of the instance group.

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Create an instance group
  ngine_io.cloudstack.cs_instancegroup:
    name: loadbalancers

- name: Remove an instance group
  ngine_io.cloudstack.cs_instancegroup:
    name: loadbalancers
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
account
string
success
Account the instance group is related to.

Sample:
example account
created
string
success
Date when the instance group was created.

Sample:
2015-05-03T15:05:51+0200
domain
string
success
Domain the instance group is related to.

Sample:
example domain
id
string
success
UUID of the instance group.

Sample:
04589590-ac63-4ffc-93f5-b698b8ac38b6
name
string
success
Name of the instance group.

Sample:
webservers
project
string
success
Project the instance group is related to.

Sample:
example project


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/latest/collections/ngine_io/cloudstack/cs_instancegroup_module.html