PTP

PTP (Precision Time Protocol) configuration manages IEEE 1588v2 clock synchronization on NX-OS devices. Settings include global clock properties (domain, priority, device type, source IP), convergence tuning, correction range thresholds, delay tolerance, multi-domain support, notifications, and per-interface PTP parameters (intervals, transport, transmission mode, role, unicast peers).

Diagram

Classes

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
ptp	Class	[ptp]	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
ptp	Class	[ptp]	No

port_channels (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
ptp	Class	[ptp]	No

ptp (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
domain	Integer	min: 0, max: 127	No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No
device_type	Choice	boundary-clock, generalized-ptp, ordinary-clock-grandmaster	No
source	IP		No
source_ipv6	IP		No
vrf	String		No
vrf_ipv6	String		No
offload	Boolean	true, false	No
clock_operation_one_step	Boolean	true, false	No
clock_identity	String		No
clock_periodic_update	Boolean	true, false	No
clock_periodic_update_interval	Integer	min: 0, max: 3600	No
clock_sync_auto	Boolean	true, false	No
using_system_clock	Boolean	true, false	No
management	Boolean	true, false	No
forward_version1	Boolean	true, false	No
scale_on_1g	Boolean	true, false	No
convergence_time	Integer	min: 3, max: 2600	No
correction_range	Integer	min: 10, max: 1000000000	No
correction_range_logging	Boolean	true, false	No
mean_path_delay	Integer	min: 10, max: 1000000000	No
delay_tolerance_mean_path	Boolean	true, false	No
delay_tolerance_mean_path_value	Integer	min: 0	No
delay_tolerance_reverse_path	Boolean	true, false	No
delay_tolerance_reverse_path_value	Integer	min: 0	No
pdelay_req_interval	Integer	min: 0, max: 5	No
grandmaster_capable	Boolean	true, false	No
grandmaster_capable_convergence_time	Integer	min: 3, max: 2600	No
multi_domain	Boolean	true, false	No
multi_domain_transition_attributes_priority1	Integer	min: 0, max: 255	No
multi_domain_transition_attributes_priority2	Integer	min: 0, max: 255	No
enhanced_client_scale	Boolean	true, false	No
acl_redirect	Boolean	true, false	No
ipv6_multicast_scope_tx	Integer	min: 0, max: 65535	No
ipv6_multicast_scope_rx	Integer	min: 0, max: 65535	No
notification_gm_change	Boolean	true, false	No
notification_parent_change	Boolean	true, false	No
notification_high_correction	Boolean	true, false	No
notification_high_correction_interval	Integer	min: 0, max: 300	No
notification_high_correction_periodic_notification	Boolean	true, false	No
notification_port_state_change	Boolean	true, false	No
notification_port_state_change_category	Choice	master-slave-only, all	No
notification_port_state_change_interval	Integer	min: 0, max: 300	No
notification_port_state_change_periodic_notification	Boolean	true, false	No
domains	List	[domains]	No

domains (nxos.devices.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
domain	Integer	min: 0, max: 127	Yes
clock_accuracy_threshold	Integer	min: 0, max: 255	No
clock_class_threshold	Integer	min: 0, max: 255	No
priority	Integer	min: 0, max: 255	No

ucast_peers (nxos.devices.configuration.interfaces.ethernets.ptp)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		Yes
transmission_unicast_negotiation_schema	String		No

Examples

Example 1: Basic PTP boundary clock

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          ptp: true
        ptp:
          domain: 0
          priority1: 128
          priority2: 128
          device_type: boundary-clock
          source: 10.0.0.1

Example 2: PTP with interface configuration and unicast peers

nxos:
  devices:
    - name: SPINE1
      configuration:
        feature:
          ptp: true
        ptp:
          domain: 0
          priority1: 100
          priority2: 128
          device_type: boundary-clock
          source: 10.0.0.1
          offload: true
          convergence_time: 60
          correction_range: 200000
          correction_range_logging: true
          mean_path_delay: 500000000
        interfaces:
          ethernets:
            - id: Eth1/1
              ptp:
                admin_state: true
                announce_interval: 2
                sync_interval: -1
                delay_request_minimum_interval: 0
                transport: ipv4
                transmission: multicast
                role: dynamic
            - id: Eth1/2
              ptp:
                admin_state: true
                transmission: unicast
                transport: ipv4
                ucast_source: 10.1.1.1
                ucast_peers:
                  - ip: 10.1.1.2
          port_channels:
            - id: 1
              ptp:
                admin_state: true
                transport: ipv4

Example 3: PTP with multi-domain and notifications

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          ptp: true
        ptp:
          domain: 0
          device_type: generalized-ptp
          multi_domain: true
          multi_domain_transition_attributes_priority1: 128
          multi_domain_transition_attributes_priority2: 128
          grandmaster_capable: true
          notification_gm_change: true
          notification_parent_change: true
          notification_high_correction: true
          notification_high_correction_interval: 10
          notification_port_state_change: true
          notification_port_state_change_category: all
          domains:
            - domain: 0
              clock_accuracy_threshold: 200
              clock_class_threshold: 200
              priority: 128
            - domain: 1
              priority: 200