community / community.vmware / 4.2.0 / module / vmware_host_ntp Manage NTP server configuration of an ESXi host Authors: Abhijeet Kasurde (@Akasurde), Christian Kotte (@ckotte)community.vmware.vmware_host_ntp (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to configure, add or remove NTP servers from an ESXi host.
If O(state) is not given, the NTP servers will be configured in the exact sequence.
User can specify an ESXi hostname or Cluster name. In case of cluster name, all ESXi hosts are updated.
- name: Configure NTP servers for an ESXi Host community.vmware.vmware_host_ntp: hostname: vcenter01.example.local username: administrator@vsphere.local password: SuperSecretPassword esxi_hostname: esx01.example.local ntp_servers: - 0.pool.ntp.org - 1.pool.ntp.org delegate_to: localhost
- name: Set NTP servers for all ESXi Host in given Cluster community.vmware.vmware_host_ntp: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' cluster_name: '{{ cluster_name }}' state: present ntp_servers: - 0.pool.ntp.org - 1.pool.ntp.org delegate_to: localhost
- name: Set NTP servers for an ESXi Host community.vmware.vmware_host_ntp: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: '{{ esxi_hostname }}' state: present ntp_servers: - 0.pool.ntp.org - 1.pool.ntp.org delegate_to: localhost
- name: Remove NTP servers for an ESXi Host community.vmware.vmware_host_ntp: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: '{{ esxi_hostname }}' state: absent ntp_servers: - bad.server.ntp.org delegate_to: localhost
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent description: - 'V(present): Add NTP server(s), if specified server(s) are absent else do nothing.' - 'V(absent): Remove NTP server(s), if specified server(s) are present else do nothing.' - Specified NTP server(s) will be configured if O(state) isn't specified. type: str verbose: default: false description: - Verbose output of the configuration change. - Explains if an NTP server was added, removed, or if the NTP server sequence was changed. required: false type: bool hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int ntp_servers: description: - IP or FQDN of NTP server(s). - This accepts a list of NTP servers. For multiple servers, please look at the examples. elements: str required: true type: list cluster_name: description: - Name of the cluster from which all host systems will be used. - This parameter is required if O(esxi_hostname) is not specified. type: str esxi_hostname: description: - Name of the host system to work with. - This parameter is required if O(cluster_name) is not specified. type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool
host_ntp_status: description: metadata about host system's NTP configuration returned: always sample: esx01.example.local: ntp_servers: - time3.example.local - time4.example.local ntp_servers_changed: - time1.example.local - time2.example.local - time3.example.local - time4.example.local ntp_servers_previous: - time1.example.local - time2.example.local esx02.example.local: ntp_servers_changed: - time3.example.local ntp_servers_current: - time1.example.local - time2.example.local - time3.example.local ntp_servers_previous: - time1.example.local - time2.example.local state: present type: dict