Skip to content

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). The global ttag marker interval used for PTP-based latency measurement (ttag-marker-interval) is configured under system.

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

NameTypeConstraintMandatoryDefault Value
devicesListdevicesNo
device_groupsListdevice_groupsNo
globalClassglobalNo
templatesListtemplatesNo
interface_groupsListinterface_groupsNo

NameTypeConstraintMandatoryDefault Value
devicesListdevicesNo
device_groupsListdevice_groupsNo
globalClassglobalNo
templatesListtemplatesNo

NameTypeConstraintMandatoryDefault Value
configurationClassconfigurationNo

NameTypeConstraintMandatoryDefault Value
configurationClassconfigurationNo

NameTypeConstraintMandatoryDefault Value
configurationClassconfigurationNo

NameTypeConstraintMandatoryDefault Value
configurationClassconfigurationNo

NameTypeConstraintMandatoryDefault Value
configurationClassconfigurationNo

NameTypeConstraintMandatoryDefault Value
interfacesClassinterfacesNo
systemClasssystemNo
ptpClassptpNo

NameTypeConstraintMandatoryDefault Value
interfacesClassinterfacesNo
ptpClassptpNo

NameTypeConstraintMandatoryDefault Value
ethernetsListethernetsNo
port_channelsListport_channelsNo

ethernets (nxos.devices.configuration.interfaces)

Section titled “ethernets (nxos.devices.configuration.interfaces)”
NameTypeConstraintMandatoryDefault Value
ptpClassptpNo

port_channels (nxos.devices.configuration.interfaces)

Section titled “port_channels (nxos.devices.configuration.interfaces)”
NameTypeConstraintMandatoryDefault Value
ptpClassptpNo

NameTypeConstraintMandatoryDefault Value
ttag_marker_intervalIntegermin: 1, max: 25200No

NameTypeConstraintMandatoryDefault Value
ptpClassptpNo

NameTypeConstraintMandatoryDefault Value
domainIntegermin: 0, max: 127No
priority1Integermin: 0, max: 255No
priority2Integermin: 0, max: 255No
device_typeChoiceboundary-clock, generalized-ptp, ordinary-clock-grandmasterNo
sourceIPNo
source_ipv6IPNo
vrfStringNo
vrf_ipv6StringNo
offloadBooleantrue, falseNo
clock_operation_one_stepBooleantrue, falseNo
clock_identityStringNo
clock_periodic_updateBooleantrue, falseNo
clock_periodic_update_intervalIntegermin: 0, max: 3600No
clock_sync_autoBooleantrue, falseNo
using_system_clockBooleantrue, falseNo
managementBooleantrue, falseNo
forward_version1Booleantrue, falseNo
scale_on_1gBooleantrue, falseNo
convergence_timeIntegermin: 3, max: 2600No
correction_rangeIntegermin: 10, max: 1000000000No
correction_range_loggingBooleantrue, falseNo
mean_path_delayIntegermin: 10, max: 1000000000No
delay_tolerance_mean_pathBooleantrue, falseNo
delay_tolerance_mean_path_valueIntegermin: 0No
delay_tolerance_reverse_pathBooleantrue, falseNo
delay_tolerance_reverse_path_valueIntegermin: 0No
pdelay_req_intervalIntegermin: 0, max: 5No
grandmaster_capableBooleantrue, falseNo
grandmaster_capable_convergence_timeIntegermin: 3, max: 2600No
multi_domainBooleantrue, falseNo
multi_domain_transition_attributes_priority1Integermin: 0, max: 255No
multi_domain_transition_attributes_priority2Integermin: 0, max: 255No
enhanced_client_scaleBooleantrue, falseNo
acl_redirectBooleantrue, falseNo
ipv6_multicast_scope_txIntegermin: 0, max: 65535No
ipv6_multicast_scope_rxClassipv6_multicast_scope_rxNo
notification_gm_changeBooleantrue, falseNo
notification_parent_changeBooleantrue, falseNo
notification_high_correctionBooleantrue, falseNo
notification_high_correction_intervalIntegermin: 0, max: 300No
notification_high_correction_periodic_notificationBooleantrue, falseNo
notification_port_state_changeBooleantrue, falseNo
notification_port_state_change_categoryChoicemaster-slave-only, allNo
notification_port_state_change_intervalIntegermin: 0, max: 300No
notification_port_state_change_periodic_notificationBooleantrue, falseNo
domainsListdomainsNo

