archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

VMware: Refactor vmware_maintenancemode module (#35000)

Browse Source 
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/35045/head
Abhijeet Kasurde 7 years ago committed by ansibot
parent 8a6d699198
commit cf88bfdbbf
1 changed files with 97 additions and 106 deletions
Show Stats Download Patch File Download Diff File

203
lib/ansible/modules/cloud/vmware/vmware_maintenancemode.py
Unescape Escape View File

@ -1,16 +1,18 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Copyright: (c) 2015, VMware, Inc.
# (c) 2015, VMware, Inc. # Copyright: (c) 2018, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {
'status': ['preview'], 'metadata_version': '1.1',
'supported_by': 'community'} 'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = ''' DOCUMENTATION = '''
@ -18,23 +20,25 @@ DOCUMENTATION = '''
module: vmware_maintenancemode module: vmware_maintenancemode
short_description: Place a host into maintenance mode short_description: Place a host into maintenance mode
description: description:
- Place an ESXI host into maintenance mode - This module can be used for placing a ESXi host into maintenance mode.
- Support for VSAN compliant maintenance mode when selected - Support for VSAN compliant maintenance mode when selected.
author: "Jay Jahns <jjahns@vmware.com>" author:
- "Jay Jahns <jjahns@vmware.com>"
- "Abhijeet Kasurde (@akasurde)"
version_added: "2.1" version_added: "2.1"
notes: notes:
- Tested on vSphere 5.5 and 6.0 - Tested on vSphere 5.5, 6.0 and 6.5
requirements: requirements:
- "python >= 2.6" - "python >= 2.6"
- PyVmomi - PyVmomi
options: options:
esxi_hostname: esxi_hostname:
description: description:
- Name of the host as defined in vCenter - Name of the host as defined in vCenter.
required: True required: True
vsan_mode: vsan_mode:
description: description:
- Specify which VSAN compliant mode to enter - Specify which VSAN compliant mode to enter.
choices: choices:
- 'ensureObjectAccessibility' - 'ensureObjectAccessibility'
- 'evacuateAllData' - 'evacuateAllData'
@ -42,7 +46,7 @@ options:
required: False required: False
evacuate: evacuate:
description: description:
- If True, evacuate all powered off VMs - If True, evacuate all powered off VMs.
choices: choices:
- True - True
- False - False
@ -50,12 +54,12 @@ options:
required: False required: False
timeout: timeout:
description: description:
- Specify a timeout for the operation - Specify a timeout for the operation.
required: False required: False
default: 0 default: 0
state: state:
description: description:
- Enter or exit maintenance mode - Enter or exit maintenance mode.
choices: choices:
- present - present
- absent - absent
@ -66,8 +70,7 @@ extends_documentation_fragment: vmware.documentation
EXAMPLES = ''' EXAMPLES = '''
- name: Enter VSAN-Compliant Maintenance Mode - name: Enter VSAN-Compliant Maintenance Mode
local_action: vmware_maintenancemode:
module: vmware_maintenancemode
hostname: vc_host hostname: vc_host
username: vc_user username: vc_user
password: vc_pass password: vc_pass
@ -77,6 +80,7 @@ EXAMPLES = '''
timeout: 3600 timeout: 3600
state: present state: present
''' '''
RETURN = ''' RETURN = '''
hostsystem: hostsystem:
description: Name of vim reference description: Name of vim reference
@ -97,109 +101,96 @@ status:
try: try:
from pyVmomi import vim from pyVmomi import vim
HAS_PYVMOMI = True
except ImportError: except ImportError:
HAS_PYVMOMI = False pass
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.vmware import (HAS_PYVMOMI, TaskError, connect_to_api, find_hostsystem_by_name, from ansible.module_utils.vmware import PyVmomi, TaskError, vmware_argument_spec, wait_for_task
vmware_argument_spec, wait_for_task) from ansible.module_utils._text import to_native
def EnterMaintenanceMode(module, host): class VmwareMaintenanceMgr(PyVmomi):
def __init__(self, module):
if host.runtime.inMaintenanceMode: super(VmwareMaintenanceMgr, self).__init__(module)
module.exit_json( self.esxi_hostname = self.module.params.get('esxi_hostname')
changed=False, self.vsan = self.module.params.get('vsan', None)
hostsystem=str(host), self.host = self.find_hostsystem_by_name(host_name=self.esxi_hostname)
hostname=module.params['esxi_hostname'], if not self.host:
status='NO_ACTION', self.module.fail_json(msg='Host %s not found in vCenter' % self.esxi_hostname)
msg='Host already in maintenance mode')
def EnterMaintenanceMode(self):
spec = vim.host.MaintenanceSpec() if self.host.runtime.inMaintenanceMode:
self.module.exit_json(changed=False,
if module.params['vsan']: hostsystem=str(self.host),
spec.vsanMode = vim.vsan.host.DecommissionMode() hostname=self.esxi_hostname,
spec.vsanMode.objectAction = module.params['vsan'] status='NO_ACTION',
msg='Host %s already in maintenance mode' % self.esxi_hostname)
try:
task = host.EnterMaintenanceMode_Task( spec = vim.host.MaintenanceSpec()
module.params['timeout'],
module.params['evacuate'], if self.vsan:
spec) spec.vsanMode = vim.vsan.host.DecommissionMode()
spec.vsanMode.objectAction = self.vsan
success, result = wait_for_task(task)
try:
return dict(changed=success, task = self.host.EnterMaintenanceMode_Task(self.module.params['timeout'],
hostsystem=str(host), self.module.params['evacuate'],
hostname=module.params['esxi_hostname'], spec)
status='ENTER',
msg='Host entered maintenance mode') success, result = wait_for_task(task)
except TaskError: self.module.exit_json(changed=success,
module.fail_json( hostsystem=str(self.host),
msg='Host failed to enter maintenance mode') hostname=self.esxi_hostname,
status='ENTER',
msg='Host %s entered maintenance mode' % self.esxi_hostname)
def ExitMaintenanceMode(module, host):
if not host.runtime.inMaintenanceMode: except TaskError as e:
module.exit_json( self.module.fail_json(msg='Host %s failed to enter maintenance mode due to %s' % (self.esxi_hostname, to_native(e)))
changed=False,
hostsystem=str(host), def ExitMaintenanceMode(self):
hostname=module.params['esxi_hostname'], if not self.host.runtime.inMaintenanceMode:
status='NO_ACTION', self.module.exit_json(changed=False,
msg='Host not in maintenance mode') hostsystem=str(self.host),
hostname=self.esxi_hostname,
try: status='NO_ACTION',
task = host.ExitMaintenanceMode_Task( msg='Host %s not in maintenance mode' % self.esxi_hostname)
module.params['timeout'])
try:
success, result = wait_for_task(task) task = self.host.ExitMaintenanceMode_Task(self.module.params['timeout'])
return dict(changed=success, success, result = wait_for_task(task)
hostsystem=str(host),
hostname=module.params['esxi_hostname'], self.module.exit_json(changed=success,
status='EXIT', hostsystem=str(self.host),
msg='Host exited maintenance mode') hostname=self.esxi_hostname,
status='EXIT',
except TaskError: msg='Host %s exited maintenance mode' % self.esxi_hostname)
module.fail_json( except TaskError as e:
msg='Host failed to exit maintenance mode') self.module.fail_json(msg='Host %s failed to exit maintenance mode due to %s' % (self.esxi_hostname, to_native(e)))
def main(): def main():
spec = vmware_argument_spec() spec = vmware_argument_spec()
spec.update(dict( spec.update(dict(esxi_hostname=dict(type='str', required=True),
esxi_hostname=dict(required=True), vsan=dict(type='str', choices=['ensureObjectAccessibility',
vsan=dict(required=False, choices=['ensureObjectAccessibility', 'evacuateAllData',
'evacuateAllData', 'noAction']
'noAction']), ),
evacuate=dict(required=False, type='bool', default=False), evacuate=dict(type='bool', default=False),
timeout=dict(required=False, default=0, type='int'), timeout=dict(default=0, type='int'),
state=dict(required=False, state=dict(required=False, default='present', choices=['present', 'absent'])
default='present', )
choices=['present', 'absent']))) )
module = AnsibleModule(argument_spec=spec) module = AnsibleModule(argument_spec=spec)
if not HAS_PYVMOMI: host_maintenance_mgr = VmwareMaintenanceMgr(module=module)
module.fail_json(msg='pyvmomi is required for this module')
content = connect_to_api(module)
host = find_hostsystem_by_name(content, module.params['esxi_hostname'])
if not host:
module.fail_json(
msg='Host not found in vCenter')
if module.params['state'] == 'present': if module.params['state'] == 'present':
result = EnterMaintenanceMode(module, host) host_maintenance_mgr.EnterMaintenanceMode()
elif module.params['state'] == 'absent': elif module.params['state'] == 'absent':
result = ExitMaintenanceMode(module, host) host_maintenance_mgr.ExitMaintenanceMode()
module.exit_json(**result)
if __name__ == '__main__': if __name__ == '__main__':

Write Preview
Loading…
Cancel
Save