ngine_io.cloudstack.cs_domain module – Manages domains on Apache CloudStack based clouds.
Note
This module is part of the ngine_io.cloudstack collection (version 2.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ngine_io.cloudstack
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ngine_io.cloudstack.cs_domain
.
New in ngine_io.cloudstack 0.1.0
Synopsis
Create, update and remove domains.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
Clean up all domain resources like child domains and accounts. Considered on state=absent. Choices:
|
|
Network domain for networks in the domain. |
|
Path of the domain. Prefix |
|
Poll async jobs until job has finished. Choices:
|
|
State of the domain. Choices:
|
|
If If not given, the This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
UUID of the domain. Returned: success Sample: |
|
Name of the domain. Returned: success Sample: |
|
Network domain of the domain. Returned: success Sample: |
|
Parent domain of the domain. Returned: success Sample: |
|
Domain path. Returned: success Sample: |