Documentation

cs_region - Manages regions on Apache CloudStack based clouds.

New in version 2.3.

Synopsis

  • Add, update and remove regions.

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.
endpoint
 no
Endpoint URL of the region.
Required if state=present
id
 yes
ID of the region.
Must be an number (int).
name
 no
Name of the region.
Required if state=present
state
 no present
  • present
  • absent
State of the region.

Examples

# create a region
local_action:
  module: cs_region
  id: 2
  name: geneva
  endpoint: https://cloud.gva.example.com

# remove a region with ID 2
local_action:
  module: cs_region
  id: 2
  state: absent

Return Values

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

name description returned type sample
gslb_service_enabled
Whether the GSLB service is enabled or not.
 success bool True
endpoint
Endpoint of the region.
 success string http://cloud.example.com
id
ID of the region.
 success int 1
portable_ip_service_enabled
Whether the portable IP service is enabled or not.
 success bool True
name
Name of the region.
 success string local


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 on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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