ngine_io.cloudstack.cs_domain – Manages domains on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 2.1.0).
To install it use: ansible-galaxy collection install ngine_io.cloudstack
.
To use it in a playbook, specify: ngine_io.cloudstack.cs_domain
.
New in version 0.1.0: of ngine_io.cloudstack
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameter |
Choices/Defaults |
Comments |
api_http_method
string
|
|
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.
|
clean_up
boolean
|
|
Clean up all domain resources like child domains and accounts.
Considered on state=absent.
|
network_domain
string
|
|
Network domain for networks in the domain.
|
path
string
/ required
|
|
Path of the domain.
Prefix ROOT/ or /ROOT/ in path is optional.
|
poll_async
boolean
|
|
Poll async jobs until job has finished.
|
state
string
|
Choices:
present ←
- absent
|
State of the domain.
|
- name: Create a domain
ngine_io.cloudstack.cs_domain:
path: ROOT/customers
network_domain: customers.example.com
- name: Create another subdomain
ngine_io.cloudstack.cs_domain:
path: ROOT/customers/xy
network_domain: xy.customers.example.com
- name: Remove a domain
ngine_io.cloudstack.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
|