Docs4dev
Docs
ansible / 2.4 / bigip_device_ntp_module.html

bigip_device_ntp - Manage NTP servers on a BIG-IP

New in version 2.2.

Synopsis

  • Manage NTP servers on a BIG-IP

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
ntp_servers
 no
A list of NTP servers to set on the device. At least one of ntp_servers or timezone is required.
password
 yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
server
 yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
state
 no present
  • absent
  • present
The state of the NTP servers on the system. When present, guarantees that the NTP servers are set on the system. When absent, removes the specified NTP servers from the device configuration.
timezone
 no UTC
The timezone to set for NTP lookups. At least one of ntp_servers or timezone is required.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

Examples

- name: Set NTP server
  bigip_device_ntp:
      ntp_servers:
          - "192.0.2.23"
      password: "secret"
      server: "lb.mydomain.com"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

- name: Set timezone
  bigip_device_ntp:
      password: "secret"
      server: "lb.mydomain.com"
      timezone: "America/Los_Angeles"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Return Values

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

name description returned type sample
ntp_servers
The NTP servers that were set on the device
changed list ['192.0.2.23', '192.0.2.42']
timezone
The timezone that was set on the device
changed string true

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_device_ntp_module.html