ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-08-05 05:34:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

VMware: refactor vmware_dvs_host (#35440)

Browse source 
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2018-01-29 18:26:39 +05:30 • committed by ansibot
commit cb96f8a250
1 changed files with 68 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

140
lib/ansible/modules/cloud/vmware/vmware_dvs_host.py
View file

@ -1,16 +1,20 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# (c) 2015, Joseph Callen <jcallen () csc.com> # Copyright: (c) 2015, Joseph Callen <jcallen () csc.com>
# Copyright: (c) 2018, Ansible Project
# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com>
# 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,9 +22,11 @@ DOCUMENTATION = '''
module: vmware_dvs_host module: vmware_dvs_host
short_description: Add or remove a host from distributed virtual switch short_description: Add or remove a host from distributed virtual switch
description: description:
- Add or remove a host from distributed virtual switch - Manage a host system from distributed virtual switch.
version_added: 2.0 version_added: 2.0
author: "Joseph Callen (@jcpowermac)" author:
- "Joseph Callen (@jcpowermac)"
- "Abhijeet Kasurde (@akasurde)"
notes: notes:
- Tested on vSphere 5.5 - Tested on vSphere 5.5
requirements: requirements:
@ -29,26 +35,25 @@ requirements:
options: options:
esxi_hostname: esxi_hostname:
description: description:
- The ESXi hostname - The ESXi hostname.
required: True required: True
switch_name: switch_name:
description: description:
- The name of the Distributed vSwitch - The name of the Distributed vSwitch.
required: True required: True
vmnics: vmnics:
description: description:
- The ESXi hosts vmnics to use with the Distributed vSwitch - The ESXi hosts vmnics to use with the Distributed vSwitch.
required: True required: True
state: state:
description: description:
- If the host should be present or absent attached to the vSwitch - If the host should be present or absent attached to the vSwitch.
choices: ['present', 'absent'] choices: [present, absent]
required: True required: True
extends_documentation_fragment: vmware.documentation extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Example vmware_dvs_host command from Ansible Playbooks
- name: Add Host to dVS - name: Add Host to dVS
local_action: local_action:
module: vmware_dvs_host module: vmware_dvs_host
@ -66,75 +71,64 @@ EXAMPLES = '''
try: try:
from collections import Counter from collections import Counter
HAS_COLLECTIONS_COUNTER = True HAS_COLLECTIONS_COUNTER = True
except ImportError: except ImportError as e:
HAS_COLLECTIONS_COUNTER = False HAS_COLLECTIONS_COUNTER = False
try: try:
from pyVmomi import vim, vmodl from pyVmomi import vim, vmodl
HAS_PYVMOMI = True except ImportError as e:
except ImportError: pass
HAS_PYVMOMI = False
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.vmware import (HAS_PYVMOMI, connect_to_api, find_dvs_by_name, from ansible.module_utils.vmware import (PyVmomi, find_dvs_by_name, find_hostsystem_by_name,
find_hostsystem_by_name, vmware_argument_spec, wait_for_task) vmware_argument_spec, wait_for_task)
from ansible.module_utils._text import to_native
class VMwareDvsHost(object): class VMwareDvsHost(PyVmomi):
def __init__(self, module): def __init__(self, module):
self.module = module super(VMwareDvsHost, self).__init__(module)
self.dv_switch = None self.dv_switch = None
self.uplink_portgroup = None self.uplink_portgroup = None
self.host = None self.host = None
self.dv_switch = None self.dv_switch = None
self.nic = None self.nic = None
self.content = connect_to_api(self.module)
self.state = self.module.params['state'] self.state = self.module.params['state']
self.switch_name = self.module.params['switch_name'] self.switch_name = self.module.params['switch_name']
self.esxi_hostname = self.module.params['esxi_hostname'] self.esxi_hostname = self.module.params['esxi_hostname']
self.vmnics = self.module.params['vmnics'] self.vmnics = self.module.params['vmnics']
def process_state(self): def process_state(self):
try: dvs_host_states = {
dvs_host_states = { 'absent': {
'absent': { 'present': self.state_destroy_dvs_host,
'present': self.state_destroy_dvs_host, 'absent': self.state_exit_unchanged,
'absent': self.state_exit_unchanged, },
}, 'present': {
'present': { 'update': self.state_update_dvs_host,
'update': self.state_update_dvs_host, 'present': self.state_exit_unchanged,
'present': self.state_exit_unchanged, 'absent': self.state_create_dvs_host,
'absent': self.state_create_dvs_host,
}
} }
}
try:
dvs_host_states[self.state][self.check_dvs_host_state()]() dvs_host_states[self.state][self.check_dvs_host_state()]()
except vmodl.RuntimeFault as runtime_fault: except vmodl.RuntimeFault as runtime_fault:
self.module.fail_json(msg=runtime_fault.msg) self.module.fail_json(msg=to_native(runtime_fault.msg))
except vmodl.MethodFault as method_fault: except vmodl.MethodFault as method_fault:
self.module.fail_json(msg=method_fault.msg) self.module.fail_json(msg=to_native(method_fault.msg))
except Exception as e: except Exception as e:
self.module.fail_json(msg=str(e)) self.module.fail_json(msg=to_native(e))
def find_dvspg_by_name(self):
portgroups = self.dv_switch.portgroup
for pg in portgroups:
if pg.name == self.portgroup_name:
return pg
return None
def find_dvs_uplink_pg(self): def find_dvs_uplink_pg(self):
# There should only always be a single uplink port group on # There should only always be a single uplink port group on
# a distributed virtual switch # a distributed virtual switch
dvs_uplink_pg = self.dv_switch.config.uplinkPortgroup[0] if len(self.dv_switch.config.uplinkPortgroup) else None
if len(self.dv_switch.config.uplinkPortgroup): return dvs_uplink_pg
return self.dv_switch.config.uplinkPortgroup[0]
else:
return None
# operation should be edit, add and remove # operation should be edit, add and remove
def modify_dvs_host(self, operation): def modify_dvs_host(self, operation):
changed, result = False, None
spec = vim.DistributedVirtualSwitch.ConfigSpec() spec = vim.DistributedVirtualSwitch.ConfigSpec()
spec.configVersion = self.dv_switch.config.configVersion spec.configVersion = self.dv_switch.config.configVersion
spec.host = [vim.dvs.HostMember.ConfigSpec()] spec.host = [vim.dvs.HostMember.ConfigSpec()]
@ -151,39 +145,38 @@ class VMwareDvsHost(object):
spec.host[0].backing.pnicSpec[count].uplinkPortgroupKey = self.uplink_portgroup.key spec.host[0].backing.pnicSpec[count].uplinkPortgroupKey = self.uplink_portgroup.key
count += 1 count += 1
task = self.dv_switch.ReconfigureDvs_Task(spec) try:
changed, result = wait_for_task(task) task = self.dv_switch.ReconfigureDvs_Task(spec)
changed, result = wait_for_task(task)
except vmodl.fault.NotSupported as not_supported:
self.module.fail_json(msg="Failed to configure DVS host %s as it is not"
" compatible with the VDS version." % self.esxi_hostname,
details=to_native(not_supported.msg))
return changed, result return changed, result
def state_destroy_dvs_host(self): def state_destroy_dvs_host(self):
operation = "remove" operation, changed, result = ("remove", True, None)
changed = True
result = None
if not self.module.check_mode: if not self.module.check_mode:
changed, result = self.modify_dvs_host(operation) changed, result = self.modify_dvs_host(operation)
self.module.exit_json(changed=changed, result=str(result)) self.module.exit_json(changed=changed, result=to_native(result))
def state_exit_unchanged(self): def state_exit_unchanged(self):
self.module.exit_json(changed=False) self.module.exit_json(changed=False)
def state_update_dvs_host(self): def state_update_dvs_host(self):
operation = "edit" operation, changed, result = ("edit", True, None)
changed = True
result = None
if not self.module.check_mode: if not self.module.check_mode:
changed, result = self.modify_dvs_host(operation) changed, result = self.modify_dvs_host(operation)
self.module.exit_json(changed=changed, result=str(result)) self.module.exit_json(changed=changed, result=to_native(result))
def state_create_dvs_host(self): def state_create_dvs_host(self):
operation = "add" operation, changed, result = ("add", True, None)
changed = True
result = None
if not self.module.check_mode: if not self.module.check_mode:
changed, result = self.modify_dvs_host(operation) changed, result = self.modify_dvs_host(operation)
self.module.exit_json(changed=changed, result=str(result)) self.module.exit_json(changed=changed, result=to_native(result))
def find_host_attached_dvs(self): def find_host_attached_dvs(self):
for dvs_host_member in self.dv_switch.config.host: for dvs_host_member in self.dv_switch.config.host:
@ -206,13 +199,14 @@ class VMwareDvsHost(object):
self.dv_switch = find_dvs_by_name(self.content, self.switch_name) self.dv_switch = find_dvs_by_name(self.content, self.switch_name)
if self.dv_switch is None: if self.dv_switch is None:
raise Exception("A distributed virtual switch %s does not exist" % self.switch_name) self.module.fail_json(msg="A distributed virtual switch %s "
"does not exist" % self.switch_name)
self.uplink_portgroup = self.find_dvs_uplink_pg() self.uplink_portgroup = self.find_dvs_uplink_pg()
if self.uplink_portgroup is None: if self.uplink_portgroup is None:
raise Exception("An uplink portgroup does not exist on the distributed virtual switch %s" self.module.fail_json(msg="An uplink portgroup does not exist on"
% self.switch_name) " the distributed virtual switch %s" % self.switch_name)
self.host = self.find_host_attached_dvs() self.host = self.find_host_attached_dvs()
@ -221,7 +215,8 @@ class VMwareDvsHost(object):
# to the distributed vswitch # to the distributed vswitch
self.host = find_hostsystem_by_name(self.content, self.esxi_hostname) self.host = find_hostsystem_by_name(self.content, self.esxi_hostname)
if self.host is None: if self.host is None:
self.module.fail_json(msg="The esxi_hostname %s does not exist in vCenter" % self.esxi_hostname) self.module.fail_json(msg="The esxi_hostname %s does not exist "
"in vCenter" % self.esxi_hostname)
return 'absent' return 'absent'
else: else:
if self.check_uplinks(): if self.check_uplinks():
@ -231,17 +226,18 @@ class VMwareDvsHost(object):
def main(): def main():
argument_spec = vmware_argument_spec() argument_spec = vmware_argument_spec()
argument_spec.update(dict(esxi_hostname=dict(required=True, type='str'), argument_spec.update(dict(esxi_hostname=dict(required=True, type='str'),
switch_name=dict(required=True, type='str'), switch_name=dict(required=True, type='str'),
vmnics=dict(required=True, type='list'), vmnics=dict(required=True, type='list'),
state=dict(default='present', choices=['present', 'absent'], type='str'))) state=dict(default='present',
choices=['present', 'absent'],
type='str')
)
)
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True)
if not HAS_PYVMOMI:
module.fail_json(msg='pyvmomi is required for this module')
if not HAS_COLLECTIONS_COUNTER: if not HAS_COLLECTIONS_COUNTER:
module.fail_json(msg='collections.Counter from Python-2.7 is required for this module') module.fail_json(msg='collections.Counter from Python-2.7 is required for this module')