cs_region – Manages regions on Apache CloudStack based clouds

Synopsis

• Add, update and remove regions.

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 string	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 string		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 string	Default: "cloudstack"	Name of the ini section in the cloustack.ini file. If not given, the CLOUDSTACK_REGION env variable is considered.
api_secret string		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 integer		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 string		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.
endpoint string		Endpoint URL of the region. Required if state=present
id integer / required		ID of the region. Must be an number (int).
name string		Name of the region. Required if state=present
state string	Choices: present ← absent	State of the region.

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: create a region
  cs_region:
    id: 2
    name: geneva
    endpoint: https://cloud.gva.example.com
  delegate_to: localhost

- name: remove a region with ID 2
  cs_region:
    id: 2
    state: absent
  delegate_to: localhost

Return Values

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

Key	Returned	Description
endpoint string	success	Endpoint of the region. Sample: http://cloud.example.com
gslb_service_enabled boolean	success	Whether the GSLB service is enabled or not. Sample: True
id integer	success	ID of the region. Sample: 1
name string	success	Name of the region. Sample: local
portable_ip_service_enabled boolean	success	Whether the portable IP service is enabled or not. Sample: True

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• 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.