migrate cluster info module from community

changelogs/fragments/80-migrate-cluster-info-module.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - cluster_info - Migrate cluster_info module from the community.vmware collection to here

meta/runtime.yml

@@ -7,6 +7,7 @@ action_groups:
         - cluster_dpm
         - cluster_drs
         - cluster_drs_recommendations
+        - cluster_info
         - cluster_vcls
         - content_template
         - folder_template_from_vm

plugins/module_utils/_vmware_facts.py

@@ -15,14 +15,14 @@
 
 PYVMOMI_IMP_ERR = None
 try:
-    from pyVmomi import vim, VmomiSupport
+    from pyVmomi import vim, VmomiSupport, vmodl
 except ImportError:
     pass
 
 from ansible.module_utils._text import to_text
 from ansible.module_utils.six import integer_types, string_types, iteritems
 import ansible.module_utils.common._collections_compat as collections_compat
-from ansible_collections.vmware.vmware.plugins.module_utils._vmware_folder_paths import get_folder_path_of_vm
+from ansible_collections.vmware.vmware.plugins.module_utils._vmware_folder_paths import get_folder_path_of_vsphere_object
 
 
 class VmFacts():
@@ -167,7 +167,7 @@
 
     def hw_folder_facts(self):
         try:
-            hw_folder = get_folder_path_of_vm(self.vm)
+            hw_folder = get_folder_path_of_vsphere_object(self.vm)
         except Exception:
             hw_folder = None
 
@@ -281,6 +281,135 @@
         }
 
 
