Resolves issue with vmware_dvs_portgroup module for v2.0

When this module was written back in May 2015 we were using 1.9.x. Being lazy I added to param the objects that the other functions would need. What I have noticed is in 2.0 exit_json is trying to jsonify those complex objects and failing. This PR resolves that issue with the vmware_dvs_portgroup module.

@kamsz reported this issue in https://github.com/ansible/ansible-modules-extras/pull/1568

Playbook
```
- name: Create Management portgroup
      local_action:
        module: vmware_dvs_portgroup
        hostname: "{{ mgmt_ip_address }}"
        username: "{{ vcsa_user }}"
        password: "{{ vcsa_pass }}"
        portgroup_name: Management
        switch_name: dvSwitch
        vlan_id: "{{ hostvars[groups['foundation_esxi'][0]].mgmt_vlan_id }}"
        num_ports: 120
        portgroup_type: earlyBinding
        state: present
```

Module Testing
```
TASK [Create Management portgroup] *********************************************
task path: /opt/autodeploy/projects/emmet/tasks/deploy/dvs_network.yml:17
ESTABLISH LOCAL CONNECTION FOR USER: root
localhost EXEC ( umask 22 && mkdir -p "$( echo $HOME/.ansible/tmp/ansible-tmp-1454693809.13-142252676354410 )" && echo "$( echo $HOME/.ansible/tmp/ansible-tmp-1454693809.13-142252676354410 )" )
localhost PUT /tmp/tmpeQ8M1U TO /root/.ansible/tmp/ansible-tmp-1454693809.13-142252676354410/vmware_dvs_portgroup
localhost EXEC LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8 /usr/bin/python /root/.ansible/tmp/ansible-tmp-1454693809.13-142252676354410/vmware_dvs_portgroup; rm -rf "/root/.ansible/tmp/ansible-tmp-1454693809.13-142252676354410/" > /dev/null 2>&1
changed: [foundation-vcsa -> localhost] => {"changed": true, "invocation": {"module_args": {"hostname": "172.27.0.100", "num_ports": 120, "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "portgroup_name": "Management", "portgroup_type": "earlyBinding", "state": "present", "switch_name": "dvSwitch", "username": "root", "vlan_id": 2700}, "module_name": "vmware_dvs_portgroup"}, "result": "None"}
```
reviewable/pr18780/r1
Joseph Callen 9 years ago
parent ff8806eaee
commit 56c1ce3df1

