mellanox.onyx.onyx_ptp_interface – Configures PTP on interface

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

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
announce_interval string		configure PTP announce setting for interval, Range -3-1
announce_timeout string		configure PTP announce setting for timeout, Range 2-10
delay_request string		configure PTP delay request interval, Range 0-5
name string / required		ethernet or vlan interface name that we want to configure PTP on it
state string	Choices: enabled ← disabled	Enable/Disable PTP on Interface
sync_interval string		configure PTP sync interval, Range -7--1

Notes

Note

Tested on ONYX 3.6.8130
PTP Protocol must be enabled on switch.
Interface must not be a switch port interface.

Examples

- name: Configure PTP interface
  onyx_ptp_interface:
    state: enabled
    name: Eth1/1
    delay_request: 0
    announce_interval: -2
    announce_timeout: 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: ['interface ethernet 1/16 ptp enable', 'interface ethernet 1/16 ptp delay-req interval 0', 'interface ethernet 1/16 ptp announce interval -1']

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/latest/collections/mellanox/onyx/onyx_ptp_interface_module.html