+class ClusterFacts():
+    DPM_DEFAULT_RATE = 3
+    DRS_DEFAULT_RATE = 3
+
+    def __init__(self, cluster):
+        self.cluster = cluster
+
+    @staticmethod
+    def reverse_drs_or_dpm_rate(input_rate):
+        return 6 - int(input_rate)
+
+    def all_facts(self):
+        return {
+            **self.host_facts(),
+            **self.ha_facts(),
+            **self.identifier_facts(),
+            **self.drs_facts(),
+            **self.vsan_facts(),
+            **self.resource_usage_facts(),
+            **self.dpm_facts()
+        }
+
+    def identifier_facts(self):
+        return {
+            "moid": self.cluster._moId,
+            "datacenter": self.cluster.parent.parent.name
+        }
+
+    def host_facts(self):
+        hosts = []
+        for host in self.cluster.host:
+            hosts.append({
+                'name': host.name,
+                'folder': get_folder_path_of_vsphere_object(host),
+            })
+        return {"hosts": hosts}
+
+    def ha_facts(self):
+        fact_keys = [
+            "ha_enabled", "ha_failover_level", "ha_vm_monitoring", "ha_admission_control_enabled",
+            "ha_restart_priority", "ha_vm_tools_monitoring", "ha_vm_min_up_time", "ha_vm_max_failures",
+            "ha_vm_max_failure_window", "ha_vm_failure_interval"
+        ]
+        ha_facts = dict.fromkeys(fact_keys, None)
+        das_config = self.cluster.configurationEx.dasConfig
+        if not das_config:
+            ha_facts['ha_enabled'] = False
+            return ha_facts
+
+        ha_facts["ha_enabled"] = das_config.enabled
+        ha_facts["ha_vm_monitoring"] = das_config.vmMonitoring
+        ha_facts["ha_host_monitoring"] = das_config.hostMonitoring
+        ha_facts["ha_admission_control_enabled"] = das_config.admissionControlEnabled
+
+        if getattr(das_config, "admissionControlPolicy"):
+            ha_facts['ha_failover_level'] = das_config.admissionControlPolicy.failoverLevel
+        if getattr(das_config, "defaultVmSettings"):
+            ha_facts['ha_restart_priority'] = das_config.defaultVmSettings.restartPriority
+            ha_facts['ha_vm_tools_monitoring'] = das_config.defaultVmSettings.vmToolsMonitoringSettings.vmMonitoring
+            ha_facts['ha_vm_min_up_time'] = das_config.defaultVmSettings.vmToolsMonitoringSettings.minUpTime
+            ha_facts['ha_vm_max_failures'] = das_config.defaultVmSettings.vmToolsMonitoringSettings.maxFailures
+            ha_facts['ha_vm_max_failure_window'] = das_config.defaultVmSettings.vmToolsMonitoringSettings.maxFailureWindow
+            ha_facts['ha_vm_failure_interval'] = das_config.defaultVmSettings.vmToolsMonitoringSettings.failureInterval
+
+        return ha_facts
+
+    def dpm_facts(self):
+        fact_keys = ["dpm_enabled", "dpm_default_dpm_behavior", "dpm_host_power_action_rate"]
+        output_facts = dict.fromkeys(fact_keys, None)
+        dpm_config = self.cluster.configurationEx.dpmConfigInfo
+        if not dpm_config:
+            output_facts["dpm_enabled"] = False
+            return output_facts
+
+        output_facts["dpm_enabled"] = dpm_config.enabled
+        output_facts["dpm_default_dpm_behavior"] = getattr(dpm_config, "defaultDpmBehavior", None)
+        # dpm host power rate is reversed by the vsphere API. so a 1 in the API is really a 5 in the UI
+        try:
+            output_facts["dpm_host_power_action_rate"] = ClusterFacts.reverse_drs_or_dpm_rate(dpm_config.hostPowerActionRate)
+        except (TypeError, AttributeError):
+            output_facts["dpm_host_power_action_rate"] = ClusterFacts.DPM_DEFAULT_RATE
+
+        return output_facts
+
+    def drs_facts(self):
+        fact_keys = ["drs_enabled", "drs_enable_vm_behavior_overrides", "drs_default_vm_behavior", "drs_vmotion_rate"]
+        output_facts = dict.fromkeys(fact_keys, None)
+        drs_config = self.cluster.configurationEx.drsConfig
+        if not drs_config:
+            output_facts["drs_enabled"] = False
+            return output_facts
+
+        output_facts["drs_enabled"] = drs_config.enabled
+        output_facts["drs_enable_vm_behavior_overrides"] = getattr(drs_config, "enableVmBehaviorOverrides", None)
+
+        # docs call one option 'automatic' but the API calls it 'automated'. So we adjust here to match docs
+        _drs_default_vm_behavior = getattr(drs_config, "defaultVmBehavior", None)
+        output_facts["drs_default_vm_behavior"] = 'automatic' if _drs_default_vm_behavior == 'automated' else _drs_default_vm_behavior
+
+        # drs vmotion rate is reversed by the vsphere API. so a 1 in the API is really a 5 in the UI
+        try:
+            output_facts["drs_vmotion_rate"] = ClusterFacts.reverse_drs_or_dpm_rate(drs_config.vmotionRate)
+        except (TypeError, AttributeError):
+            output_facts["drs_vmotion_rate"] = ClusterFacts.DRS_DEFAULT_RATE
+
+        return output_facts
+
+    def vsan_facts(self):
+        vsan_config = getattr(self.cluster.configurationEx, 'vsanConfigInfo', None)
+        vsan_facts = {
+            "vsan_enabled": False,
+            "vsan_auto_claim_storage": None
+        }
+        if vsan_config:
+            vsan_facts['vsan_enabled'] = vsan_config.enabled
+            vsan_facts['vsan_auto_claim_storage'] = vsan_config.defaultConfig.autoClaimStorage
+        return vsan_facts
+
+    def resource_usage_facts(self):
+        try:
+            resource_summary = vmware_obj_to_json(self.cluster.GetResourceUsage())
+        except vmodl.fault.MethodNotFound:
+            return {'resource_summary': {}}
+
+        if '_vimtype' in resource_summary:
+            del resource_summary['_vimtype']
+        return {'resource_summary': resource_summary}
+
+
 def get_vm_prop_or_none(vm, attributes):
     """Safely get a property or return None"""
     result = vm

plugins/module_utils/_vmware_folder_paths.py

@@ -72,17 +72,16 @@
     return __prepend_datacenter_and_folder_type(folder_path, datacenter_name, folder_type='datastore')
 
 
