From 857d0fd62e47d0e146eeb9cbd542be4d70dc4e83 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Sun, 28 Jan 2018 21:34:45 +0530 Subject: [PATCH] VMware: add new module: vmware_host_vmnic_facts (#34984) Signed-off-by: Abhijeet Kasurde --- .../cloud/vmware/vmware_host_vmnic_facts.py | 144 ++++++++++++++++++ .../targets/vmware_host_vmnic_facts/aliases | 3 + .../vmware_host_vmnic_facts/tasks/main.yml | 66 ++++++++ 3 files changed, 213 insertions(+) create mode 100644 lib/ansible/modules/cloud/vmware/vmware_host_vmnic_facts.py create mode 100644 test/integration/targets/vmware_host_vmnic_facts/aliases create mode 100644 test/integration/targets/vmware_host_vmnic_facts/tasks/main.yml diff --git a/lib/ansible/modules/cloud/vmware/vmware_host_vmnic_facts.py b/lib/ansible/modules/cloud/vmware/vmware_host_vmnic_facts.py new file mode 100644 index 00000000000..d406c0bb875 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_host_vmnic_facts.py @@ -0,0 +1,144 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright: (c) 2018, Abhijeet Kasurde +# 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 +__metaclass__ = type + + +ANSIBLE_METADATA = { + 'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community' +} + +DOCUMENTATION = r''' +--- +module: vmware_host_vmnic_facts +short_description: Gathers facts about vmnics available on the given ESXi host +description: +- This module can be used to gather facts about vmnics available on the given ESXi host. +- If C(cluster_name) is provided, then vmnic facts about all hosts from given cluster will be returned. +- If C(esxi_hostname) is provided, then vmnic facts about given host system will be returned. +version_added: '2.5' +author: +- Abhijeet Kasurde (@akasurde) +notes: +- Tested on vSphere 6.5 +requirements: +- python >= 2.6 +- PyVmomi +options: + cluster_name: + description: + - Name of the cluster. + - Vmnic facts about each ESXi server will be returned for the given cluster. + - If C(esxi_hostname) is not given, this parameter is required. + esxi_hostname: + description: + - ESXi hostname. + - Vmnic facts about this ESXi server will be returned. + - If C(cluster_name) is not given, this parameter is required. +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = r''' +- name: Gather facts about vmnics of all ESXi Host in the given Cluster + vmware_host_vmnic_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + cluster_name: cluster_name + register: cluster_host_vmnics + +- name: Gather facts about vmnics of an ESXi Host + vmware_host_vmnic_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ esxi_hostname }}' + register: host_vmnics +''' + +RETURN = r''' +hosts_vmnics_facts: + description: + - dict with hostname as key and dict with vmnics facts as value + returned: hosts_vmnics_facts + type: dict + sample: { "hosts_vmnics_facts": { "localhost.localdomain": { "all": [ "vmnic0" ], "available": [], "used": [ "vmnic0" ] }}} +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi + + +class HostVmnicMgr(PyVmomi): + def __init__(self, module): + super(HostVmnicMgr, self).__init__(module) + cluster_name = self.params.get('cluster_name', None) + esxi_host_name = self.params.get('esxi_hostname', None) + self.hosts = [] + if cluster_name: + cluster_obj = self.find_cluster_by_name(cluster_name=cluster_name) + if cluster_obj: + self.hosts = [host for host in cluster_obj.host] + else: + module.fail_json(changed=False, msg="Cluster '%s' not found" % cluster_name) + elif esxi_host_name: + esxi_host_obj = self.find_hostsystem_by_name(host_name=esxi_host_name) + if esxi_host_obj: + self.hosts = [esxi_host_obj] + else: + module.fail_json(changed=False, msg="ESXi '%s' not found" % esxi_host_name) + + def gather_host_vmnic_facts(self): + hosts_vmnic_facts = {} + for host in self.hosts: + host_vmnic_facts = dict(all=[], available=[], used=[]) + host_nw_system = host.configManager.networkSystem + if host_nw_system: + nw_config = host_nw_system.networkConfig + host_vmnic_facts['all'] = [pnic.device for pnic in nw_config.pnic] + + vswitch_vmnics = [] + if nw_config.vswitch: + for vswitch in nw_config.vswitch: + for vnic in vswitch.spec.bridge.nicDevice: + vswitch_vmnics.append(vnic) + + proxy_switch_vmnics = [] + if nw_config.vswitch: + for proxy_config in nw_config.proxySwitch: + for proxy_nic in proxy_config.spec.bridge.nicDevice: + proxy_switch_vmnics.append(proxy_nic.pnicDevice) + + used_vmics = proxy_switch_vmnics + vswitch_vmnics + host_vmnic_facts['used'] = used_vmics + host_vmnic_facts['available'] = [pnic.device for pnic in nw_config.pnic if pnic.device not in used_vmics] + + hosts_vmnic_facts[host.name] = host_vmnic_facts + return hosts_vmnic_facts + + +def main(): + argument_spec = vmware_argument_spec() + argument_spec.update( + cluster_name=dict(type='str', required=False), + esxi_hostname=dict(type='str', required=False), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=[ + ['cluster_name', 'esxi_hostname'], + ] + ) + + host_vmnic_mgr = HostVmnicMgr(module) + module.exit_json(changed=False, hosts_vmnics_facts=host_vmnic_mgr.gather_host_vmnic_facts()) + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/vmware_host_vmnic_facts/aliases b/test/integration/targets/vmware_host_vmnic_facts/aliases new file mode 100644 index 00000000000..6ee4e3d4f9f --- /dev/null +++ b/test/integration/targets/vmware_host_vmnic_facts/aliases @@ -0,0 +1,3 @@ +posix/ci/cloud/group4/vcenter +cloud/vcenter + diff --git a/test/integration/targets/vmware_host_vmnic_facts/tasks/main.yml b/test/integration/targets/vmware_host_vmnic_facts/tasks/main.yml new file mode 100644 index 00000000000..b81f6329a1c --- /dev/null +++ b/test/integration/targets/vmware_host_vmnic_facts/tasks/main.yml @@ -0,0 +1,66 @@ +# Test code for the vmware_host_vmnic_facts module. +# Copyright: (c) 2018, Abhijeet Kasurde +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# TODO: vcsim does not support networkConfig related to operations +#- name: make sure pyvmomi is installed +# pip: +# name: pyvmomi +# state: latest +# when: "{{ ansible_user_id == 'root' }}" + +#- name: store the vcenter container ip +# set_fact: +# vcsim: "{{ lookup('env', 'vcenter_host') }}" + +#- debug: var=vcsim + +#- name: Wait for Flask controller to come up online +# wait_for: +# host: "{{ vcsim }}" +# port: 5000 +# state: started + +#- name: kill vcsim +# uri: +# url: http://{{ vcsim }}:5000/killall + +#- name: start vcsim +# uri: +# url: http://{{ vcsim }}:5000/spawn?cluster=2 +# register: vcsim_instance + +#- debug: +# var: vcsim_instance + +#- name: Wait for vcsim server to come up online +# wait_for: +# host: "{{ vcsim }}" +# port: 443 +# state: started + +#- name: get a list of hosts from vcsim +# uri: +# url: http://{{ vcsim }}:5000/govc_find?filter=H +# register: hosts + +#- name: get a host +# set_fact: +# host1: "{{ hosts.json[0] | basename }}" + +#- debug: var=host1 + +#- name: Gather facts about all hosts in given cluster +# vmware_host_vmnics_facts: +# hostname: "{{ vcsim }}" +# username: "{{ user }}" +# password: "{{ passwd }}" +# esxi_hostname: "{{ host1 }}" +# validate_certs: no +# register: host_vmnics + +#- debug: var=host_vmnics + +#- assert: +# that: +# - host_vmnics.host_service_facts is defined