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).

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 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

Comments

authenticate_state

string

State of the NTP authentication configuration.

Choices:

  • enabled

  • disabled

ntp_authentication_keys

list / elements=string

List of ntp authentication keys

auth_key_encrypt_type

string / required

encryption type used to configure ntp authentication key.

Choices:

  • md5

  • sha1

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

Used to decide if you want to delete given ntp key or not

Choices:

  • present

  • absent

state

string

State of the NTP configuration.

Choices:

  • enabled

  • disabled

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device

Returned: always.

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)