diff --git a/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py b/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py new file mode 100644 index 00000000000..837a2a96b12 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py @@ -0,0 +1,157 @@ +#!/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_host_config_manager +short_description: Manage advance configurations about an ESXi host +description: +- This module can be used to manage advance configuration information about an ESXi host when ESXi hostname or Cluster name is given. +version_added: '2.5' +author: +- Abhijeet Kasurde (@akasurde) +notes: +- Tested on vSphere 6.5 +requirements: +- python >= 2.6 +- PyVmomi +options: + cluster_name: + description: + - Name of the cluster. + - Settings are applied to every ESXi host system in given cluster. + - If C(esxi_hostname) is not given, this parameter is required. + esxi_hostname: + description: + - ESXi hostname. + - Settings are applied to this ESXi host system. + - If C(cluster_name) is not given, this parameter is required. + options: + description: + - A dictionary of advance configuration parameter. + - Invalid configuration parameters are ignored. +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = r''' +- name: Manage Log level setting for all ESXi Host in given Cluster + vmware_host_config_manager: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + cluster_name: cluster_name + options: + 'Config.HostAgent.log.level': 'info' + +- name: Manage Log level setting for an ESXi Host + vmware_host_config_manager: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ esxi_hostname }}' + options: + 'Config.HostAgent.log.level': 'verbose' + +- name: Manage multiple settings for an ESXi Host + vmware_host_config_manager: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ esxi_hostname }}' + options: + 'Config.HostAgent.log.level': 'verbose' + 'Annotations.WelcomeMessage': 'Hello World' + 'Config.HostAgent.plugins.solo.enableMob': false +''' + +RETURN = r'''# +''' + +try: + from pyVmomi import vim, vmodl +except ImportError: + pass + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi +from ansible.module_utils._text import to_native + + +class VmwareConfigManager(PyVmomi): + def __init__(self, module): + super(VmwareConfigManager, self).__init__(module) + cluster_name = self.params.get('cluster_name', None) + esxi_host_name = self.params.get('esxi_hostname', None) + self.options = self.params.get('options', dict()) + self.hosts = [] + if cluster_name: + cluster_obj = self.find_cluster_by_name(cluster_name=cluster_name) + if cluster_obj: + self.hosts = [host for host in cluster_obj.host] + else: + module.fail_json(changed=False, msg="Cluster '%s' not found" % cluster_name) + elif esxi_host_name: + esxi_host_obj = self.find_hostsystem_by_name(host_name=esxi_host_name) + if esxi_host_obj: + self.hosts = [esxi_host_obj] + else: + module.fail_json(changed=False, msg="ESXi '%s' not found" % esxi_host_name) + + def set_host_configuration_facts(self): + changed = False + for host in self.hosts: + option_manager = host.configManager.advancedOption + host_facts = {} + for option in option_manager.QueryOptions(): + host_facts[option.key] = option.value + change_option_list = [] + for option_key, option_value in self.options.items(): + if option_key in host_facts and option_value != host_facts[option_key]: + change_option_list.append(vim.option.OptionValue(key=option_key, value=option_value)) + changed = True + if changed: + try: + option_manager.UpdateOptions(changedValue=change_option_list) + except vmodl.fault.InvalidArgument as e: + self.module.fail_json(msg="Failed to update option/s as one or more OptionValue " + "contains an invalid value: %s" % to_native(e.msg)) + except vim.fault.InvalidName as e: + self.module.fail_json(msg="Failed to update option/s as one or more OptionValue " + "objects refers to a non-existent option : %s" % to_native(e.msg)) + + self.module.exit_json(changed=changed) + + +def main(): + argument_spec = vmware_argument_spec() + argument_spec.update( + cluster_name=dict(type='str', required=False), + esxi_hostname=dict(type='str', required=False), + options=dict(type='dict', default=dict(), required=False), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=[ + ['cluster_name', 'esxi_hostname'], + ] + ) + + vmware_host_config = VmwareConfigManager(module) + vmware_host_config.set_host_configuration_facts() + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/vmware_host_config_manager/aliases b/test/integration/targets/vmware_host_config_manager/aliases new file mode 100644 index 00000000000..6ee4e3d4f9f --- /dev/null +++ b/test/integration/targets/vmware_host_config_manager/aliases @@ -0,0 +1,3 @@ +posix/ci/cloud/group4/vcenter +cloud/vcenter + diff --git a/test/integration/targets/vmware_host_config_manager/tasks/main.yml b/test/integration/targets/vmware_host_config_manager/tasks/main.yml new file mode 100644 index 00000000000..c53959da764 --- /dev/null +++ b/test/integration/targets/vmware_host_config_manager/tasks/main.yml @@ -0,0 +1,93 @@ +# Test code for the vmware_host_config_manager 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 update host configuartion +#- 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 Cluster from vcsim +# uri: +# url: http://{{ vcsim }}:5000/govc_find?filter=CCR +# register: clusters + +#- name: get a cluster +# set_fact: +# ccr1: "{{ clusters.json[0] | basename }}" + +#- 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=ccr1 +#- debug: var=host1 + +#- name: Change facts about all hosts in given cluster +# vmware_host_config_manager: +# hostname: "{{ vcsim }}" +# username: "{{ vcsim_instance.json.username }}" +# password: "{{ vcsim_instance.json.password }}" +# cluster_name: "{{ ccr1 }}" +# options: +# 'Config.HostAgent.log.level': 'verbose' +# validate_certs: no +# register: all_hosts_result + +#- name: ensure changes are done to all hosts +# assert: +# that: +# - all_hosts_result.changed + +#- name: Change facts about a given host +# vmware_host_config_manager: +# hostname: "{{ vcsim }}" +# username: "{{ vcsim_instance.json.username }}" +# password: "{{ vcsim_instance.json.password }}" +# esxi_hostname: "{{ host1 }}" +# options: +# 'Config.HostAgent.log.level': 'info' +# validate_certs: no +# register: host_result + +#- name: ensure changes are done to given hosts +# assert: +# that: +# - all_hosts_result.changed