mellanox.onyx.onyx_ptp_global module – Configures PTP Global parameters

Note

This module 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_ptp_global.

Synopsis

  • This module provides declarative management of PTP Global configuration on Mellanox ONYX network devices.

Parameters

Parameter

Comments

domain

string

set PTP domain number Range 0-127

ntp_state

string

NTP state.

Choices:

  • "enabled"

  • "disabled"

primary_priority

string

set PTP primary priority Range 0-225

ptp_state

string

PTP state.

Choices:

  • "enabled" ← (default)

  • "disabled"

secondary_priority

string

set PTP secondary priority Range 0-225

Notes

Note

  • Tested on ONYX 3.6.8130 ptp and ntp protocols cannot be enabled at the same time

Examples

- name: Configure PTP
  onyx_ptp_global:
    ntp_state: enabled
    ptp_state: disabled
    domain: 127
    primary_priority: 128
    secondary_priority: 128

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: ["no ntp enable", "protocol ptp", "ptp domain 127"]

Authors

  • Anas Badaha (@anasb)