Merge pull request #867 from mtnbikenc/add_vmware_vmkernel_ip_config_module

Looks good -- can extend if more customization of virtualnic spec is needed --   New VMware Module to support configuring a VMware vmkernel IP Address

cloud/vmware/vmware_vmkernel_ip_config.py

@@ -0,0 +1,136 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2015, Joseph Callen <jcallen () csc.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_vmkernel_ip_config
+short_description: Configure the VMkernel IP Address
+description:
+    - Configure the VMkernel IP Address
+version_added: 2.0
+author: "Joseph Callen (@jcpowermac), Russell Teague (@mtnbikenc)"
+notes:
+    - Tested on vSphere 5.5
+requirements:
+    - "python >= 2.6"
+    - PyVmomi
+options:
+    hostname:
+        description:
+            - The hostname or IP address of the ESXi server
+        required: True
+    username:
+        description:
+            - The username of the ESXi server
+        required: True
+        aliases: ['user', 'admin']
+    password:
+        description:
+            - The password of the ESXi server
+        required: True
+        aliases: ['pass', 'pwd']
+    vmk_name:
+        description:
+            - VMkernel interface name
+        required: True
+    ip_address:
+        description:
+            - IP address to assign to VMkernel interface
+        required: True
+    subnet_mask:
+        description:
+            - Subnet Mask to assign to VMkernel interface
+        required: True
+'''
+
+EXAMPLES = '''
+# Example command from Ansible Playbook
+
+- name: Configure IP address on ESX host
+  local_action:
+    module: vmware_vmkernel_ip_config
+    hostname: esxi_hostname
+    username: esxi_username
+    password: esxi_password
+    vmk_name: vmk0
+    ip_address: 10.0.0.10
+    subnet_mask: 255.255.255.0
+'''
+
+try:
+    from pyVmomi import vim, vmodl
+    HAS_PYVMOMI = True
+except ImportError:
+    HAS_PYVMOMI = False
+
+
+def configure_vmkernel_ip_address(host_system, vmk_name, ip_address, subnet_mask):
+
+    host_config_manager = host_system.configManager
+    host_network_system = host_config_manager.networkSystem
+
+    for vnic in host_network_system.networkConfig.vnic:
+        if vnic.device == vmk_name:
+            spec = vnic.spec
+            if spec.ip.ipAddress != ip_address:
+                spec.ip.dhcp = False
+                spec.ip.ipAddress = ip_address
+                spec.ip.subnetMask = subnet_mask
+                host_network_system.UpdateVirtualNic(vmk_name, spec)
+                return True
+    return False
+
+
+def main():
+
+    argument_spec = vmware_argument_spec()
+    argument_spec.update(dict(vmk_name=dict(required=True, type='str'),
+                         ip_address=dict(required=True, type='str'),
+                         subnet_mask=dict(required=True, 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')
+
+    vmk_name = module.params['vmk_name']
+    ip_address = module.params['ip_address']
+    subnet_mask = module.params['subnet_mask']
+
+    try:
+        content = connect_to_api(module, False)
+        host = get_all_objs(content, [vim.HostSystem])
+        if not host:
+            module.fail_json(msg="Unable to locate Physical Host.")
+        host_system = host.keys()[0]
+        changed = configure_vmkernel_ip_address(host_system, vmk_name, ip_address, subnet_mask)
+        module.exit_json(changed=changed)
+    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.basic import *
+
+if __name__ == '__main__':
+    main()