Docs4dev
Docs
ansible / 2.10 / collections / mellanox / onyx / onyx_ntp_module.html

mellanox.onyx.onyx_ntp – Manage NTP general configurations and ntp keys configurations on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

To install it use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_ntp.

New in version 0.2.0: of mellanox.onyx

Synopsis

  • This module provides declarative management of NTP & NTP Keys on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
authenticate_state
string
    Choices:
  • enabled
  • disabled
State of the NTP authentication configuration.
ntp_authentication_keys
list / elements=string
List of ntp authentication keys
auth_key_encrypt_type
string / required
    Choices:
  • md5
  • sha1
encryption type used to configure ntp authentication key.
auth_key_id
integer / required
Configures ntp key-id, range 1-65534
auth_key_password
string / required
password used for ntp authentication key.
auth_key_state
string
    Choices:
  • present
  • absent
Used to decide if you want to delete given ntp key or not
state
string
    Choices:
  • enabled
  • disabled
State of the NTP configuration.
trusted_keys
list / elements=string
List of ntp trusted keys

Examples

- name: Configure NTP
  onyx_ntp:
    state: enabled
    authenticate_state: enabled
    ntp_authentication_keys:
            - auth_key_id: 1
              auth_key_encrypt_type: md5
              auth_key_password: 12345
              auth_key_state: absent
    trusted_keys: 1,2,3

Return Values

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

Key Returned Description
commands
list / elements=string
always.
The list of configuration mode commands to send to the device

Sample:
['ntp enable', 'ntp disable', 'ntp authenticate', 'no ntp authenticate', 'ntp authentication-key 1 md5 12345', 'no ntp authentication-key 1', 'ntp trusted-key 1,2,3']


Authors

  • Sara-Touqan (@sarato)

© 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/mellanox/onyx/onyx_ntp_module.html