vmware.vmware_rest.appliance_ntp module – Set NTP servers

Note

This module is part of the vmware.vmware_rest collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.appliance_ntp.

New in vmware.vmware_rest 2.0.0

Synopsis

  • Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.2 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

servers

list / elements=string / required

List of host names or ip addresses of ntp servers. This parameter is mandatory.

session_timeout

float

added in vmware.vmware_rest 2.1.0

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

state

string

Choices:

  • "set" ← (default)

  • "test"

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that run the module.

If the value is not specified in the task, the value of

environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Tested on vSphere 7.0.2

Examples

- name: Adjust the NTP configuration
  vmware.vmware_rest.appliance_ntp:
    servers:
    - time.google.com

- name: Test the NTP configuration
  vmware.vmware_rest.appliance_ntp:
    state: test
    servers:
    - time.google.com
  register: result

- name: Adjust the NTP configuration
  vmware.vmware_rest.appliance_ntp:
    vcenter_hostname: '{{ vcsa_host }}'
    servers:
    - time.google.com
  delegate_to: localhost

- name: Test the NTP configuration
  vmware.vmware_rest.appliance_ntp:
    vcenter_hostname: '{{ vcsa_host }}'
    state: test
    servers:
    - time.google.com
  delegate_to: localhost
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

value

list / elements=string

Test the NTP configuration

Returned: On success

Sample: [{"message": {"args": [], "default_message": "NTP Server is reachable.", "id": "com.vmware.appliance.ntp_sync.success"}, "server": "time.google.com", "status": "SERVER_REACHABLE"}]

Authors

  • Ansible Cloud Team (@ansible-collections)