cloudstack: new module cs_domain

cloud/cloudstack/cs_domain.py

@@ -0,0 +1,293 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2015, René Moser <mail@renemoser.net>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: cs_domain
+short_description: Manages domains on Apache CloudStack based clouds.
+description:
+    - Create, update and remove domains.
+version_added: '2.0'
+author: "René Moser (@resmo)"
+options:
+  path:
+    description:
+      - Path of the domain.
+      - Prefix C(ROOT/) or C(/ROOT/) in path is optional.
+    required: true
+  network_domain:
+    description:
+      - Network domain for networks in the domain.
+    required: false
+    default: null
+  cleanup:
+    description:
+      - Clean up all domain resources like child domains and accounts.
+      - Considered on C(state=absent).
+    required: false
+    default: false
+  state:
+    description:
+      - State of the domain.
+    required: false
+    default: 'present'
+    choices: [ 'present', 'absent' ]
+  poll_async:
+    description:
+      - Poll async jobs until job has finished.
+    required: false
+    default: true
+extends_documentation_fragment: cloudstack
+'''
+
+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 = '''
+---
+id:
+  description: ID of the domain.
+  returned: success
+  type: string
+  sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
+name:
+  description: Name of the domain.
+  returned: success
+  type: string
+  sample: customers
+path:
+  description: Domain path.
+  returned: success
+  type: string
+  sample: /ROOT/customers
+parent_domain:
+  description: Parent domain of the domain.
+  returned: success
+  type: string
+  sample: ROOT
+network_domain:
+  description: Network domain of the domain.
+  returned: success
+  type: string
+  sample: example.local
+
+'''
+
+try:
+    from cs import CloudStack, CloudStackException, read_config
+    has_lib_cs = True
+except ImportError:
+    has_lib_cs = False
+
+# import cloudstack common
+from ansible.module_utils.cloudstack import *
+
+
+class AnsibleCloudStackDomain(AnsibleCloudStack):
+
+    def __init__(self, module):
+        AnsibleCloudStack.__init__(self, module)
+        self.domain = None
+
+
+    def _get_domain_internal(self, path=None):
+        if not path:
+            path = self.module.params.get('path')
+
+        if path.endswith('/'):
+            self.module.fail_json(msg="Path '%s' must not end with /" % path)
+
+        path = path.lower()
+
+        if path.startswith('/') and not path.startswith('/root/'):
+            path = "root" + path
+        elif not path.startswith('root/'):
+            path = "root/" + path
+
+        args            = {}
+        args['listall'] = True
+
+        domains = self.cs.listDomains(**args)
+        if domains:
+            for d in domains['domain']:
+                if path == d['path'].lower():
+                    return d
+        return None
+
+
+    def get_name(self):
+        # last part of the path is the name
+        name = self.module.params.get('path').split('/')[-1:]
+        return name
+
+
+    def get_domain(self, key=None):
+        if not self.domain:
+            self.domain = self._get_domain_internal()
+        return self._get_by_key(key, self.domain)
+
+
+    def get_parent_domain(self, key=None):
+        path = self.module.params.get('path')
+        # cut off last /*
+        path = '/'.join(path.split('/')[:-1])
+        if not path:
+            return None
+        parent_domain = self._get_domain_internal(path=path)
+        if not parent_domain:
+            self.module.fail_json(msg="Parent domain path %s does not exist" % path)
+        return self._get_by_key(key, parent_domain)
+
+
+    def present_domain(self):
+        domain = self.get_domain()
+        if not domain:
+            domain = self.create_domain(domain)
+        else:
+            domain = self.update_domain(domain)
+        return domain
+
+
+    def create_domain(self, domain):
+        self.result['changed'] = True
+
+        args                    = {}
+        args['name']            = self.get_name()
+        args['parentdomainid']  = self.get_parent_domain(key='id')
+        args['networkdomain']   = self.module.params.get('network_domain')
+
+        if not self.module.check_mode:
+            res = self.cs.createDomain(**args)
+            if 'errortext' in res:
+                self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+            domain = res['domain']
+        return domain
+
+
+    def update_domain(self, domain):
+        args                    = {}
+        args['id']              = domain['id']
+        args['networkdomain']   = self.module.params.get('network_domain')
+
+        if self._has_changed(args, domain):
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                res = self.cs.updateDomain(**args)
+                if 'errortext' in res:
+                    self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+                domain = res['domain']
+        return domain
+
+
+    def absent_domain(self):
+        domain = self.get_domain()
+        if domain:
+            self.result['changed'] = True
+
+            if not self.module.check_mode:
+                args            = {}
+                args['id']      = domain['id']
+                args['cleanup'] = self.module.params.get('cleanup')
+                res = self.cs.deleteDomain(**args)
+
+                if 'errortext' in res:
+                    self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+
+                poll_async = self.module.params.get('poll_async')
+                if poll_async:
+                    res = self._poll_job(res, 'domain')
+        return domain
+
+
+    def get_result(self, domain):
+        if domain:
+            if 'id' in domain:
+                self.result['id'] = domain['id']
+            if 'name' in domain:
+                self.result['name'] = domain['name']
+            if 'path' in domain:
+                self.result['path'] = domain['path']
+            if 'parentdomainname' in domain:
+                self.result['parent_domain'] = domain['parentdomainname']
+            if 'networkdomain' in domain:
+                self.result['network_domain'] = domain['networkdomain']
+        return self.result
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            path = dict(required=True),
+            state = dict(choices=['present', 'absent'], default='present'),
+            network_domain = dict(default=None),
+            cleanup = dict(choices=BOOLEANS, default=False),
+            poll_async = dict(choices=BOOLEANS, default=True),
+            api_key = dict(default=None),
+            api_secret = dict(default=None, no_log=True),
+            api_url = dict(default=None),
+            api_http_method = dict(choices=['get', 'post'], default='get'),
+            api_timeout = dict(type='int', default=10),
+        ),
+        required_together = (
+            ['api_key', 'api_secret', 'api_url'],
+        ),
+        supports_check_mode=True
+    )
+
+    if not has_lib_cs:
+        module.fail_json(msg="python library cs required: pip install cs")
+
+    try:
+        acs_dom = AnsibleCloudStackDomain(module)
+
+        state = module.params.get('state')
+        if state in ['absent']:
+            domain = acs_dom.absent_domain()
+        else:
+            domain = acs_dom.present_domain()
+
+        result = acs_dom.get_result(domain)
+
+    except CloudStackException, e:
+        module.fail_json(msg='CloudStackException: %s' % str(e))
+
+    module.exit_json(**result)
+
+# import module snippets
+from ansible.module_utils.basic import *
+if __name__ == '__main__':
+    main()