@ -81,91 +81,100 @@ except ImportError:
HAS_PYVMOMI = False HAS_PYVMOMI = False
def create_port_group(dv_switch, portgroup_name, vlan_id, num_ports, portgroup_type): class VMwareDvsPortgroup(object):
config = vim.dvs.DistributedVirtualPortgroup.ConfigSpec() def __init__(self, module):
self.module = module
config.name = portgroup_name self.dvs_portgroup = None
config.numPorts = num_ports self.switch_name = self.module.params['switch_name']
self.portgroup_name = self.module.params['portgroup_name']
# vim.VMwareDVSPortSetting() does not exist in the pyvmomi documentation self.vlan_id = self.module.params['vlan_id']
# but this is the correct managed object type. self.num_ports = self.module.params['num_ports']
self.portgroup_type = self.module.params['portgroup_type']
config.defaultPortConfig = vim.VMwareDVSPortSetting() self.dv_switch = None
self.state = self.module.params['state']
# vim.VmwareDistributedVirtualSwitchVlanIdSpec() does not exist in the self.content = connect_to_api(module)
# pyvmomi documentation but this is the correct managed object type
config.defaultPortConfig.vlan = vim.VmwareDistributedVirtualSwitchVlanIdSpec() def process_state(self):
config.defaultPortConfig.vlan.inherited = False try:
config.defaultPortConfig.vlan.vlanId = vlan_id dvspg_states = {
config.type = portgroup_type 'absent': {
'present': self.state_destroy_dvspg,
spec = [config] 'absent': self.state_exit_unchanged,
task = dv_switch.AddDVPortgroup_Task(spec) },
changed, result = wait_for_task(task) 'present': {
return changed, result 'update': self.state_update_dvspg,
'present': self.state_exit_unchanged,
'absent': self.state_create_dvspg,
def state_destroy_dvspg(module): }
dvs_portgroup = module.params['dvs_portgroup'] }
changed = True dvspg_states[self.state][self.check_dvspg_state()]()
result = None except vmodl.RuntimeFault as runtime_fault:
self.module.fail_json(msg=runtime_fault.msg)
if not module.check_mode: except vmodl.MethodFault as method_fault:
task = dvs_portgroup.Destroy_Task() self.module.fail_json(msg=method_fault.msg)
except Exception as e:
self.module.fail_json(msg=str(e))
def create_port_group(self):
config = vim.dvs.DistributedVirtualPortgroup.ConfigSpec()
config.name = self.portgroup_name
config.numPorts = self.num_ports
# vim.VMwareDVSPortSetting() does not exist in the pyvmomi documentation
# but this is the correct managed object type.
config.defaultPortConfig = vim.VMwareDVSPortSetting()
# vim.VmwareDistributedVirtualSwitchVlanIdSpec() does not exist in the
# pyvmomi documentation but this is the correct managed object type
config.defaultPortConfig.vlan = vim.VmwareDistributedVirtualSwitchVlanIdSpec()
config.defaultPortConfig.vlan.inherited = False
config.defaultPortConfig.vlan.vlanId = self.vlan_id
config.type = self.portgroup_type
spec = [config]
task = self.dv_switch.AddDVPortgroup_Task(spec)
changed, result = wait_for_task(task) changed, result = wait_for_task(task)
module.exit_json(changed=changed, result=str(result)) return changed, result
def state_destroy_dvspg(self):
changed = True
result = None
def state_exit_unchanged(module): if not self.module.check_mode:
module.exit_json(changed=False) task = dvs_portgroup.Destroy_Task()
changed, result = wait_for_task(task)
self.module.exit_json(changed=changed, result=str(result))
def state_exit_unchanged(self):
self.module.exit_json(changed=False)
def state_update_dvspg(module): def state_update_dvspg(self):
module.exit_json(changed=False, msg="Currently not implemented.") self.module.exit_json(changed=False, msg="Currently not implemented.")
return
def state_create_dvspg(self):
changed = True
result = None
def state_create_dvspg(module): if not self.module.check_mode:
changed, result = self.create_port_group()
self.module.exit_json(changed=changed, result=str(result))
switch_name = module.params['switch_name'] def check_dvspg_state(self):
portgroup_name = module.params['portgroup_name'] self.dv_switch = find_dvs_by_name(self.content, self.switch_name)
dv_switch = module.params['dv_switch']
vlan_id = module.params['vlan_id']
num_ports = module.params['num_ports']
portgroup_type = module.params['portgroup_type']
changed = True
result = None
if not module.check_mode: if self.dv_switch is None:
changed, result = create_port_group(dv_switch, portgroup_name, vlan_id, num_ports, portgroup_type) raise Exception("A distributed virtual switch with name %s does not exist" % self.switch_name)
module.exit_json(changed=changed, result=str(result)) self.dvs_portgroup = find_dvspg_by_name(self.dv_switch, self.portgroup_name)
if self.dvs_portgroup is None:
def check_dvspg_state(module): return 'absent'
else:
switch_name = module.params['switch_name'] return 'present'
portgroup_name = module.params['portgroup_name']
content = connect_to_api(module)
module.params['content'] = content
dv_switch = find_dvs_by_name(content, switch_name)
if dv_switch is None:
raise Exception("A distributed virtual switch with name %s does not exist" % switch_name)
module.params['dv_switch'] = dv_switch
dvs_portgroup = find_dvspg_by_name(dv_switch, portgroup_name)
if dvs_portgroup is None:
return 'absent'
else:
module.params['dvs_portgroup'] = dvs_portgroup
return 'present'
def main(): def main():
argument_spec = vmware_argument_spec() argument_spec = vmware_argument_spec()
argument_spec.update(dict(portgroup_name=dict(required=True, type='str'), argument_spec.update(dict(portgroup_name=dict(required=True, type='str'),
switch_name=dict(required=True, type='str'), switch_name=dict(required=True, type='str'),
@ -179,25 +188,8 @@ def main():
if not HAS_PYVMOMI: if not HAS_PYVMOMI:
module.fail_json(msg='pyvmomi is required for this module') module.fail_json(msg='pyvmomi is required for this module')
try: vmware_dvs_portgroup = VMwareDvsPortgroup(module)
dvspg_states = { vmware_dvs_portgroup.process_state()
'absent': {
'present': state_destroy_dvspg,
'absent': state_exit_unchanged,
},
'present': {
'update': state_update_dvspg,
'present': state_exit_unchanged,
'absent': state_create_dvspg,
}
}
dvspg_states[module.params['state']][check_dvspg_state(module)](module)
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)
except Exception as e:
module.fail_json(msg=str(e))
from ansible.module_utils.vmware import * from ansible.module_utils.vmware import *
from ansible.module_utils.basic import * from ansible.module_utils.basic import *

Loading…
Cancel
Save