vmware.vmware_rest.appliance_system_time_info module – Gather the current system time of the vCenter Server Appliance.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.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.

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

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.appliance_info.

Alternative:

Use vmware.vmware.appliance_info instead.

Synopsis

  • Retrieve the current system time reported by the vCenter Server Appliance.

  • Returns the date, the time, the configured timezone, and the number of seconds since the epoch as seen by the appliance.

  • Use this module to verify that the appliance clock and timezone are set correctly, which is important for certificate validation, logging, and authentication.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

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_port

integer

The port number of the vSphere vCenter.

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

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Gather the current system time of the appliance
  vmware.vmware_rest.appliance_system_time_info:
  register: system_time

- name: Show the appliance date, time, and timezone
  ansible.builtin.debug:
    msg: "The appliance time is {{ system_time.value.date }} {{ system_time.value.time }} ({{ system_time.value.timezone }})"

Return Values

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

Key

Description

info

list / elements=dictionary

A list containing the current system time of the appliance.

Returned: On success

Sample: [{"date": "Thu 07-31-2014", "seconds_since_epoch": 1406830712.0, "time": "18:18:32", "timezone": "UTC"}]

value

dictionary

Detailed information about the current system time of the appliance.

Returned: On success

Sample: {"date": "Thu 07-31-2014", "seconds_since_epoch": 1406830712.0, "time": "18:18:32", "timezone": "UTC"}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ansible Eco Content Team (@eco-ansible-content)