diff options
Diffstat (limited to 'lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py')
| -rw-r--r-- | lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py | 198 |
1 files changed, 0 insertions, 198 deletions
diff --git a/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py b/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py deleted file mode 100644 index 651caa34e4..0000000000 --- a/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py +++ /dev/null @@ -1,198 +0,0 @@ -#!/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_host_config_manager -short_description: Manage advanced system settings of an ESXi host -description: -- This module can be used to manage advanced system settings of 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 in given cluster. - - If C(esxi_hostname) is not given, this parameter is required. - type: str - esxi_hostname: - description: - - ESXi hostname. - - Settings are applied to this ESXi host. - - If C(cluster_name) is not given, this parameter is required. - type: str - options: - description: - - A dictionary of advanced system settings. - - Invalid options will cause module to error. - - Note that the list of advanced options (with description and values) can be found by running `vim-cmd hostsvc/advopt/options`. - default: {} - type: dict -extends_documentation_fragment: vmware.documentation -''' - -EXAMPLES = r''' -- name: Manage Log level setting for all ESXi hosts 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' - delegate_to: localhost - -- 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' - delegate_to: localhost - -- 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 - delegate_to: localhost -''' - -RETURN = r'''# -''' - -try: - from pyVmomi import vim, vmodl, VmomiSupport -except ImportError: - pass - -from ansible.module_utils.basic import AnsibleModule -from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi, is_boolean, is_integer, is_truthy -from ansible.module_utils._text import to_native -from ansible.module_utils.six import integer_types, string_types - - -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 = self.get_all_host_objs(cluster_name=cluster_name, esxi_host_name=esxi_host_name) - - def set_host_configuration_facts(self): - changed_list = [] - message = '' - for host in self.hosts: - option_manager = host.configManager.advancedOption - host_facts = {} - for s_option in option_manager.supportedOption: - host_facts[s_option.key] = dict(option_type=s_option.optionType, value=None) - - for option in option_manager.QueryOptions(): - if option.key in host_facts: - host_facts[option.key].update( - value=option.value, - ) - - change_option_list = [] - for option_key, option_value in self.options.items(): - if option_key in host_facts: - # We handle all supported types here so we can give meaningful errors. - option_type = host_facts[option_key]['option_type'] - if is_boolean(option_value) and isinstance(option_type, vim.option.BoolOption): - option_value = is_truthy(option_value) - elif (isinstance(option_value, integer_types) or is_integer(option_value))\ - and isinstance(option_type, vim.option.IntOption): - option_value = VmomiSupport.vmodlTypes['int'](option_value) - elif (isinstance(option_value, integer_types) or is_integer(option_value, 'long'))\ - and isinstance(option_type, vim.option.LongOption): - option_value = VmomiSupport.vmodlTypes['long'](option_value) - elif isinstance(option_value, float) and isinstance(option_type, vim.option.FloatOption): - pass - elif isinstance(option_value, string_types) and isinstance(option_type, (vim.option.StringOption, vim.option.ChoiceOption)): - pass - else: - self.module.fail_json(msg="Provided value is of type %s." - " Option %s expects: %s" % (type(option_value), option_key, type(option_type))) - - if option_value != host_facts[option_key]['value']: - change_option_list.append(vim.option.OptionValue(key=option_key, value=option_value)) - changed_list.append(option_key) - else: # Don't silently drop unknown options. This prevents typos from falling through the cracks. - self.module.fail_json(msg="Unsupported option %s" % option_key) - if change_option_list: - if self.module.check_mode: - changed_suffix = ' would be changed.' - else: - changed_suffix = ' changed.' - if len(changed_list) > 2: - message = ', '.join(changed_list[:-1]) + ', and ' + str(changed_list[-1]) - elif len(changed_list) == 2: - message = ' and '.join(changed_list) - elif len(changed_list) == 1: - message = changed_list[0] - message += changed_suffix - if self.module.check_mode is False: - try: - option_manager.UpdateOptions(changedValue=change_option_list) - except (vmodl.fault.SystemError, 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)) - else: - message = 'All settings are already configured.' - - self.module.exit_json(changed=bool(changed_list), msg=message) - - -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, - supports_check_mode=True, - required_one_of=[ - ['cluster_name', 'esxi_hostname'], - ] - ) - - vmware_host_config = VmwareConfigManager(module) - vmware_host_config.set_host_configuration_facts() - - -if __name__ == "__main__": - main() |