cloudstack: add new module cs_account

cloud/cloudstack/cs_account.py

@@ -0,0 +1,408 @@
+#!/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_account
+short_description: Manages account on Apache CloudStack based clouds.
+description:
+    - Create, disable, lock, enable and remove accounts.
+version_added: '2.0'
+author: René Moser
+options:
+  name:
+    description:
+      - Name of account.
+    required: true
+  username:
+    description:
+      - Username of the user to be created if account did not exist.
+      - Required on C(state=present).
+    required: false
+    default: null
+  password:
+    description:
+      - Password of the user to be created if account did not exist.
+      - Required on C(state=present).
+    required: false
+    default: null
+  first_name:
+    description:
+      - First name of the user to be created if account did not exist.
+      - Required on C(state=present).
+    required: false
+    default: null
+  last_name:
+    description:
+      - Last name of the user to be created if account did not exist.
+      - Required on C(state=present).
+    required: false
+    default: null
+  email:
+    description:
+      - Email of the user to be created if account did not exist.
+      - Required on C(state=present).
+    required: false
+    default: null
+  timezone:
+    description:
+      - Timezone of the user to be created if account did not exist.
+    required: false
+    default: null
+  network_domain:
+    description:
+      - Network domain of the account.
+    required: false
+    default: null
+  account_type:
+    description:
+      - Type of the account.
+    required: false
+    default: 'user'
+    choices: [ 'user', 'root_admin', 'domain_admin' ]
+  domain:
+    description:
+      - Domain the account is related to.
+    required: false
+    default: 'ROOT'
+  state:
+    description:
+      - State of the account.
+    required: false
+    default: 'present'
+    choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked' ]
+  poll_async:
+    description:
+      - Poll async jobs until job has finished.
+    required: false
+    default: true
+extends_documentation_fragment: cloudstack
+'''
+
+EXAMPLES = '''
+---
+# create an account in domain 'CUSTOMERS'
+local_action:
+  module: cs_account
+  name: customer_xy
+  username: customer_xy
+  password: S3Cur3
+  last_name: Doe
+  first_name: John
+  email: john.doe@example.com
+  domain: CUSTOMERS
+
+
+# Lock an existing account in domain 'CUSTOMERS'
+local_action:
+  module: cs_account
+  name: customer_xy
+  domain: CUSTOMERS
+  state: locked
+
+
+# Disable an existing account in domain 'CUSTOMERS'
+local_action:
+  module: cs_account
+  name: customer_xy
+  domain: CUSTOMERS
+  state: disabled
+
+
+# Enable an existing account in domain 'CUSTOMERS'
+local_action:
+  module: cs_account
+  name: customer_xy
+  domain: CUSTOMERS
+  state: enabled
+
+
+# Remove an account in domain 'CUSTOMERS'
+local_action:
+  module: cs_account
+  name: customer_xy
+  domain: CUSTOMERS
+  state: absent
+'''
+
+RETURN = '''
+---
+name:
+  description: Name of the account.
+  returned: success
+  type: string
+  sample: linus@example.com
+account_type:
+  description: Type of the account.
+  returned: success
+  type: string
+  sample: user
+account_state:
+  description: State of the account.
+  returned: success
+  type: string
+  sample: enabled
+network_domain:
+  description: Network domain of the account.
+  returned: success
+  type: string
+  sample: example.local
+domain:
+  description: Domain the account is related.
+  returned: success
+  type: string
+  sample: ROOT
+'''
+
+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 AnsibleCloudStackAccount(AnsibleCloudStack):
+
+    def __init__(self, module):
+        AnsibleCloudStack.__init__(self, module)
+        self.account = None
+        self.account_types = {
+            'user':         0,
+            'root_admin':   1,
+            'domain_admin': 2,
+        }
+
+
+    def get_account_type(self):
+        account_type = self.module.params.get('account_type')
+        return self.account_types[account_type]
+
+
+    def get_account(self):
+        if not self.account:
+            args                = {}
+            args['listall']     = True
+            args['domainid']    = self.get_domain('id')
+            accounts = self.cs.listAccounts(**args)
+            if accounts:
+                account_name = self.module.params.get('name')
+                for a in accounts['account']:
+                    if account_name in [ a['name'] ]:
+                        self.account = a
+                        break
+
+        return self.account
+
+
+    def enable_account(self):
+        account = self.get_account()
+        if not account:
+            self.module.fail_json(msg="Failed: account not present")
+
+        if account['state'].lower() != 'enabled':
+            self.result['changed'] = True
+            args                    = {}
+            args['id']              = account['id']
+            args['account']         = self.module.params.get('name')
+            args['domainid']        = self.get_domain('id')
+            if not self.module.check_mode:
+                res = self.cs.enableAccount(**args)
+                if 'errortext' in res:
+                    self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+                account = res['account']
+        return account
+
+
+    def lock_account(self):
+        return self.lock_or_disable_account(lock=True)
+
+
+    def disable_account(self):
+        return self.lock_or_disable_account()
+
+
+    def lock_or_disable_account(self, lock=False):
+        account = self.get_account()
+        if not account:
+            self.module.fail_json(msg="Failed: account not present")
+
+        # we need to enable the account to lock it.
+        if lock and account['state'].lower() == 'disabled':
+            account = self.enable_account()
+
+        if lock and account['state'].lower() != 'locked' \
+           or not lock and account['state'].lower() != 'disabled':
+            self.result['changed'] = True
+            args                    = {}
+            args['id']              = account['id']
+            args['account']         = self.module.params.get('name')
+            args['domainid']        = self.get_domain('id')
+            args['lock']            = lock
+            if not self.module.check_mode:
+                account = self.cs.disableAccount(**args)
+
+                if 'errortext' in account:
+                    self.module.fail_json(msg="Failed: '%s'" % account['errortext'])
+
+                poll_async = self.module.params.get('poll_async')
+                if poll_async:
+                    account = self._poll_job(account, 'account')
+        return account
+
+
+    def present_account(self):
+        missing_params = []
+
+        if not self.module.params.get('email'):
+            missing_params.append('email')
+
+        if not self.module.params.get('username'):
+            missing_params.append('username')
+
+        if not self.module.params.get('password'):
+            missing_params.append('password')
+
+        if not self.module.params.get('first_name'):
+            missing_params.append('first_name')
+
+        if not self.module.params.get('last_name'):
+            missing_params.append('last_name')
+
+        if missing_params:
+            self.module.fail_json(msg="missing required arguments: %s" % ','.join(missing_params))
+
+        account = self.get_account()
+
+        if not account:
+            self.result['changed'] = True
+
+            args                    = {}
+            args['account']         = self.module.params.get('name')
+            args['domainid']        = self.get_domain('id')
+            args['accounttype']     = self.get_account_type()
+            args['networkdomain']   = self.module.params.get('network_domain')
+            args['username']        = self.module.params.get('username')
+            args['password']        = self.module.params.get('password')
+            args['firstname']       = self.module.params.get('first_name')
+            args['lastname']        = self.module.params.get('last_name')
+            args['email']           = self.module.params.get('email')
+            args['timezone']        = self.module.params.get('timezone')
+            if not self.module.check_mode:
+                res = self.cs.createAccount(**args)
+                if 'errortext' in res:
+                    self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+                account = res['account']
+        return account
+
+
+    def absent_account(self):
+        account = self.get_account()
+        if account:
+            self.result['changed'] = True
+
+            if not self.module.check_mode:
+                res = self.cs.deleteAccount(id=account['id'])
+
+                if 'errortext' in account:
+                    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, 'account')
+        return account
+
+
+    def get_result(self, account):
+        if account:
+            if 'name' in account:
+                self.result['name'] = account['name']
+            if 'accounttype' in account:
+                for key,value in self.account_types.items():
+                    if value == account['accounttype']:
+                        self.result['account_type'] = key
+                        break
+            if 'state' in account:
+                self.result['account_state'] = account['state']
+            if 'domain' in account:
+                self.result['domain'] = account['domain']
+            if 'networkdomain' in account:
+                self.result['network_domain'] = account['networkdomain']
+        return self.result
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            name = dict(required=True),
+            state = dict(choices=['present', 'absent', 'enabled', 'disabled', 'locked' ], default='present'),
+            account_type = dict(choices=['user', 'root_admin', 'domain_admin'], default='user'),
+            network_domain = dict(default=None),
+            domain = dict(default='ROOT'),
+            email = dict(default=None),
+            first_name = dict(default=None),
+            last_name = dict(default=None),
+            username = dict(default=None),
+            password = dict(default=None),
+            timezone = dict(default=None),
+            poll_async = dict(choices=BOOLEANS, default=True),
+            api_key = dict(default=None),
+            api_secret = dict(default=None),
+            api_url = dict(default=None),
+            api_http_method = dict(default='get'),
+        ),
+        supports_check_mode=True
+    )
+
+    if not has_lib_cs:
+        module.fail_json(msg="python library cs required: pip install cs")
+
+    try:
+        acs_acc = AnsibleCloudStackAccount(module)
+
+        state = module.params.get('state')
+
+        if state in ['absent']:
+            account = acs_acc.absent_account()
+
+        elif state in ['enabled']:
+            account = acs_acc.enable_account()
+
+        elif state in ['disabled']:
+            account = acs_acc.disable_account()
+
+        elif state in ['locked']:
+            account = acs_acc.lock_account()
+
+        else:
+            account = acs_acc.present_account()
+
+        result = acs_acc.get_result(account)
+
+    except CloudStackException, e:
+        module.fail_json(msg='CloudStackException: %s' % str(e))
+
+    module.exit_json(**result)
+
+# import module snippets
+from ansible.module_utils.basic import *
+main()