mellanox.onyx.onyx_ptp_global – Configures PTP Global parameters

From Get docs
Ansible/docs/2.11/collections/mellanox/onyx/onyx ptp global module


mellanox.onyx.onyx_ptp_global – Configures PTP Global parameters

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


Synopsis

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

Parameters

Parameter Choices/Defaults Comments

domain

string

set PTP domain number Range 0-127

ntp_state

string

  • enabled
  • disabled

NTP state.

primary_priority

string

set PTP primary priority Range 0-225

ptp_state

string

  • enabled

  • disabled

PTP state.

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

commands

list / elements=string

always

The list of configuration mode commands to send to the device.


Sample:

['no ntp enable', 'protocol ptp', 'ptp domain 127']




Authors

  • Anas Badaha (@anasb)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/mellanox/onyx/onyx_ptp_global_module.html