#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2015, Joseph Callen # Copyright: (c) 2017, Ansible Project # 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 short_description: Add / Remove ESXi host to / from vCenter description: - This module can be used to add / remove / reconnect an ESXi host to / from vCenter. version_added: '2.0' author: - Joseph Callen (@jcpowermac) - Russell Teague (@mtnbikenc) - Maxime de Roucy (@tchernomax) notes: - Tested on vSphere 5.5 requirements: - python >= 2.6 - PyVmomi options: datacenter_name: description: - Name of the datacenter to add the host. required: yes cluster_name: description: - Name of the cluster to add the host. - Required parameter from version 2.5. required: yes esxi_hostname: description: - ESXi hostname to manage. required: yes esxi_username: description: - ESXi username. - Required for adding a host. - Optional for reconnect. - Unused for removing. - No longer required parameter from version 2.5. esxi_password: description: - ESXi password. - Required for adding a host. - Optional for reconnect. - Unused for removing. - No longer required parameter from version 2.5. state: description: - "present: add the host if it's absent else do nothing." - "absent: remove the host if it's present else do nothing." - "add_or_reconnect: add the host if it's absent else reconnect it." - "reconnect: reconnect the host if it's present else fail." default: present choices: - present - absent - add_or_reconnect - reconnect esxi_ssl_thumbprint: description: - "Specifying the hostsystem's certificate's thumbprint." - "Use following command to get hostsystem's certificate's thumbprint - " - "# openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha1 -noout" version_added: 2.5 default: '' extends_documentation_fragment: vmware.documentation ''' EXAMPLES = r''' - name: Add ESXi Host to vCenter vmware_host: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter_name cluster_name: cluster_name esxi_hostname: '{{ esxi_hostname }}' esxi_username: '{{ esxi_username }}' esxi_password: '{{ esxi_password }}' state: present - name: Reconnect ESXi Host (with username/password set) vmware_host: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter_name cluster_name: cluster_name esxi_hostname: '{{ esxi_hostname }}' esxi_username: '{{ esxi_username }}' esxi_password: '{{ esxi_password }}' state: reconnect - name: Reconnect ESXi Host (with default username/password) vmware_host: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter_name cluster_name: cluster_name esxi_hostname: '{{ esxi_hostname }}' state: reconnect - name: Add ESXi Host with SSL Thumbprint to vCenter vmware_host: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter_name cluster_name: cluster_name esxi_hostname: '{{ esxi_hostname }}' esxi_username: '{{ esxi_username }}' esxi_password: '{{ esxi_password }}' esxi_ssl_thumbprint: "3C:A5:60:6F:7A:B7:C4:6C:48:28:3D:2F:A5:EC:A3:58:13:88:F6:DD" state: present ''' RETURN = r''' ''' try: from pyVmomi import vim, vmodl 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, TaskError, vmware_argument_spec, wait_for_task, find_host_by_cluster_datacenter) class VMwareHost(PyVmomi): def __init__(self, module): super(VMwareHost, self).__init__(module) self.datacenter_name = module.params['datacenter_name'] self.cluster_name = module.params['cluster_name'] self.esxi_hostname = module.params['esxi_hostname'] self.esxi_username = module.params['esxi_username'] self.esxi_password = module.params['esxi_password'] self.state = module.params['state'] self.esxi_ssl_thumbprint = module.params.get('esxi_ssl_thumbprint', '') self.cluster = None self.host = None def process_state(self): # Currently state_update_host is not implemented. host_states = { 'absent': { 'present': self.state_remove_host, 'absent': self.state_exit_unchanged, }, 'present': { 'present': self.state_exit_unchanged, 'absent': self.state_add_host, }, 'add_or_reconnect': { 'present': self.state_reconnect_host, 'absent': self.state_add_host, }, 'reconnect': { 'present': self.state_reconnect_host, } } try: host_states[self.state][self.check_host_state()]() except vmodl.RuntimeFault as runtime_fault: self.module.fail_json(msg=to_native(runtime_fault.msg)) except vmodl.MethodFault as method_fault: self.module.fail_json(msg=to_native(method_fault.msg)) except Exception as e: self.module.fail_json(msg=to_native(e)) def add_host_to_vcenter(self): host_connect_spec = vim.host.ConnectSpec() host_connect_spec.hostName = self.esxi_hostname host_connect_spec.userName = self.esxi_username host_connect_spec.password = self.esxi_password host_connect_spec.force = True host_connect_spec.sslThumbprint = self.esxi_ssl_thumbprint as_connected = True esxi_license = None resource_pool = None for count in range(0, 2): try: task = self.cluster.AddHost_Task(host_connect_spec, as_connected, resource_pool, esxi_license) success, result = wait_for_task(task) return success, result except TaskError as task_error_exception: task_error = task_error_exception.args[0] if self.esxi_ssl_thumbprint == '' and isinstance(task_error, vim.fault.SSLVerifyFault): # User has not specified SSL Thumbprint for ESXi host, # try to grab it using SSLVerifyFault exception host_connect_spec.sslThumbprint = task_error.thumbprint else: self.module.fail_json(msg="Failed to add host %s to vCenter: %s" % (self.esxi_hostname, to_native(task_error.msg))) self.module.fail_json(msg="Failed to add host %s to vCenter" % self.esxi_hostname) def reconnect_host_to_vcenter(self): reconnecthost_args = {} reconnecthost_args['reconnectSpec'] = vim.HostSystem.ReconnectSpec() reconnecthost_args['reconnectSpec'].syncState = True if self.esxi_username is not None or self.esxi_password is not None: reconnecthost_args['cnxSpec'] = vim.host.ConnectSpec() reconnecthost_args['cnxSpec'].hostName = self.esxi_hostname reconnecthost_args['cnxSpec'].userName = self.esxi_username reconnecthost_args['cnxSpec'].password = self.esxi_password reconnecthost_args['cnxSpec'].force = True reconnecthost_args['cnxSpec'].sslThumbprint = self.esxi_ssl_thumbprint for count in range(0, 2): try: task = self.host.ReconnectHost_Task(**reconnecthost_args) success, result = wait_for_task(task) return success, result except TaskError as task_error_exception: task_error = task_error_exception.args[0] if self.esxi_ssl_thumbprint == '' and isinstance(task_error, vim.fault.SSLVerifyFault): # User has not specified SSL Thumbprint for ESXi host, # try to grab it using SSLVerifyFault exception reconnecthost_args['cnxSpec'].sslThumbprint = task_error.thumbprint else: self.module.fail_json(msg="Failed to reconnect host %s to vCenter: %s" % (self.esxi_hostname, to_native(task_error.msg))) self.module.fail_json(msg="Failed to reconnect host %s to vCenter" % self.esxi_hostname) else: try: task = self.host.ReconnectHost_Task(**reconnecthost_args) success, result = wait_for_task(task) return success, result except TaskError as task_error_exception: task_error = task_error_exception.args[0] self.module.fail_json(msg="Failed to reconnect host %s to vCenter due to %s" % (self.esxi_hostname, to_native(task_error.msg))) def state_exit_unchanged(self): self.module.exit_json(changed=False) def state_remove_host(self): changed = True result = None if not self.module.check_mode: if not self.host.runtime.inMaintenanceMode: maintenance_mode_task = self.host.EnterMaintenanceMode_Task(300, True, None) changed, result = wait_for_task(maintenance_mode_task) if changed: task = self.host.Destroy_Task() changed, result = wait_for_task(task) else: raise Exception(result) self.module.exit_json(changed=changed, result=str(result)) def state_update_host(self): self.module.exit_json(changed=False, msg="Currently not implemented.") def state_add_host(self): changed = True result = None if not self.module.check_mode: changed, result = self.add_host_to_vcenter() self.module.exit_json(changed=changed, result=str(result)) def state_reconnect_host(self): changed = True result = None if not self.module.check_mode: changed, result = self.reconnect_host_to_vcenter() self.module.exit_json(changed=changed, result=str(result)) def check_host_state(self): self.host, self.cluster = find_host_by_cluster_datacenter(self.module, self.content, self.datacenter_name, self.cluster_name, self.esxi_hostname) if self.host is None: return 'absent' else: return 'present' def main(): argument_spec = vmware_argument_spec() argument_spec.update( datacenter_name=dict(type='str', required=True), cluster_name=dict(type='str', required=True), esxi_hostname=dict(type='str', required=True), esxi_username=dict(type='str', required=False), esxi_password=dict(type='str', required=False, no_log=True), esxi_ssl_thumbprint=dict(type='str', default=''), state=dict(default='present', choices=['present', 'absent', 'add_or_reconnect', 'reconnect'], type='str') ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ['state', 'present', ['esxi_username', 'esxi_password']], ['state', 'add_or_reconnect', ['esxi_username', 'esxi_password']] ] ) vmware_host = VMwareHost(module) vmware_host.process_state() if __name__ == '__main__': main()