From c5e3c80800b414736858d9c9a9ac279c59be8b1b Mon Sep 17 00:00:00 2001 From: Michael Eaton Date: Fri, 22 Feb 2019 11:15:53 +0000 Subject: [PATCH] VMware: New Module: vmware_host_scanhba (#51440) --- .../cloud/vmware/vmware_host_scanhba.py | 150 ++++++++++++++++++ .../targets/vmware_host_scanhba/aliases | 2 + .../vmware_host_scanhba/tasks/main.yml | 86 ++++++++++ 3 files changed, 238 insertions(+) create mode 100644 lib/ansible/modules/cloud/vmware/vmware_host_scanhba.py create mode 100644 test/integration/targets/vmware_host_scanhba/aliases create mode 100644 test/integration/targets/vmware_host_scanhba/tasks/main.yml diff --git a/lib/ansible/modules/cloud/vmware/vmware_host_scanhba.py b/lib/ansible/modules/cloud/vmware/vmware_host_scanhba.py new file mode 100644 index 0000000000..28cd1ddc21 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_host_scanhba.py @@ -0,0 +1,150 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright: (c) 2018, 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_scanhba +short_description: Rescan host HBA's and optionally refresh the storage system +description: +- This module can force a rescan of the hosts HBA subsystem which is needed when wanting to mount a new datastore. +- You could use this before using vmware_host_datastore to mount a new datastore to ensure your device/volume is ready. +- You can also optionally force a Refresh of the Storage System in vCenter/ESXi Web Client. +- All parameters and VMware object names are case sensitive. +- You can supply an esxi_hostname or a cluster_name +version_added: '2.8' +author: +- Michael Eaton (@michaeldeaton) +notes: +- Tested on vSphere 6.0 +requirements: +- python >= 2.6 +- PyVmomi +options: + esxi_hostname: + description: + - ESXi hostname to Rescan the storage subsystem on. + required: false + cluster_name: + description: + - Cluster name to Rescan the storage subsystem on (this will run the rescan task on each host in the cluster). + required: false + refresh_storage: + description: + - Refresh the storage system in vCenter/ESXi Web Client for each host found + required: false + default: false + type: bool +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = r''' +- name: Recan HBA's for a given ESXi host and refresh storage system objects + vmware_host_scanhba: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ inventory_hostname }}' + refresh_storage: true + delegate_to: localhost + +- name: Rescan HBA's for a given cluster - all found hosts will be scanned + vmware_host_scanhba: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ inventory_hostname }}' + refresh_storage: true + delegate_to: localhost + +- name: Recan HBA's for a given ESXi host and don't refresh storage system objects + vmware_host_scanhba: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ inventory_hostname }}' + delegate_to: localhost +''' + +RETURN = r''' +result: + description: return confirmation of requested host and updated / refreshed storage system + returned: always + type: dict + sample: { + "esxi01.example.com": { + "rescaned_hba": "true", + "refreshed_storage": "true" + } + } +''' + +try: + from pyVmomi import vim +except ImportError: + pass + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi, find_obj +from ansible.module_utils._text import to_native + + +class VmwareHbaScan(PyVmomi): + def __init__(self, module): + super(VmwareHbaScan, self).__init__(module) + + def scan(self): + esxi_host_name = self.params.get('esxi_hostname', None) + cluster_name = self.params.get('cluster_name', None) + refresh_storage = self.params.get('refresh_storage', bool) + hosts = self.get_all_host_objs(cluster_name=cluster_name, esxi_host_name=esxi_host_name) + results = dict(changed=True, result=dict()) + + if not hosts: + self.module.fail_json(msg="Failed to find any hosts.") + + for host in hosts: + results['result'][host.name] = dict() + host.configManager.storageSystem.RescanAllHba() + if refresh_storage is True: + host.configManager.storageSystem.RefreshStorageSystem() + + results['result'][host.name]['rescaned_hba'] = True + results['result'][host.name]['refreshed_storage'] = refresh_storage + + self.module.exit_json(**results) + + +def main(): + argument_spec = vmware_argument_spec() + argument_spec.update( + esxi_hostname=dict(type='str', required=False), + cluster_name=dict(type='str', required=False), + refresh_storage=dict(type='bool', default=False, required=False) + ) + module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=[ + ['cluster_name', 'esxi_hostname'], + ], + supports_check_mode=False + ) + + hbascan = VmwareHbaScan(module) + hbascan.scan() + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/vmware_host_scanhba/aliases b/test/integration/targets/vmware_host_scanhba/aliases new file mode 100644 index 0000000000..65eb40aead --- /dev/null +++ b/test/integration/targets/vmware_host_scanhba/aliases @@ -0,0 +1,2 @@ +shippable/vcenter/group1 +unsupported \ No newline at end of file diff --git a/test/integration/targets/vmware_host_scanhba/tasks/main.yml b/test/integration/targets/vmware_host_scanhba/tasks/main.yml new file mode 100644 index 0000000000..61d8f74780 --- /dev/null +++ b/test/integration/targets/vmware_host_scanhba/tasks/main.yml @@ -0,0 +1,86 @@ +# Test code for the vmware_host_scanhba module. +# Copyright: (c) 2019, Michael Eaton +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +- 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 Datacenter from vcsim + uri: + url: http://{{ vcsim }}:5000/govc_find?filter=DC + register: datacenters + +- name: get a datacenter + set_fact: + dc1: "{{ datacenters.json[0] | basename }}" + +- debug: var=dc1 + +- 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 }}" + +- debug: var=ccr1 + +- name: add host + vmware_host: + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance.json.username }}" + password: "{{ vcsim_instance.json.password }}" + validate_certs: no + esxi_hostname: test_host_system_0001 + esxi_username: "{{ vcsim_instance.json.username }}" + esxi_password: "{{ vcsim_instance.json.password }}" + datacenter_name: "{{ dc1 }}" + cluster_name: "{{ ccr1 }}" + state: present + +- name: Recan HBA's for an entire cluster (there should be at least one host as above) + vmware_host_scanhba: + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance.json.username }}" + password: "{{ vcsim_instance.json.password }}" + validate_certs: no + cluster_name: '{{ ccr1 }}' + refresh_storage: false + register: host_scan_results + +- debug: msg="{{ host_scan_results }}" + +- name: ensure a change occured (as in the scan happened) and the task didnt fail + assert: + that: + - host_scan_results.changed + - not host_scan_results.failed \ No newline at end of file