From fe8af27e5d78dc9e1ed38173af8e43cdb5591e65 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 28 Aug 2018 06:25:46 -0700 Subject: [PATCH] VMware: new module: vmware_host_ntp_facts (#44306) Signed-off-by: Abhijeet Kasurde --- .../cloud/vmware/vmware_host_ntp_facts.py | 133 ++++++++++++++++++ .../targets/vmware_host_ntp_facts/aliases | 2 + .../vmware_host_ntp_facts/tasks/main.yml | 61 ++++++++ 3 files changed, 196 insertions(+) create mode 100644 lib/ansible/modules/cloud/vmware/vmware_host_ntp_facts.py create mode 100644 test/integration/targets/vmware_host_ntp_facts/aliases create mode 100644 test/integration/targets/vmware_host_ntp_facts/tasks/main.yml diff --git a/lib/ansible/modules/cloud/vmware/vmware_host_ntp_facts.py b/lib/ansible/modules/cloud/vmware/vmware_host_ntp_facts.py new file mode 100644 index 0000000000..1057ffbaa6 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_host_ntp_facts.py @@ -0,0 +1,133 @@ +#!/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_ntp_facts +short_description: Gathers facts about NTP configuration on an ESXi host +description: +- This module can be used to gather facts about NTP configurations on an ESXi host. +version_added: 2.7 +author: +- Abhijeet Kasurde (@Akasurde) +notes: +- Tested on vSphere 6.5 +requirements: +- python >= 2.6 +- PyVmomi +options: + cluster_name: + description: + - Name of the cluster. + - NTP config facts about each ESXi server will be returned for the given cluster. + - If C(esxi_hostname) is not given, this parameter is required. + esxi_hostname: + description: + - ESXi hostname. + - NTP config facts about this ESXi server will be returned. + - If C(cluster_name) is not given, this parameter is required. +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = r''' +- name: Gather NTP facts about all ESXi Host in the given Cluster + vmware_host_ntp_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + cluster_name: cluster_name + delegate_to: localhost + register: cluster_host_ntp + +- name: Gather NTP facts about ESXi Host + vmware_host_ntp_facts: + hostname: '{{ vcenter_hostname }}' + username: '{{ vcenter_username }}' + password: '{{ vcenter_password }}' + esxi_hostname: '{{ esxi_hostname }}' + delegate_to: localhost + register: host_ntp +''' + +RETURN = r''' +hosts_ntp_facts: + description: + - dict with hostname as key and dict with NTP facts as value + returned: hosts_ntp_facts + type: dict + sample: { + "10.76.33.226": [ + { + "ntp_servers": [], + "time_zone_description": "UTC", + "time_zone_gmt_offset": 0, + "time_zone_identifier": "UTC", + "time_zone_name": "UTC" + } + ] + } +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi + + +class VmwareNtpFactManager(PyVmomi): + def __init__(self, module): + super(VmwareNtpFactManager, self).__init__(module) + cluster_name = self.params.get('cluster_name', None) + esxi_host_name = self.params.get('esxi_hostname', None) + self.hosts = self.get_all_host_objs(cluster_name=cluster_name, esxi_host_name=esxi_host_name) + + def gather_ntp_facts(self): + hosts_facts = {} + for host in self.hosts: + host_ntp_facts = [] + host_date_time_manager = host.configManager.dateTimeSystem + if host_date_time_manager: + host_ntp_facts.append( + dict( + time_zone_identifier=host_date_time_manager.dateTimeInfo.timeZone.key, + time_zone_name=host_date_time_manager.dateTimeInfo.timeZone.name, + time_zone_description=host_date_time_manager.dateTimeInfo.timeZone.description, + time_zone_gmt_offset=host_date_time_manager.dateTimeInfo.timeZone.gmtOffset, + ntp_servers=[ntp_server for ntp_server in host_date_time_manager.dateTimeInfo.ntpConfig.server] + ) + ) + hosts_facts[host.name] = host_ntp_facts + return hosts_facts + + +def main(): + argument_spec = vmware_argument_spec() + argument_spec.update( + cluster_name=dict(type='str', required=False), + esxi_hostname=dict(type='str', required=False), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=[ + ['cluster_name', 'esxi_hostname'], + ], + supports_check_mode=True, + ) + + vmware_host_ntp_config = VmwareNtpFactManager(module) + module.exit_json(changed=False, hosts_ntp_facts=vmware_host_ntp_config.gather_ntp_facts()) + + +if __name__ == "__main__": + main() diff --git a/test/integration/targets/vmware_host_ntp_facts/aliases b/test/integration/targets/vmware_host_ntp_facts/aliases new file mode 100644 index 0000000000..845e8a6dad --- /dev/null +++ b/test/integration/targets/vmware_host_ntp_facts/aliases @@ -0,0 +1,2 @@ +cloud/vcenter +unsupported diff --git a/test/integration/targets/vmware_host_ntp_facts/tasks/main.yml b/test/integration/targets/vmware_host_ntp_facts/tasks/main.yml new file mode 100644 index 0000000000..0b989bef00 --- /dev/null +++ b/test/integration/targets/vmware_host_ntp_facts/tasks/main.yml @@ -0,0 +1,61 @@ +# Test code for the vmware_host_ntp_facts 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 NTP Manager related to operations + +- 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 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=host1 + +- name: Gather NTP facts about all hosts in given host + vmware_host_ntp_facts: + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance['json']['username'] }}" + password: "{{ vcsim_instance['json']['password'] }}" + esxi_hostname: "{{ host1 }}" + validate_certs: no + register: host_ntp + +- debug: var=host_ntp + +- assert: + that: + - host_ntp.hosts_ntp_facts is defined