wti.remote.cpm_time_config – Set Time/Date parameters in WTI OOB and PDU devices.
wti.remote.cpm_time_config – Set Time/Date parameters in WTI OOB and PDU devices.
Note
This plugin is part of the wti.remote collection (version 1.0.1).
To install it use: ansible-galaxy collection install wti.remote
.
To use it in a playbook, specify: wti.remote.cpm_time_config
.
New in version 2.10: of wti.remote
Synopsis
- Set Time/Date and NTP parameters parameters in WTI OOB and PDU devices
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cpm_password string / required |
This is the Password of the WTI device to send the module. | |
cpm_url string / required |
This is the URL of the WTI device to send the module. | |
cpm_username string / required |
This is the Username of the WTI device to send the module. | |
date string |
Static date in the format of two digit month, two digit day, four digit year separated by a slash symbol. | |
ipv4address string |
Comma separated string of up to two addresses for a primary and secondary IPv4 base NTP server. | |
ipv6address string |
Comma separated string of up to two addresses for a primary and secondary IPv6 base NTP server. | |
ntpenable integer |
|
This enables or disables the NTP client service. |
time string |
Static time in the format of two digit hour, two digit minute, two digit second separated by a colon symbol. | |
timeout integer |
Set the network timeout in seconds of contacting the NTP servers, valid options can be from 1-60. | |
timezone integer |
This is timezone that is assigned to the WTI device. | |
use_https boolean |
|
Designates to use an https connection or http connection. |
use_proxy boolean |
|
Flag to control if the lookup will observe HTTP proxy environment variables when present. |
validate_certs boolean |
|
If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
Note
- Use
groups/cpm
inmodule_defaults
to set common options used between CPM modules.
Examples
# Set a static time/date and timezone of a WTI device
- name: Set known fixed time/date of a WTI device
cpm_time_config:
cpm_url: "nonexist.wti.com"
cpm_username: "super"
cpm_password: "super"
use_https: true
validate_certs: false
date: "12/12/2019"
time: "09:23:46"
timezone: 5
# Enable NTP and set primary and seconday servers of a WTI device
- name: Set NTP primary and seconday servers of a WTI device
cpm_time_config:
cpm_url: "nonexist.wti.com"
cpm_username: "super"
cpm_password: "super"
use_https: true
validate_certs: false
timezone: 5
ntpenable: 1
ipv4address: "129.6.15.28.pool.ntp.org"
timeout: 15
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
data complex |
always |
The output JSON returned from the commands sent
| |
date string |
success |
Current Date of the WTI device after module execution.
Sample: 11/14/2019 | |
ntp dictionary |
always |
Current k/v pairs of ntp info of the WTI device after module execution.
Sample: {'enable': '0', 'ietf-ipv4': {'address': [{'primary': '192.168.0.169', 'secondary': '12.34.56.78'}]}, 'ietf-ipv6': {'address': [{'primary': , 'secondary': }]}, 'timeout': '4'} | |
time string |
success |
Current Time of the WTI device after module execution.
Sample: 12:12:00 | |
timezone integer |
success |
Current Timezone of the WTI device after module execution.
Sample: 5 |
Authors
- Western Telematic Inc. (@wtinetworkgear)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/wti/remote/cpm_time_config_module.html