-def get_folder_path_of_vm(vm):
+def get_folder_path_of_vsphere_object(vsphere_obj):
     """
-    Find the path of virtual machine.
+    Find the path of an object in vsphere.
     Args:
-        content: VMware content object
-        vm_name: virtual machine managed object
+        vsphere_obj: VMware content object
 
-    Returns: Folder of virtual machine if exists, else None
+    Returns: Folder of object if exists, else None
 
     """
-    _folder = vm.parent
+    _folder = vsphere_obj.parent
     folder_path = [_folder.name]
     while getattr(_folder, 'parent', None) is not None:
         _folder = _folder.parent

plugins/module_utils/_vmware_rest_client.py

@@ -432,14 +432,26 @@
         """
         Get a list of tag objects attached to a virtual machine
         Args:
-            vm_mid: the VM MOID to use to gather tags
+            vm_moid: the VM MOID to use to gather tags
 
         Returns:
             List of tag object associated with the given virtual machine
         """
         dobj = DynamicID(type='VirtualMachine', id=vm_moid)
         return self.get_tags_for_dynamic_id_obj(dobj=dobj)
 
+    def get_tags_by_cluster_moid(self, cluster_moid):
+        """
+        Get a list of tag objects attached to a cluster
+        Args:
+            cluster_moid: the cluster MOID to use to gather tags
+
+        Returns:
+            List of tag object associated with the given cluster
+        """
+        dobj = DynamicID(type='ClusterComputeResource', id=cluster_moid)
+        return self.get_tags_for_dynamic_id_obj(dobj=dobj)
+
     def format_tag_identity_as_dict(self, tag_obj):
         """
         Takes a tag object and outputs a dictionary with identifying details about the tag,

plugins/modules/cluster_dpm.py

@@ -117,6 +117,9 @@
     TaskError,
     RunningTaskMonitor
 )
+from ansible_collections.vmware.vmware.plugins.module_utils._vmware_facts import (
+    ClusterFacts
+)
 
 from ansible.module_utils._text import to_native
 
@@ -148,7 +151,7 @@
         We present the scale seen in the docs/UI to the user and then adjust the value here to ensure
         vCenter behaves as intended.
         """
-        return 6 - self.params['recommendation_priority_threshold']
+        return ClusterFacts.reverse_drs_or_dpm_rate(self.params['recommendation_priority_threshold'])
 
     def check_dpm_config_diff(self):
         """
@@ -214,7 +217,7 @@
                     choices=['automatic', 'manual'],
                     default='automatic'
                 ),
-                recommendation_priority_threshold=dict(type='int', choices=[1, 2, 3, 4, 5], default=3)
+                recommendation_priority_threshold=dict(type='int', choices=[1, 2, 3, 4, 5], default=ClusterFacts.DPM_DEFAULT_RATE)
             )
         },
         supports_check_mode=True,

plugins/modules/cluster_drs.py

@@ -143,7 +143,9 @@
     TaskError,
     RunningTaskMonitor
 )
-
+from ansible_collections.vmware.vmware.plugins.module_utils._vmware_facts import (
+    ClusterFacts
+)
 from ansible_collections.vmware.vmware.plugins.module_utils._vmware_type_utils import (
     diff_dict_and_vmodl_options_set
 )
@@ -175,7 +177,7 @@
         We present the scale seen in the docs/UI to the user and then adjust the value here to ensure
         vCenter behaves as intended.
         """
-        return 6 - self.params.get('drs_vmotion_rate')
+        return ClusterFacts.reverse_drs_or_dpm_rate(self.params.get('drs_vmotion_rate'))
 
     def check_drs_config_diff(self):
         """
@@ -254,7 +256,7 @@
                     choices=['fullyAutomated', 'manual', 'partiallyAutomated'],
                     default='fullyAutomated'
                 ),
-                drs_vmotion_rate=dict(type='int', choices=[1, 2, 3, 4, 5], default=3),
+                drs_vmotion_rate=dict(type='int', choices=[1, 2, 3, 4, 5], default=ClusterFacts.DRS_DEFAULT_RATE),
                 advanced_settings=dict(type='dict', required=False, default=dict()),
                 predictive_drs=dict(type='bool', required=False, default=False),
             )