dellemc.openmanage.ome_application_network_time – Updates the network time on OpenManage Enterprise

Note

This plugin is part of the dellemc.openmanage collection (version 3.6.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 dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_application_network_time.

New in version 2.1.0: of dellemc.openmanage

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module allows the configuration of network time on OpenManage Enterprise.

Requirements

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

python >= 2.7.5

Parameters

Parameter	Choices/Defaults	Comments
enable_ntp boolean / required	Choices: no yes	Enables or disables Network Time Protocol(NTP). If enable_ntp is false, then the NTP addresses reset to their default values.
hostname string / required		OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
password string / required		OpenManage Enterprise or OpenManage Enterprise Modular password.
port integer	Default: 443	OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
primary_ntp_address string		The primary NTP address. This option is applicable when enable_ntp is true.
secondary_ntp_address1 string		The first secondary NTP address. This option is applicable when enable_ntp is true.
secondary_ntp_address2 string		The second secondary NTP address. This option is applicable when enable_ntp is true.
system_time string		Time in the current system. This option is only applicable when enable_ntp is false. This option must be provided in following format 'yyyy-mm-dd hh:mm:ss'.
time_zone string		The valid timezone ID to be used. This option is applicable for both system time and NTP time synchronization.
username string / required		OpenManage Enterprise or OpenManage Enterprise Modular username.

Notes

Note

Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
This module supports check_mode.

Examples

---
- name: Configure system time
  dellemc.openmanage.ome_application_network_time:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    enable_ntp: false
    system_time: "2020-03-31 21:35:18"
    time_zone: "TZ_ID_11"

- name: Configure NTP server for time synchronization
  dellemc.openmanage.ome_application_network_time:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    enable_ntp: true
    time_zone: "TZ_ID_66"
    primary_ntp_address: "192.168.0.2"
    secondary_ntp_address1: "192.168.0.2"
    secondary_ntp_address2: "192.168.0.4"

Return Values

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

Key	Returned	Description
error_info dictionary	on HTTP error	Details of the HTTP error. Sample: {'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to complete the request because the input value for SystemTime is missing or an invalid value is entered.', 'MessageArgs': ['SystemTime'], 'MessageId': 'CGEN6002', 'RelatedProperties': [], 'Resolution': 'Enter a valid value and retry the operation.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg string	always	Overall status of the network time configuration change. Sample: Successfully configured network time.
proxy_configuration dictionary	success	Updated application network time configuration. Sample: {'EnableNTP': False, 'JobId': None, 'PrimaryNTPAddress': None, 'SecondaryNTPAddress1': None, 'SecondaryNTPAddress2': None, 'SystemTime': None, 'TimeSource': 'Local Clock', 'TimeZone': 'TZ_ID_1', 'TimeZoneIdLinux': None, 'TimeZoneIdWindows': None, 'UtcTime': None}

Authors

Sajna Shetty(@Sajna-Shetty)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_application_network_time_module.html