Docs4dev
Docs
ansible / latest / collections / ngine_io / cloudstack / cs_domain_module.html

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.2.2).

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.

To use it in a playbook, specify: ngine_io.cloudstack.cs_domain.

New in version 0.1.0: of ngine_io.cloudstack

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 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.
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
    Choices:
  • no ←
  • yes
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
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
state
string
    Choices:
  • present ←
  • absent
State of the domain.

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


Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_domain_module.html