mirror of https://github.com/ansible/ansible.git
New module: vmware_local_users_manager (#2447)
* Add files via upload * Add files via upload * Fixed build errors * Fixed some identation errors * Documentation corrections * Documentation updatespull/18777/head
parent
5cdc905cab
commit
cb43a69d8b
@ -0,0 +1,197 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright IBM Corp. 2016
|
||||
# Author(s): Andreas Nafpliotis <nafpliot@de.ibm.com>
|
||||
|
||||
# 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: vmware_local_user_manager
|
||||
short_description: Manage local users on an ESXi host
|
||||
description:
|
||||
- Manage local users on an ESXi host
|
||||
version_added: "2.2"
|
||||
author: Andreas Nafpliotis
|
||||
notes:
|
||||
- Tested on ESXi 6.0
|
||||
- Be sure that the ESXi user used for login, has the appropriate rights to create / delete / edit users
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- PyVmomi installed
|
||||
options:
|
||||
local_user_name:
|
||||
description:
|
||||
- The local user name to be changed
|
||||
required: True
|
||||
local_user_password:
|
||||
description:
|
||||
- The password to be set
|
||||
required: False
|
||||
local_user_description:
|
||||
description:
|
||||
- Description for the user
|
||||
required: False
|
||||
state:
|
||||
description:
|
||||
- Indicate desired state of the user. If the user already exists when C(state=present), the user info is updated
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
extends_documentation_fragment: vmware.documentation
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example vmware_local_user_manager command from Ansible Playbooks
|
||||
- name: Add local user to ESXi
|
||||
local_action:
|
||||
module: vmware_local_user_manager
|
||||
hostname: esxi_hostname
|
||||
username: root
|
||||
password: vmware
|
||||
local_user_name: foo
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
changed:
|
||||
description: A flag indicating if any change was made or not.
|
||||
returned: success
|
||||
type: boolean
|
||||
sample: True
|
||||
'''
|
||||
|
||||
try:
|
||||
from pyVmomi import vim, vmodl
|
||||
HAS_PYVMOMI = True
|
||||
except ImportError:
|
||||
HAS_PYVMOMI = False
|
||||
|
||||
|
||||
class VMwareLocalUserManager(object):
|
||||
def __init__(self, module):
|
||||
self.module = module
|
||||
self.content = connect_to_api(self.module)
|
||||
self.local_user_name = self.module.params['local_user_name']
|
||||
self.local_user_password = self.module.params['local_user_password']
|
||||
self.local_user_description = self.module.params['local_user_description']
|
||||
self.state = self.module.params['state']
|
||||
|
||||
def process_state(self):
|
||||
try:
|
||||
local_account_manager_states = {
|
||||
'absent': {
|
||||
'present': self.state_remove_user,
|
||||
'absent': self.state_exit_unchanged,
|
||||
},
|
||||
'present': {
|
||||
'present': self.state_update_user,
|
||||
'absent': self.state_create_user,
|
||||
}
|
||||
}
|
||||
|
||||
local_account_manager_states[self.state][self.check_local_user_manager_state()]()
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
self.module.fail_json(msg=runtime_fault.msg)
|
||||
except vmodl.MethodFault as method_fault:
|
||||
self.module.fail_json(msg=method_fault.msg)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
def check_local_user_manager_state(self):
|
||||
user_account = self.find_user_account()
|
||||
if not user_account:
|
||||
return 'absent'
|
||||
else:
|
||||
return 'present'
|
||||
|
||||
|
||||
def find_user_account(self):
|
||||
searchStr = self.local_user_name
|
||||
exactMatch = True
|
||||
findUsers = True
|
||||
findGroups = False
|
||||
user_account = self.content.userDirectory.RetrieveUserGroups(None, searchStr, None, None, exactMatch, findUsers, findGroups)
|
||||
return user_account
|
||||
|
||||
|
||||
def create_account_spec(self):
|
||||
account_spec = vim.host.LocalAccountManager.AccountSpecification()
|
||||
account_spec.id = self.local_user_name
|
||||
account_spec.password = self.local_user_password
|
||||
account_spec.description = self.local_user_description
|
||||
return account_spec
|
||||
|
||||
|
||||
def state_create_user(self):
|
||||
account_spec = self.create_account_spec()
|
||||
|
||||
try:
|
||||
task = self.content.accountManager.CreateUser(account_spec)
|
||||
self.module.exit_json(changed=True)
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
module.fail_json(msg=runtime_fault.msg)
|
||||
except vmodl.MethodFault as method_fault:
|
||||
module.fail_json(msg=method_fault.msg)
|
||||
|
||||
def state_update_user(self):
|
||||
account_spec = self.create_account_spec()
|
||||
|
||||
try:
|
||||
task = self.content.accountManager.UpdateUser(account_spec)
|
||||
self.module.exit_json(changed=True)
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
module.fail_json(msg=runtime_fault.msg)
|
||||
except vmodl.MethodFault as method_fault:
|
||||
module.fail_json(msg=method_fault.msg)
|
||||
|
||||
|
||||
def state_remove_user(self):
|
||||
try:
|
||||
task = self.content.accountManager.RemoveUser(self.local_user_name)
|
||||
self.module.exit_json(changed=True)
|
||||
except vmodl.RuntimeFault as runtime_fault:
|
||||
module.fail_json(msg=runtime_fault.msg)
|
||||
except vmodl.MethodFault as method_fault:
|
||||
module.fail_json(msg=method_fault.msg)
|
||||
|
||||
|
||||
def state_exit_unchanged(self):
|
||||
self.module.exit_json(changed=False)
|
||||
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec = vmware_argument_spec()
|
||||
argument_spec.update(dict(local_user_name=dict(required=True, type='str'),
|
||||
local_user_password=dict(required=False, type='str', no_log=True),
|
||||
local_user_description=dict(required=False, type='str'),
|
||||
state=dict(default='present', choices=['present', 'absent'], type='str')))
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
|
||||
|
||||
if not HAS_PYVMOMI:
|
||||
module.fail_json(msg='pyvmomi is required for this module')
|
||||
|
||||
vmware_local_user_manager = VMwareLocalUserManager(module)
|
||||
vmware_local_user_manager.process_state()
|
||||
|
||||
from ansible.module_utils.vmware import *
|
||||
from ansible.module_utils.basic import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in New Issue