mirror of https://github.com/ansible/ansible.git
cloudstack: new module cs_user
Rene Moser
9 years ago
committed by
Matt Clay
parent
ad54ce6125
commit
52a40510d7
@ -0,0 +1,465 @@
|
||||
#!/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_user
|
||||
short_description: Manages users on Apache CloudStack based clouds.
|
||||
description:
|
||||
- Create, update, disable, lock, enable and remove users.
|
||||
version_added: '2.0'
|
||||
author: "René Moser (@resmo)"
|
||||
options:
|
||||
username:
|
||||
description:
|
||||
- Username of the user.
|
||||
required: true
|
||||
account:
|
||||
description:
|
||||
- Account the user will be created under.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- Password of the user to be created.
|
||||
- Required on C(state=present).
|
||||
- Only considered on creation and will not be updated if user exists.
|
||||
required: false
|
||||
default: null
|
||||
first_name:
|
||||
description:
|
||||
- First name of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
last_name:
|
||||
description:
|
||||
- Last name of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
email:
|
||||
description:
|
||||
- Email of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
timezone:
|
||||
description:
|
||||
- Timezone of the user.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the user is related to.
|
||||
required: false
|
||||
default: 'ROOT'
|
||||
state:
|
||||
description:
|
||||
- State of the user.
|
||||
- C(unlocked) is an alias for C(enabled).
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked' ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# create an user in domain 'CUSTOMERS'
|
||||
local_action:
|
||||
module: cs_user
|
||||
account: developers
|
||||
username: johndoe
|
||||
password: S3Cur3
|
||||
last_name: Doe
|
||||
first_name: John
|
||||
email: john.doe@example.com
|
||||
domain: CUSTOMERS
|
||||
|
||||
# Lock an existing user in domain 'CUSTOMERS'
|
||||
local_action:
|
||||
module: cs_user
|
||||
username: johndoe
|
||||
domain: CUSTOMERS
|
||||
state: locked
|
||||
|
||||
# Disable an existing user in domain 'CUSTOMERS'
|
||||
local_action:
|
||||
module: cs_user
|
||||
username: johndoe
|
||||
domain: CUSTOMERS
|
||||
state: disabled
|
||||
|
||||
# Enable/unlock an existing user in domain 'CUSTOMERS'
|
||||
local_action:
|
||||
module: cs_user
|
||||
username: johndoe
|
||||
domain: CUSTOMERS
|
||||
state: enabled
|
||||
|
||||
# Remove an user in domain 'CUSTOMERS'
|
||||
local_action:
|
||||
module: cs_user
|
||||
name: customer_xy
|
||||
domain: CUSTOMERS
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
---
|
||||
id:
|
||||
description: UUID of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
|
||||
username:
|
||||
description: Username of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: johndoe
|
||||
fist_name:
|
||||
description: First name of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: John
|
||||
last_name:
|
||||
description: Last name of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: Doe
|
||||
email:
|
||||
description: Emailof the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: john.doe@example.com
|
||||
api_key:
|
||||
description: API key of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
|
||||
api_secret:
|
||||
description: API secret of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
|
||||
account:
|
||||
description: Account name of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: developers
|
||||
account_type:
|
||||
description: Type of the account.
|
||||
returned: success
|
||||
type: string
|
||||
sample: user
|
||||
timezone:
|
||||
description: Timezone of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: enabled
|
||||
created:
|
||||
description: Date the user was created.
|
||||
returned: success
|
||||
type: string
|
||||
sample: Doe
|
||||
state:
|
||||
description: State of the user.
|
||||
returned: success
|
||||
type: string
|
||||
sample: enabled
|
||||
domain:
|
||||
description: Domain the user 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 AnsibleCloudStackUser(AnsibleCloudStack):
|
||||
|
||||
def __init__(self, module):
|
||||
super(AnsibleCloudStackUser, self).__init__(module)
|
||||
self.returns = {
|
||||
'username': 'username',
|
||||
'firstname': 'first_name',
|
||||
'lastname': 'last_name',
|
||||
'email': 'email',
|
||||
'secretkey': 'api_secret',
|
||||
'apikey': 'api_key',
|
||||
'timezone': 'timezone',
|
||||
}
|
||||
self.account_types = {
|
||||
'user': 0,
|
||||
'root_admin': 1,
|
||||
'domain_admin': 2,
|
||||
}
|
||||
self.user = None
|
||||
|
||||
|
||||
def get_account_type(self):
|
||||
account_type = self.module.params.get('account_type')
|
||||
return self.account_types[account_type]
|
||||
|
||||
|
||||
def get_user(self):
|
||||
if not self.user:
|
||||
args = {}
|
||||
args['domainid'] = self.get_domain('id')
|
||||
users = self.cs.listUsers(**args)
|
||||
if users:
|
||||
user_name = self.module.params.get('username')
|
||||
for u in users['user']:
|
||||
if user_name.lower() == u['username'].lower():
|
||||
self.user = u
|
||||
break
|
||||
return self.user
|
||||
|
||||
|
||||
def enable_user(self):
|
||||
user = self.get_user()
|
||||
if not user:
|
||||
user = self.present_user()
|
||||
|
||||
if user['state'].lower() != 'enabled':
|
||||
self.result['changed'] = True
|
||||
args = {}
|
||||
args['id'] = user['id']
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.enableUser(**args)
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
user = res['user']
|
||||
return user
|
||||
|
||||
|
||||
def lock_user(self):
|
||||
user = self.get_user()
|
||||
if not user:
|
||||
user = self.present_user()
|
||||
|
||||
# we need to enable the user to lock it.
|
||||
if user['state'].lower() == 'disabled':
|
||||
user = self.enable_user()
|
||||
|
||||
if user['state'].lower() != 'locked':
|
||||
self.result['changed'] = True
|
||||
args = {}
|
||||
args['id'] = user['id']
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.lockUser(**args)
|
||||
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
|
||||
user = res['user']
|
||||
return user
|
||||
|
||||
|
||||
def disable_user(self):
|
||||
user = self.get_user()
|
||||
if not user:
|
||||
user = self.present_user()
|
||||
|
||||
if user['state'].lower() != 'disabled':
|
||||
self.result['changed'] = True
|
||||
args = {}
|
||||
args['id'] = user['id']
|
||||
if not self.module.check_mode:
|
||||
user = self.cs.disableUser(**args)
|
||||
if 'errortext' in user:
|
||||
self.module.fail_json(msg="Failed: '%s'" % user['errortext'])
|
||||
|
||||
poll_async = self.module.params.get('poll_async')
|
||||
if poll_async:
|
||||
user = self._poll_job(user, 'user')
|
||||
return user
|
||||
|
||||
|
||||
def present_user(self):
|
||||
missing_params = []
|
||||
for required_params in [
|
||||
'account',
|
||||
'email',
|
||||
'password',
|
||||
'first_name',
|
||||
'last_name',
|
||||
]:
|
||||
if not self.module.params.get(required_params):
|
||||
missing_params.append(required_params)
|
||||
if missing_params:
|
||||
self.module.fail_json(msg="missing required arguments: %s" % ','.join(missing_params))
|
||||
|
||||
user = self.get_user()
|
||||
if user:
|
||||
user = self._update_user(user)
|
||||
else:
|
||||
user = self._create_user(user)
|
||||
return user
|
||||
|
||||
|
||||
def _create_user(self, user):
|
||||
self.result['changed'] = True
|
||||
|
||||
args = {}
|
||||
args['account'] = self.get_account(key='name')
|
||||
args['domainid'] = self.get_domain('id')
|
||||
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.createUser(**args)
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
user = res['user']
|
||||
# register user api keys
|
||||
res = self.cs.registerUserKeys(id=user['id'])
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
user.update(res['userkeys'])
|
||||
return user
|
||||
|
||||
|
||||
def _update_user(self, user):
|
||||
args = {}
|
||||
args['id'] = user['id']
|
||||
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 self.has_changed(args, user):
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.updateUser(**args)
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
user = res['user']
|
||||
# register user api keys
|
||||
if 'apikey' not in user:
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.registerUserKeys(id=user['id'])
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
user.update(res['userkeys'])
|
||||
return user
|
||||
|
||||
|
||||
def absent_user(self):
|
||||
user = self.get_user()
|
||||
if user:
|
||||
self.result['changed'] = True
|
||||
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.deleteUser(id=user['id'])
|
||||
|
||||
if 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
return user
|
||||
|
||||
|
||||
def get_result(self, user):
|
||||
super(AnsibleCloudStackUser, self).get_result(user)
|
||||
if user:
|
||||
if 'accounttype' in user:
|
||||
for key,value in self.account_types.items():
|
||||
if value == user['accounttype']:
|
||||
self.result['account_type'] = key
|
||||
break
|
||||
return self.result
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec = dict(
|
||||
username = dict(required=True),
|
||||
account = dict(default=None),
|
||||
state = dict(choices=['present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked'], default='present'),
|
||||
domain = dict(default='ROOT'),
|
||||
email = dict(default=None),
|
||||
first_name = dict(default=None),
|
||||
last_name = 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, no_log=True),
|
||||
api_url = dict(default=None),
|
||||
api_http_method = dict(choices=['get', 'post'], default='get'),
|
||||
api_timeout = dict(type='int', default=10),
|
||||
api_region = dict(default='cloudstack'),
|
||||
),
|
||||
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_acc = AnsibleCloudStackUser(module)
|
||||
|
||||
state = module.params.get('state')
|
||||
|
||||
if state in ['absent']:
|
||||
user = acs_acc.absent_user()
|
||||
|
||||
elif state in ['enabled', 'unlocked']:
|
||||
user = acs_acc.enable_user()
|
||||
|
||||
elif state in ['disabled']:
|
||||
user = acs_acc.disable_user()
|
||||
|
||||
elif state in ['locked']:
|
||||
user = acs_acc.lock_user()
|
||||
|
||||
else:
|
||||
user = acs_acc.present_user()
|
||||
|
||||
result = acs_acc.get_result(user)
|
||||
|
||||
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()
|
||||
Loading…
Reference in New Issue