New in version 2.0.
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.
|
|
clean_up |
Default: no
|
Clean up all domain resources like child domains and accounts.
Considered on
state=absent . |
network_domain |
Network domain for networks in the domain.
|
|
path
required |
Path of the domain.
Prefix
ROOT/ or /ROOT/ in path is optional. |
|
poll_async |
Default: yes
|
Poll async jobs until job has finished.
|
state |
|
State of the domain.
|
Note
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.- name: Create a domain
local_action:
module: cs_domain
path: ROOT/customers
network_domain: customers.example.com
- name: Create another subdomain
local_action:
module: cs_domain
path: ROOT/customers/xy
network_domain: xy.customers.example.com
- name: Remove a domain
local_action:
module: cs_domain
path: ROOT/customers/xy
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id
string
|
success |
UUID of the domain.
Sample:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
|
name
string
|
success |
Name of the domain.
Sample:
customers
|
network_domain
string
|
success |
Network domain of the domain.
Sample:
example.local
|
parent_domain
string
|
success |
Parent domain of the domain.
Sample:
ROOT
|
path
string
|
success |
Domain path.
Sample:
/ROOT/customers
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Hint
If you notice any issues in this documentation you can edit this document to improve it.