diff --git a/lib/ansible/modules/cloud/vmware/vmware_vswitch_facts.py b/lib/ansible/modules/cloud/vmware/vmware_vswitch_facts.py new file mode 100644 index 00000000000..301732e49d7 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_vswitch_facts.py @@ -0,0 +1,138 @@ +#!/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_vswitch_facts +short_description: Gathers facts about an ESXi host's vswitch configurations +description: +- This module can be used to gather facts about an ESXi host's vswitch configurations when ESXi hostname or Cluster name is given. +version_added: '2.6' +author: +- Abhijeet Kasurde (@akasurde) +notes: +- Tested on vSphere 6.5 +requirements: +- python >= 2.6 +- PyVmomi +options: + cluster_name: + description: + - Name of the cluster. + - Facts about vswitch belonging to every ESXi host systems under this cluster will be returned. + - If C(esxi_hostname) is not given, this parameter is required. + esxi_hostname: + description: + - ESXi hostname to gather facts from. + - If C(cluster_name) is not given, this parameter is required. +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = r''' +- name: Gather vswitch facts about all ESXi Host in given Cluster + vmware_vswitch_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + cluster_name: cluster_name + register: all_hosts_vswitch_facts + +- name: Gather firewall facts about ESXi Host + vmware_vswitch_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ esxi_hostname }}' + register: all_vswitch_facts +''' + +RETURN = r''' +hosts_vswitch_facts: + description: metadata about host's vswitch configuration + returned: on success + type: dict + sample: { + "10.76.33.218": { + "vSwitch0": { + "mtu": 1500, + "num_ports": 1536, + "pnics": [ + "vmnic0" + ] + }, + "vSwitch_0011": { + "mtu": 1500, + "num_ports": 1536, + "pnics": [ + "vmnic2", + "vmnic1" + ] + }, + }, + } +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi + + +class VswitchFactsManager(PyVmomi): + def __init__(self, module): + super(VswitchFactsManager, self).__init__(module) + cluster_name = self.params.get('cluster_name', None) + esxi_host_name = self.params.get('esxi_hostname', None) + self.hosts = self.get_all_host_objs(cluster_name=cluster_name, esxi_host_name=esxi_host_name) + + @staticmethod + def serialize_pnics(vswitch_obj): + pnics = [] + for pnic in vswitch_obj.pnic: + # vSwitch contains all PNICs as string in format of 'key-vim.host.PhysicalNic-vmnic0' + pnics.append(pnic.split("-", 3)[-1]) + return pnics + + def gather_vswitch_facts(self): + hosts_vswitch_facts = dict() + for host in self.hosts: + network_manager = host.configManager.networkSystem + if network_manager: + temp_switch_dict = dict() + for available_vswitch in network_manager.networkInfo.vswitch: + temp_switch_dict[available_vswitch.name] = dict(pnics=self.serialize_pnics(available_vswitch), + mtu=available_vswitch.mtu, + num_ports=available_vswitch.numPorts) + hosts_vswitch_facts[host.name] = temp_switch_dict + return hosts_vswitch_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'], + ] + ) + + vmware_vswitch_mgr = VswitchFactsManager(module) + module.exit_json(changed=False, hosts_vswitch_facts=vmware_vswitch_mgr.gather_vswitch_facts()) + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/vmware_vswitch_facts/aliases b/test/integration/targets/vmware_vswitch_facts/aliases new file mode 100644 index 00000000000..6ee4e3d4f9f --- /dev/null +++ b/test/integration/targets/vmware_vswitch_facts/aliases @@ -0,0 +1,3 @@ +posix/ci/cloud/group4/vcenter +cloud/vcenter + diff --git a/test/integration/targets/vmware_vswitch_facts/tasks/main.yml b/test/integration/targets/vmware_vswitch_facts/tasks/main.yml new file mode 100644 index 00000000000..cef97afdf41 --- /dev/null +++ b/test/integration/targets/vmware_vswitch_facts/tasks/main.yml @@ -0,0 +1,66 @@ +# Test code for the vmware_vswitch_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 vswitch facts about all hosts in given cluster +# vmware_vswitch_facts: +# hostname: "{{ vcsim }}" +# username: "{{ user }}" +# password: "{{ passwd }}" +# esxi_hostname: "{{ host1 }}" +# validate_certs: no +# register: switch_facts + +#- debug: var=switch_facts + +#- assert: +# that: +# - switch_facts.hosts_vswitch_facts is defined