VMware: new module: vmware_dvs_portgroup_facts (#45116)

* VMware: new module: vmware_dvs_portgroup_facts

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Review comments

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

3 files changed, 271 insertions, 0 deletions

diff --git a/lib/ansible/modules/cloud/vmware/vmware_dvs_portgroup_facts.py b/lib/ansible/modules/cloud/vmware/vmware_dvs_portgroup_facts.py
new file mode 100644
index 0000000000..d2531e1cd3
--- /dev/null
+++ b/lib/ansible/modules/cloud/vmware/vmware_dvs_portgroup_facts.py
@@ -0,0 +1,208 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# 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)
+
+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_dvs_portgroup_facts
+short_description: Gathers facts DVS portgroup configurations
+description:
+- This module can be used to gather facts about DVS portgroup configurations.
+version_added: 2.8
+author:
+- Abhijeet Kasurde (@Akasurde)
+notes:
+- Tested on vSphere 6.5
+requirements:
+- python >= 2.6
+- PyVmomi
+options:
+  datacenter:
+    description:
+    - Name of the datacenter.
+    required: true
+    type: str
+  show_network_policy:
+    description:
+    - Show or hide network policies of DVS portgroup.
+    type: bool
+    default: True
+  show_port_policy:
+    description:
+    - Show or hide port policies of DVS portgroup.
+    type: bool
+    default: True
+  show_teaming_policy:
+    description:
+    - Show or hide teaming policies of DVS portgroup.
+    type: bool
+    default: True
+extends_documentation_fragment: vmware.documentation
+'''
+
+EXAMPLES = r'''
+- name: Get facts about DVPG
+  vmware_dvs_portgroup_facts:
+    hostname: "{{ vcenter_server }}"
+    username: "{{ vcenter_user }}"
+    password: "{{ vcenter_pass }}"
+    validate_certs: no
+    datacenter: "{{ datacenter_name }}"
+  register: dvpg_facts
+
+- name: Get number of ports for portgroup 'dvpg_001' in 'dvs_001'
+  debug:
+    msg: "{{ item.num_ports }}"
+  with_items:
+    - "{{ dvpg_facts.dvs_portgroup_facts['dvs_001'] | json_query(query) }}"
+  vars:
+    query: "[?portgroup_name=='dvpg_001']"
+'''
+
+RETURN = r'''
+dvs_portgroup_facts:
+    description: metadata about DVS portgroup configuration
+    returned: on success
+    type: dict
+    sample: {
+        "dvs_0":[
+            {
+                "description": null,
+                "dvswitch_name": "dvs_001",
+                "network_policy": {
+                    "forged_transmits": false,
+                    "mac_changes": false,
+                    "promiscuous": false
+                },
+                "num_ports": 8,
+                "port_policy": {
+                    "block_override": true,
+                    "ipfix_override": false,
+                    "live_port_move": false,
+                    "network_rp_override": false,
+                    "port_config_reset_at_disconnect": true,
+                    "security_override": false,
+                    "shaping_override": false,
+                    "traffic_filter_override": false,
+                    "uplink_teaming_override": false,
+                    "vendor_config_override": false,
+                    "vlan_override": false
+                },
+                "portgroup_name": "dvpg_001",
+                "teaming_policy": {
+                    "inbound_policy": true,
+                    "notify_switches": true,
+                    "policy": "loadbalance_srcid",
+                    "rolling_order": false
+                },
+                "type": "earlyBinding"
+            },
+        ]
+    }
+'''
+
+try:
+    from pyVmomi import vim
+except ImportError as e:
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi, get_all_objs
+
+
+class DVSPortgroupFactsManager(PyVmomi):
+    def __init__(self, module):
+        super(DVSPortgroupFactsManager, self).__init__(module)
+        self.dc_name = self.params['datacenter']
+
+    def gather_dvs_portgroup_facts(self):
+        datacenter = self.find_datacenter_by_name(self.dc_name)
+        if datacenter is None:
+            self.module.fail_json(msg="Failed to find the datacenter %s" % self.dc_name)
+
+        dvs_lists = get_all_objs(self.content, [vim.DistributedVirtualSwitch], folder=datacenter.networkFolder)
+
+        result = dict()
+        for dvs in dvs_lists:
+            result[dvs.name] = list()
+            for dvs_pg in dvs.portgroup:
+                network_policy = dict()
+                teaming_policy = dict()
+                port_policy = dict()
+
+                if self.module.params['show_network_policy'] and dvs_pg.config.defaultPortConfig.securityPolicy:
+                    network_policy = dict(
+                        forged_transmits=dvs_pg.config.defaultPortConfig.securityPolicy.forgedTransmits.value,
+                        promiscuous=dvs_pg.config.defaultPortConfig.securityPolicy.allowPromiscuous.value,
+                        mac_changes=dvs_pg.config.defaultPortConfig.securityPolicy.macChanges.value
+                    )
+                if self.module.params['show_teaming_policy']:
+                    teaming_policy = dict(
+                        policy=dvs_pg.config.defaultPortConfig.uplinkTeamingPolicy.policy.value,
+                        inbound_policy=dvs_pg.config.defaultPortConfig.uplinkTeamingPolicy.reversePolicy.value,
+                        notify_switches=dvs_pg.config.defaultPortConfig.uplinkTeamingPolicy.notifySwitches.value,
+                        rolling_order=dvs_pg.config.defaultPortConfig.uplinkTeamingPolicy.rollingOrder.value,
+                    )
+
+                if self.params['show_port_policy']:
+                    port_policy = dict(
+                        block_override=dvs_pg.config.policy.blockOverrideAllowed,
+                        ipfix_override=dvs_pg.config.policy.ipfixOverrideAllowed,
+                        live_port_move=dvs_pg.config.policy.livePortMovingAllowed,
+                        network_rp_override=dvs_pg.config.policy.networkResourcePoolOverrideAllowed,
+                        port_config_reset_at_disconnect=dvs_pg.config.policy.portConfigResetAtDisconnect,
+                        security_override=dvs_pg.config.policy.securityPolicyOverrideAllowed,
+                        shaping_override=dvs_pg.config.policy.shapingOverrideAllowed,
+                        traffic_filter_override=dvs_pg.config.policy.trafficFilterOverrideAllowed,
+                        uplink_teaming_override=dvs_pg.config.policy.uplinkTeamingOverrideAllowed,
+                        vendor_config_override=dvs_pg.config.policy.vendorConfigOverrideAllowed,
+                        vlan_override=dvs_pg.config.policy.vlanOverrideAllowed
+                    )
+
+                dvpg_details = dict(
+                    portgroup_name=dvs_pg.name,
+                    num_ports=dvs_pg.config.numPorts,
+                    dvswitch_name=dvs_pg.config.distributedVirtualSwitch.name,
+                    description=dvs_pg.config.description,
+                    type=dvs_pg.config.type,
+                    teaming_policy=teaming_policy,
+                    port_policy=port_policy,
+                    network_policy=network_policy,
+                )
+                result[dvs.name].append(dvpg_details)
+
+        return result
+
+
+def main():
+    argument_spec = vmware_argument_spec()
+    argument_spec.update(
+        datacenter=dict(type='str', required=True),
+        show_network_policy=dict(type='bool', default=True),
+        show_teaming_policy=dict(type='bool', default=True),
+        show_port_policy=dict(type='bool', default=True),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
+
+    dvs_pg_mgr = DVSPortgroupFactsManager(module)
+    module.exit_json(changed=False,
+                     dvs_portgroup_facts=dvs_pg_mgr.gather_dvs_portgroup_facts())
+
+
+if __name__ == "__main__":
+    main()
diff --git a/test/integration/targets/vmware_dvs_portgroup_facts/aliases b/test/integration/targets/vmware_dvs_portgroup_facts/aliases
new file mode 100644
index 0000000000..845e8a6dad
--- /dev/null
+++ b/test/integration/targets/vmware_dvs_portgroup_facts/aliases
@@ -0,0 +1,2 @@
+cloud/vcenter
+unsupported
diff --git a/test/integration/targets/vmware_dvs_portgroup_facts/tasks/main.yml b/test/integration/targets/vmware_dvs_portgroup_facts/tasks/main.yml
new file mode 100644
index 0000000000..c2db996bb4
--- /dev/null
+++ b/test/integration/targets/vmware_dvs_portgroup_facts/tasks/main.yml
@@ -0,0 +1,61 @@
+# Test code for the vmware_dvs_portgroup_facts module.
+# 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)
+
+- 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
+
+- name: Wait for Flask controller to come up online
+  wait_for:
+    host: "{{ vcsim }}"
+    port: 443
+    state: started
+
+- debug: var=vcsim_instance
+
+- name: Gather facts about DVS portgroup
+  vmware_dvs_portgroup_facts:
+    validate_certs: False
+    hostname: "{{ vcsim }}"
+    username: "{{ vcsim_instance['json']['username'] }}"
+    password: "{{ vcsim_instance['json']['password'] }}"
+    datacenter: DC0
+  register: dvs_results
+
+- debug: var=dvs_results
+
+- assert:
+    that:
+      - "dvs_results.dvs_portgroup_facts is defined"
+
+- name: Gather facts about DVS portgroup in check mode
+  vmware_dvs_portgroup_facts:
+    validate_certs: False
+    hostname: "{{ vcsim }}"
+    username: "{{ vcsim_instance['json']['username'] }}"
+    password: "{{ vcsim_instance['json']['password'] }}"
+    datacenter: DC0
+  register: dvs_results
+  check_mode: yes
+
+- debug: var=dvs_results
+
+- assert:
+    that:
+      - "dvs_results.dvs_portgroup_facts is defined"