NameTypeConstraintMandatoryDefault Value
domainIntegermin: 0, max: 127No
priority1Integermin: 0, max: 255No
priority2Integermin: 0, max: 255No
device_typeChoiceboundary-clock, generalized-ptp, ordinary-clock-grandmasterNo
sourceIPNo
source_ipv6IPNo
vrfStringNo
vrf_ipv6StringNo
offloadBooleantrue, falseNo
clock_operation_one_stepBooleantrue, falseNo
clock_identityStringNo
clock_periodic_updateBooleantrue, falseNo
clock_periodic_update_intervalIntegermin: 0, max: 3600No
clock_sync_autoBooleantrue, falseNo
using_system_clockBooleantrue, falseNo
managementBooleantrue, falseNo
forward_version1Booleantrue, falseNo
scale_on_1gBooleantrue, falseNo
convergence_timeIntegermin: 3, max: 2600No
correction_rangeIntegermin: 10, max: 1000000000No
correction_range_loggingBooleantrue, falseNo
mean_path_delayIntegermin: 10, max: 1000000000No
delay_tolerance_mean_pathBooleantrue, falseNo
delay_tolerance_mean_path_valueIntegermin: 0No
delay_tolerance_reverse_pathBooleantrue, falseNo
delay_tolerance_reverse_path_valueIntegermin: 0No
pdelay_req_intervalIntegermin: 0, max: 5No
grandmaster_capableBooleantrue, falseNo
grandmaster_capable_convergence_timeIntegermin: 3, max: 2600No
multi_domainBooleantrue, falseNo
multi_domain_transition_attributes_priority1Integermin: 0, max: 255No
multi_domain_transition_attributes_priority2Integermin: 0, max: 255No
enhanced_client_scaleBooleantrue, falseNo
acl_redirectBooleantrue, falseNo
ipv6_multicast_scope_txIntegermin: 0, max: 65535No
ipv6_multicast_scope_rxIntegermin: 0, max: 65535No
notification_gm_changeBooleantrue, falseNo
notification_parent_changeBooleantrue, falseNo
notification_high_correctionBooleantrue, falseNo
notification_high_correction_intervalIntegermin: 0, max: 300No
notification_high_correction_periodic_notificationBooleantrue, falseNo
notification_port_state_changeBooleantrue, falseNo
notification_port_state_change_categoryChoicemaster-slave-only, allNo
notification_port_state_change_intervalIntegermin: 0, max: 300No
notification_port_state_change_periodic_notificationBooleantrue, falseNo
domainsListdomainsNo

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

Section titled “ptp (nxos.devices.configuration.interfaces.ethernets)”
NameTypeConstraintMandatoryDefault Value
admin_stateBooleantrue, falseNo
announce_intervalIntegermin: -3, max: 4No
announce_interval_profileChoicenone, aes67, smpte-2059-2No
announce_timeoutIntegermin: 2, max: 10No
announce_timeout_profileChoicenone, aes67, smpte-2059-2No
sync_intervalIntegermin: -7, max: 1No
sync_interval_profileChoicenone, aes67, smpte-2059-2No
delay_request_minimum_intervalIntegermin: -4, max: 6No
delay_request_minimum_interval_profileChoicenone, aes67, smpte-2059-2No
transmissionChoicemulticast, unicastNo
transportChoiceipv4, ipv6, ethernetNo
roleChoicemaster, slave, dynamicNo
costIntegermin: 0, max: 255No
vlanIntegermin: 1, max: 4094No
domainIntegermin: 0, max: 127No
profile_overrideBooleantrue, falseNo
destination_macChoiceforwardable, non-forwardableNo
receive_no_matchChoiceaccept, drop, follow-rxNo
transmission_unicast_negotiation_schemaStringNo
neighbor_propagation_delay_thresholdIntegermin: 5, max: 2000000No
asymmetric_delay_valueIntegermin: 0, max: 512000000No
asymmetric_delay_directionChoicenone, forward-path, reverse-pathNo
ucast_sourceIPNo
ucast_source_ipv6IPNo
ucast_source_vrfStringNo
ucast_source_vrf_ipv6StringNo
ipv6_multicast_scope_txIntegermin: 0, max: 65535No
ipv6_multicast_scope_rxClassipv6_multicast_scope_rxNo
ucast_peersListucast_peersNo

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

