mellanox.onyx.onyx_ptp_interface module – Configures PTP on interface
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_interface
.
Synopsis
This module provides declarative management of PTP interfaces configuration on Mellanox ONYX network devices.
Parameters
Parameter |
Comments |
---|---|
configure PTP announce setting for interval, Range -3-1 |
|
configure PTP announce setting for timeout, Range 2-10 |
|
configure PTP delay request interval, Range 0-5 |
|
ethernet or vlan interface name that we want to configure PTP on it |
|
Enable/Disable PTP on Interface Choices:
|
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device. Returned: always Sample: |