New in version 2.5.
state
is not given, the NTP servers will be configured in the exact sequence.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name
string
|
Name of the cluster from which all host systems will be used.
This parameter is required if
esxi_hostname is not specified. |
|
esxi_hostname
string
|
Name of the host system to work with.
This parameter is required if
cluster_name is not specified. |
|
hostname
string
|
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
VMWARE_HOST will be used instead.Environment variable support added in Ansible 2.6.
|
|
ntp_servers
list
/ required
|
IP or FQDN of NTP server(s).
This accepts a list of NTP servers. For multiple servers, please look at the examples.
|
|
password
string
|
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PASSWORD will be used instead.Environment variable support added in Ansible 2.6.
aliases: pass, pwd |
|
port
integer
added in 2.5 |
Default: 443
|
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PORT will be used instead.Environment variable support added in Ansible 2.6.
|
state
string
|
|
present: Add NTP server(s), if specified server(s) are absent else do nothing.
absent: Remove NTP server(s), if specified server(s) are present else do nothing.
Specified NTP server(s) will be configured if
state isn't specified. |
username
string
|
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_USER will be used instead.Environment variable support added in Ansible 2.6.
aliases: admin, user |
|
validate_certs
boolean
|
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.If the value is not specified in the task, the value of environment variable
VMWARE_VALIDATE_CERTS will be used instead.Environment variable support added in Ansible 2.6.
If set to
yes , please make sure Python >= 2.7.9 is installed on the given machine. |
verbose
boolean
added in 2.8 |
|
Verbose output of the configuration change.
Explains if an NTP server was added, removed, or if the NTP server sequence was changed.
|
- name: Configure NTP servers for an ESXi Host
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
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
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
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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
results
dictionary
|
always |
metadata about host system's NTP configuration
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'], 'state': 'present', 'ntp_servers_previous': ['time1.example.local', 'time2.example.local']}}
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.