Documentation

cs_domain - Manages domains on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

Create, update and remove domains.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
api_http_method
 no get
  • get
  • post
HTTP method used.
api_key
 no
    API key of the CloudStack API.
    api_region
    		 no cloudstack
      Name of the ini section in the cloustack.ini file.
      api_secret
      		 no
        Secret key of the CloudStack API.
        api_timeout
        		 no 10
          HTTP timeout.
          api_url
          		 no
            URL of the CloudStack API e.g. https://cloud.example.com/client/api.
            clean_up
            		 no
              Clean up all domain resources like child domains and accounts.
              Considered on state=absent.
              network_domain
              		 no
                Network domain for networks in the domain.
                path
                		 yes
                  Path of the domain.
                  Prefix ROOT/ or /ROOT/ in path is optional.
                  poll_async
                  		 no True
                    Poll async jobs until job has finished.
                    state
                    		 no present
                    • present
                    • absent
                    State of the domain.

                    Examples

                    # Create a domain
local_action:
  module: cs_domain
  path: ROOT/customers
  network_domain: customers.example.com

# Create another subdomain
local_action:
  module: cs_domain
  path: ROOT/customers/xy
  network_domain: xy.customers.example.com

# Remove a domain
local_action:
  module: cs_domain
  path: ROOT/customers/xy
  state: absent

                    Return Values

                    Common return values are documented here Common Return Values, the following are the fields unique to this module:

                    name description returned type sample
                    path Domain path. success string /ROOT/customers
                    network_domain Network domain of the domain. success string example.local
                    id UUID of the domain. success string 87b1e0ce-4e01-11e4-bb66-0050569e64b8
                    parent_domain Parent domain of the domain. success string ROOT
                    name Name of the domain. success string customers


                    Notes

                    Note

                    Ansible uses the 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.

                    Note

                    This module supports check mode.

                    This is an Extras Module

                    For more information on what this means please read Extras Modules

                    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.