Section titled “ptp (nxos.devices.configuration.interfaces.ethernets)”
NameTypeConstraintMandatoryDefault Value
admin_stateBooleantrue, falseNo
announce_intervalIntegermin: -3, max: 4No
announce_interval_profileChoicenone, aes67, smpte-2059-2No
announce_timeoutIntegermin: 2, max: 10No
announce_timeout_profileChoicenone, aes67, smpte-2059-2No
sync_intervalIntegermin: -7, max: 1No
sync_interval_profileChoicenone, aes67, smpte-2059-2No
delay_request_minimum_intervalIntegermin: -4, max: 6No
delay_request_minimum_interval_profileChoicenone, aes67, smpte-2059-2No
transmissionChoicemulticast, unicastNo
transportChoiceipv4, ipv6, ethernetNo
roleChoicemaster, slave, dynamicNo
costIntegermin: 0, max: 255No
vlanIntegermin: 1, max: 4094No
domainIntegermin: 0, max: 127No
profile_overrideBooleantrue, falseNo
destination_macChoiceforwardable, non-forwardableNo
receive_no_matchChoiceaccept, drop, follow-rxNo
transmission_unicast_negotiation_schemaStringNo
neighbor_propagation_delay_thresholdIntegermin: 5, max: 2000000No
asymmetric_delay_valueIntegermin: 0, max: 512000000No
asymmetric_delay_directionChoicenone, forward-path, reverse-pathNo
ucast_sourceIPNo
ucast_source_ipv6IPNo
ucast_source_vrfStringNo
ucast_source_vrf_ipv6StringNo
ipv6_multicast_scope_txIntegermin: 0, max: 65535No
ipv6_multicast_scope_rxIntegermin: 0, max: 65535No
ucast_peersListucast_peersNo

ipv6_multicast_scope_rx (nxos.devices.configuration.ptp)

Section titled “ipv6_multicast_scope_rx (nxos.devices.configuration.ptp)”
NameTypeConstraintMandatoryDefault Value
idsListInteger[min: 1, max: 15]No
rangesListrangesNo

NameTypeConstraintMandatoryDefault Value
domainIntegermin: 0, max: 127Yes
clock_accuracy_thresholdIntegermin: 0, max: 255No
clock_class_thresholdIntegermin: 0, max: 255No
priorityIntegermin: 0, max: 255No

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

Section titled “ucast_peers (nxos.devices.configuration.interfaces.ethernets.ptp)”
NameTypeConstraintMandatoryDefault Value
ipIPYes
transmission_unicast_negotiation_schemaStringNo

ranges (nxos.devices.configuration.ptp.ipv6_multicast_scope_rx)

Section titled “ranges (nxos.devices.configuration.ptp.ipv6_multicast_scope_rx)”
NameTypeConstraintMandatoryDefault Value
fromIntegermin: 1, max: 15Yes
toIntegermin: 1, max: 15Yes

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

Example 4: PTP over IPv6 multicast with transmit scope and receive scope list (ipv6_multicast_scope_rx accepts single values (ids) and ranges of scope values 1-15, e.g. 1-5,8,10-14 below)

nxos:
devices:
- name: LEAF1
configuration:
feature:
ptp: true
ptp:
domain: 0
ipv6_multicast_scope_tx: 2
ipv6_multicast_scope_rx:
ids:
- 8
ranges:
- from: 1
to: 5
- from: 10
to: 14
interfaces:
ethernets:
- id: Eth1/1
ptp:
admin_state: true
transport: ipv6
ipv6_multicast_scope_rx:
ids:
- 1
- 2

Example 5: PTP ttag global marker interval configuration

nxos:
devices:
- name: LEAF1
configuration:
system:
ttag_marker_interval: 120

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