VMware: vCenter Cluster EVC Mode : new module (#56089)

* add vmware_evc_mode module

* alter result message for absent/absent

* Apply suggestions from code review

Co-Authored-By: CastawayEGR <36353334+CastawayEGR@users.noreply.github.com>

* add idempotency test

* change result dict to evc_mode_msg

* refactor to use pyvmomi class

* fix update to only process task on update

* minimize update code

* add single quotes around vars to match other code

* pass datacenter to cluster find

* add check_mode to disable test

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

@@ -0,0 +1,232 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2019, Michael Tipton <mike () ibeta.org>
+# 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 = '''
+---
+module: vmware_evc_mode
+short_description: Enable/Disable EVC mode on vCenter
+description:
+    - This module can be used to enable/disable EVC mode on vCenter.
+version_added: 2.9
+author:
+    - Michael Tipton (@castawayegr)
+notes:
+    - Tested on vSphere 6.7
+requirements:
+    - "python >= 2.6"
+    - PyVmomi
+options:
+  datacenter_name:
+    description:
+    - The name of the datacenter the cluster belongs to that you want to enable or disable EVC mode on.
+    required: True
+    type: str
+  cluster_name:
+    description:
+    - The name of the cluster to enable or disable EVC mode on.
+    required: True
+    type: str
+  evc_mode:
+    description:
+    - Required for C(state=present).
+    - The EVC mode to enable or disable on the cluster. (intel-broadwell, intel-nehalem, intel-merom, etc.).
+    required: True
+    type: str
+  state:
+    description:
+    - Add or remove EVC mode.
+    choices: [absent, present]
+    default: present
+    type: str
+extends_documentation_fragment: vmware.documentation
+'''
+
+EXAMPLES = '''
+    - name: Enable EVC Mode
+      vmware_evc_mode:
+         hostname: "{{ groups['vcsa'][0] }}"
+         username: "{{ vcenter_username }}"
+         password: "{{ site_password }}"
+         datacenter_name: "{{ datacenter_name }}"
+         cluster_name: "{{ cluster_name }}"
+         evc_mode: "intel-broadwell"
+         state: present
+      delegate_to: localhost
+      register: enable_evc
+
+    - name: Disable EVC Mode
+      vmware_evc_mode:
+         hostname: "{{ groups['vcsa'][0] }}"
+         username: "{{ vcenter_username }}"
+         password: "{{ site_password }}"
+         datacenter_name: "{{ datacenter_name }}"
+         cluster_name: "{{ cluster_name }}"
+         state: absent
+      delegate_to: localhost
+      register: disable_evc
+'''
+
+RETURN = """
+result:
+    description: information about performed operation
+    returned: always
+    type: str
+    sample: "EVC Mode for 'intel-broadwell' has been enabled."
+"""
+
+try:
+    from pyVmomi import vim
+except ImportError:
+    pass
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+from ansible.module_utils.vmware import (PyVmomi, find_datacenter_by_name, find_cluster_by_name,
+                                         vmware_argument_spec, wait_for_task, TaskError)
+
+
+class VMwareEVC(PyVmomi):
+    def __init__(self, module):
+        super(VMwareEVC, self).__init__(module)
+        self.cluster_name = module.params['cluster_name']
+        self.evc_mode = module.params['evc_mode']
+        self.datacenter_name = module.params['datacenter_name']
+        self.desired_state = module.params['state']
+        self.datacenter = None
+        self.cluster = None
+
+    def process_state(self):
+        """
+        Manage internal states of evc
+        """
+        evc_states = {
+            'absent': {
+                'present': self.state_disable_evc,
+                'absent': self.state_exit_unchanged,
+            },
+            'present': {
+                'present': self.state_update_evc,
+                'absent': self.state_enable_evc,
+            }
+        }
+        current_state = self.check_evc_configuration()
+        # Based on the desired_state and the current_state call
+        # the appropriate method from the dictionary
+        evc_states[self.desired_state][current_state]()
+
+    def check_evc_configuration(self):
+        """
+        Check evc configuration
+        Returns: 'Present' if evc enabled, else 'absent'
+        """
+        try:
+            self.datacenter = find_datacenter_by_name(self.content, self.datacenter_name)
+            if self.datacenter is None:
+                self.module.fail_json(msg="Datacenter '%s' does not exist." % self.datacenter_name)
+            self.cluster = self.find_cluster_by_name(cluster_name=self.cluster_name, datacenter_name=self.datacenter)
+
+            if self.cluster is None:
+                self.module.fail_json(msg="Cluster '%s' does not exist." % self.cluster_name)
+            self.evcm = self.cluster.EvcManager()
+
+            if not self.evcm:
+                self.module.fail_json(msg="Unable to get EVC manager for cluster '%s'." % self.cluster_name)
+            self.evc_state = self.evcm.evcState
+            self.current_evc_mode = self.evc_state.currentEVCModeKey
+
+            if not self.current_evc_mode:
+                return 'absent'
+
+            return 'present'
+        except Exception as generic_exc:
+            self.module.fail_json(msg="Failed to check configuration"
+                                      " due to generic exception %s" % to_native(generic_exc))
+
+    def state_exit_unchanged(self):
+        """
+        Exit without any change
+        """
+        self.module.exit_json(changed=False, msg="EVC Mode is already disabled on cluster '%s'." % self.cluster_name)
+
+    def state_update_evc(self):
+        """
+        Update EVC Mode
+        """
+        changed, result = False, None
+        try:
+            if not self.module.check_mode and self.current_evc_mode != self.evc_mode:
+                evc_task = self.evcm.ConfigureEvcMode_Task(self.evc_mode)
+                changed, result = wait_for_task(evc_task)
+            if self.module.check_mode and self.current_evc_mode != self.evc_mode:
+                changed, result = True, None
+            if self.current_evc_mode == self.evc_mode:
+                self.module.exit_json(changed=changed, msg="EVC Mode is already set to '%(evc_mode)s' on '%(cluster_name)s'." % self.params)
+            self.module.exit_json(changed=changed, msg="EVC Mode has been updated to '%(evc_mode)s' on '%(cluster_name)s'." % self.params)
+        except TaskError as invalid_argument:
+            self.module.fail_json(msg="Failed to update EVC mode: %s" % to_native(invalid_argument))
+
+    def state_enable_evc(self):
+        """
+        Enable EVC Mode
+        """
+        changed, result = False, None
+        try:
+            if not self.module.check_mode:
+                evc_task = self.evcm.ConfigureEvcMode_Task(self.evc_mode)
+                changed, result = wait_for_task(evc_task)
+            if self.module.check_mode:
+                changed, result = True, None
+            self.module.exit_json(changed=changed, msg="EVC Mode for '%(evc_mode)s' has been enabled on '%(cluster_name)s'." % self.params)
+        except TaskError as invalid_argument:
+            self.module.fail_json(msg="Failed to enable EVC mode: %s" % to_native(invalid_argument))
+
+    def state_disable_evc(self):
+        """
+        Disable EVC Mode
+        """
+        changed, result = False, None
+        try:
+            if not self.module.check_mode:
+                evc_task = self.evcm.DisableEvcMode_Task()
+                changed, result = wait_for_task(evc_task)
+            if self.module.check_mode:
+                changed, result = True, None
+            self.module.exit_json(changed=changed, msg="EVC Mode has been disabled on cluster '%s'." % self.cluster_name)
+        except TaskError as invalid_argument:
+            self.module.fail_json(msg="Failed to disable EVC mode: %s" % to_native(invalid_argument))
+
+
+def main():
+    argument_spec = vmware_argument_spec()
+    argument_spec.update(dict(
+        cluster_name=dict(type='str', required=True),
+        datacenter_name=dict(type='str', required=True),
+        evc_mode=dict(type='str', required=True),
+        state=dict(type='str', default='present', choices=['absent', 'present']),
+    ))
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=[
+            ['state', 'present', ['cluster_name', 'datacenter_name', 'evc_mode']]
+        ]
+    )
+
+    vmware_evc = VMwareEVC(module)
+    vmware_evc.process_state()
+
+
+if __name__ == '__main__':
+    main()

test/integration/targets/vmware_evc_mode/aliases

@@ -0,0 +1,2 @@
+shippable/vcenter/group1
+cloud/vcenter

test/integration/targets/vmware_evc_mode/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_vmware_tests

test/integration/targets/vmware_evc_mode/tasks/main.yml

@@ -0,0 +1,25 @@
+# Test code for the vmware evc mode module.
+# Copyright: (c) 2019, Michael Tipton <mike () ibeta.org>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- when: vcsim is not defined
+  block:
+  - name: Enable EVC mode on vCenter Cluster
+    vmware_evc_mode: &vmware_evc_data
+      hostname: "{{ vcenter_hostname }}"
+      username: "{{ vcenter_username }}"
+      password: "{{ vcenter_password }}"
+      validate_certs: no
+      evc_mode: intel-broadwell
+      state: present
+      check_mode: yes
+
+  - name: Enable EVC mode on vCenter Cluster
+    vmware_evc_mode:
+      <<: *vmware_evc_data
+  
+  - name: Disable EVC mode on vCenter Cluster
+    vmware_evc_mode:
+      <<: *vmware_evc_data
+      state: absent
+      check_mode: yes