New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
api_http_method
|
|
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
|
|
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
|
Default:
cloudstack
|
Name of the ini section in the
cloustack.ini file.If not given, the
CLOUDSTACK_REGION env variable is considered. |
api_secret
|
|
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
|
|
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
|
|
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
|
Default:
None
|
Endpoint URL of the region.
Required if
state=present |
id
required |
|
ID of the region.
Must be an number (int).
|
name
|
Default:
None
|
Name of the region.
Required if
state=present |
state
|
|
State of the region.
|
Note
# 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
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
bool
|
success |
Whether the GSLB service is enabled or not.
Sample:
True
|
id
int
|
success |
ID of the region.
Sample:
1
|
name
string
|
success |
Name of the region.
Sample:
local
|
portable_ip_service_enabled
bool
|
success |
Whether the portable IP service is enabled or not.
Sample:
True
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.