VMware: Refactor vmware_portgroup (#33703)

Fix adds following:
* Documentation update
* Idempotency
* Remove Portgroup functionality

Fixes: #33666

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

lib/ansible/modules/cloud/vmware/vmware_portgroup.py

@@ -69,6 +69,13 @@ options:
             - List of name of host or hosts on which portgroup needs to be added.
             - This option is required if cluster_name is not specified.
         version_added: "2.5"
+    state:
+        description:
+            - Determines if the portgroup should be present or not.
+        choices:
+            - 'present'
+            - 'absent'
+        version_added: '2.5'
 extends_documentation_fragment: vmware.documentation
 '''
 
@@ -112,6 +119,16 @@ EXAMPLES = r'''
     portgroup_name: portgroup_name
     vlan_id: vlan_id
 
+- name: Remove Management Network VM Portgroup to all hosts in a cluster
+  vmware_portgroup:
+    hostname: vCenter_hostname
+    username: esxi_username
+    password: esxi_password
+    cluster_name: rh_engineering
+    switch_name: vswitch_name
+    portgroup_name: portgroup_name
+    vlan_id: vlan_id
+    state: absent
 '''
 
 try:
@@ -137,26 +154,153 @@ class PyVmomiHelper(PyVmomi):
         self.mac_changes = self.params['network_policy'].get('mac_changes')
         self.network_policy = self.create_network_policy()
         self.changed = False
+        self.state = self.params['state']
 
+    def process_state(self):
+        """
+        Function to manage state
+        """
+        if self.state == 'present':
+            self.add_portgroup()
+        elif self.state == 'absent':
+            self.remove_portgroup()
+
+    # Get
+    def get_all_port_groups_by_host(self, host_system):
+        """
+        Function to get all Port Group by host
+        Args:
+            host_system: Name of Host System
+
+        Returns: List of Port Group Spec
+        """
+        pgs_list = []
+        for pg in host_system.config.network.portgroup:
+            pgs_list.append(pg)
+        return pgs_list
+
+    def get_port_group_by_name(self, host_system, portgroup_name, vswitch_name):
+        """
+        Function to get specific port group by given name
+        Args:
+            host_system: Name of Host System
+            portgroup_name: Name of Port Group
+            vswitch_name: Name of vSwitch
+
+        Returns: List of port groups by given specifications
+
+        """
+        pgs_list = self.get_all_port_groups_by_host(host_system=host_system)
+        desired_pgs = []
+        for pg in pgs_list:
+            if pg.spec.name == portgroup_name and pg.spec.vswitchName == vswitch_name:
+                desired_pgs.append(pg)
+        return desired_pgs
+
+    def check_network_policy_diff(self, current_policy, desired_policy):
+        """
+        Function to find difference between existing network policy and user given network policy
+        Args:
+            current_policy: Current network policy
+            desired_policy: User defined network policy
+
+        Returns:
+
+        """
+        ret = False
+        if current_policy.security.allowPromiscuous != desired_policy.security.allowPromiscuous:
+            ret = True
+        if current_policy.security.forgedTransmits != desired_policy.security.forgedTransmits:
+            ret = True
+        if current_policy.security.macChanges != desired_policy.security.macChanges:
+            ret = True
+        return ret
+
+    # Add
     def add_hosts_port_group(self, hosts):
+        """
+        Function to add port group to given hosts
+        Args:
+            hosts: List of Host System
+        """
         for host in hosts:
-            self.changed = self.create_port_group(host, self.portgroup_name, self.vlan_id,
+            self.create_host_port_group(host, self.portgroup_name, self.vlan_id, self.switch_name, self.network_policy)
-                                                  self.switch_name, self.network_policy)
 
-    def create_port_group(self, host_system, portgroup_name, vlan_id, vswitch_name, network_policy):
+    def create_host_port_group(self, host_system, portgroup_name, vlan_id, vswitch_name, network_policy):
-        config = vim.host.NetworkConfig()
+        """
-        config.portgroup = [vim.host.PortGroup.Config()]
+        Function to create/update portgroup on given host using portgroup specifications
-        config.portgroup[0].changeOperation = "add"
+        Args:
-        config.portgroup[0].spec = vim.host.PortGroup.Specification()
+            host_system: Name of Host System
-        config.portgroup[0].spec.name = portgroup_name
+            portgroup_name: Name of Portgroup
-        config.portgroup[0].spec.vlanId = vlan_id
+            vlan_id: The VLAN ID for ports using this port group.
-        config.portgroup[0].spec.vswitchName = vswitch_name
+            vswitch_name: Name of vSwitch Name
-        config.portgroup[0].spec.policy = network_policy
+            network_policy: Network policy object
+        """
+        desired_pgs = self.get_port_group_by_name(host_system=host_system,
+                                                  portgroup_name=portgroup_name,
+                                                  vswitch_name=vswitch_name)
 
-        host_system.configManager.networkSystem.UpdateNetworkConfig(config, "modify")
+        port_group = vim.host.PortGroup.Config()
-        return True
+        port_group.spec = vim.host.PortGroup.Specification()
+
+        if not desired_pgs:
+            # Add new portgroup
+            port_group.spec.name = portgroup_name
+            port_group.spec.vlanId = vlan_id
+            port_group.spec.vswitchName = vswitch_name
+            port_group.spec.policy = network_policy
+
+            try:
+                host_system.configManager.networkSystem.AddPortGroup(portgrp=port_group.spec)
+                self.changed = True
+            except vim.fault.AlreadyExists as e:
+                self.module.fail_json(msg="Failed to add Portgroup as it already exists: %s" % e.msg)
+            except vim.fault.NotFound as e:
+                self.module.fail_json(msg="Failed to add Portgroup as vSwitch was not found: %s" % e.msg)
+            except vim.fault.HostConfigFault as e:
+                self.module.fail_json(msg="Failed to add Portgroup due to host system configuration failure : %s" % e.msg)
+            except vmodl.fault.InvalidArgument as e:
+                self.module.fail_json(msg="Failed to add Portgroup as VLAN id was not correct as per specifications: %s" % e.msg)
+        else:
+            # Change portgroup
+            if desired_pgs[0].spec.vlanId != vlan_id:
+                port_group.spec.vlanId = vlan_id
+                self.changed = True
+            if self.check_network_policy_diff(desired_pgs[0].spec.policy, network_policy):
+                port_group.spec.policy = network_policy
+                self.changed = True
+
+            if self.changed:
+                try:
+                    host_system.configManager.networkSystem.UpdatePortGroup(pgName=self.portgroup_name, portgrp=port_group.spec)
+                except vim.fault.AlreadyExists as e:
+                    self.module.fail_json(msg="Failed to update Portgroup as it conflicts with already existing Portgroup: %s" % e.msg)
+                except vim.fault.NotFound as e:
+                    self.module.fail_json(msg="Failed to update Portgroup as vSwitch was not found: %s" % e.msg)
+                except vim.fault.HostConfigFault as e:
+                    self.module.fail_json(msg="Failed to update Portgroup due to host system configuration failure : %s" % e.msg)
+                except vmodl.fault.InvalidArgument as e:
+                    self.module.fail_json(msg="Failed to update Portgroup as VLAN id was not correct as per specifications: %s" % e.msg)
+            self.changed = False
+
+    def add_portgroup(self):
+        """
+        Function to add portgroup to given cluster or given hostsystem
+        """
+        if self.cluster and self.find_cluster_by_name(cluster_name=self.cluster):
+            hosts = self.get_all_hosts_by_cluster(cluster_name=self.cluster)
+            self.add_hosts_port_group(hosts=hosts)
+        elif self.hosts:
+            for host in self.hosts:
+                host_system = self.find_hostsystem_by_name(host_name=host)
+                if host_system:
+                    self.add_hosts_port_group([host_system])
 
     def create_network_policy(self):
+        """
+        Function to create Network policy
+        Returns: Network policy object
+        """
         security_policy = vim.host.NetworkPolicy.SecurityPolicy()
         if self.promiscuous_mode:
             security_policy.allowPromiscuous = self.promiscuous_mode
@@ -167,15 +311,51 @@ class PyVmomiHelper(PyVmomi):
         network_policy = vim.host.NetworkPolicy(security=security_policy)
         return network_policy
 
-    def add_portgroup(self):
+    # Remove
+    def remove_portgroup(self):
+        """
+        Function to remove portgroup depending upon hostsystem and vswitch name
+        """
         if self.cluster and self.find_cluster_by_name(cluster_name=self.cluster):
             hosts = self.get_all_hosts_by_cluster(cluster_name=self.cluster)
-            self.add_hosts_port_group(hosts=hosts)
+            self.remove_hosts_port_group(hosts=hosts)
         elif self.hosts:
             for host in self.hosts:
                 host_system = self.find_hostsystem_by_name(host_name=host)
                 if host_system:
-                    self.add_hosts_port_group([host_system])
+                    self.remove_hosts_port_group(hosts=[host_system])
+
+    def remove_hosts_port_group(self, hosts):
+        """
+        Function to remove port group from given host
+        Args:
+            hosts: List of host system
+        """
+        for host in hosts:
+            self.remove_host_port_group(host_system=host, portgroup_name=self.portgroup_name, vswitch_name=self.switch_name)
+
+    def remove_host_port_group(self, host_system, portgroup_name, vswitch_name):
+        """
+        Function to remove port group depending upon host system, port group name and vswitch name
+        Args:
+            host_system: Name of Host System
+            portgroup_name: Name of Portgroup
+            vswitch_name: Name of vSwitch
+
+        """
+        desired_pgs = self.get_port_group_by_name(host_system=host_system, portgroup_name=portgroup_name, vswitch_name=vswitch_name)
+        if desired_pgs:
+            try:
+                host_system.configManager.networkSystem.RemovePortGroup(pgName=self.portgroup_name)
+                self.changed = True
+            except vim.fault.NotFound as e:
+                self.module.fail_json(msg="Failed to remove Portgroup as it was not found: %s" % e.msg)
+            except vim.fault.ResourceInUse as e:
+                self.module.fail_json(msg="Failed to remove Portgroup as it is in use: %s" % e.msg)
+            except vim.fault.HostConfigFault as e:
+                self.module.fail_json(msg="Failed to remove Portgroup due to configuration failures: %s" % e.msg)
+        else:
+            self.changed = False
 
 
 def main():
@@ -186,6 +366,7 @@ def main():
         vlan_id=dict(required=True, type='int'),
         hosts=dict(type='list'),
         cluster_name=dict(type='str'),
+        state=dict(type='str', choices=['present', 'absent'], default='present'),
         network_policy=dict(type='dict',
                             options=dict(
                                 promiscuous_mode=dict(type='bool'),
@@ -197,7 +378,7 @@ def main():
                                 forged_transmits=False,
                                 mac_changes=False,
                             )
-                            )
+                            ),
     )
     )
 
@@ -210,7 +391,9 @@ def main():
 
     try:
         pyv = PyVmomiHelper(module)
-        pyv.add_portgroup()
+
+        pyv.process_state()
+
         changed = pyv.changed
 
         module.exit_json(changed=changed)