PTP

Precision Time Protocol (PTP), defined by IEEE 1588, synchronizes real-time clocks across network devices to nanosecond accuracy using a grandmaster-boundary-ordinary clock hierarchy with continuously exchanged timing messages. IOS-XR PTP supports ITU-T telecom profiles (G.8265.1, G.8275.1, G.8275.2), per-interface and global profile assignment, unicast/multicast transport modes, master/slave peer management, interop domain conversions, and UTC leap-second offset scheduling.

Diagram

Classes

iosxr

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No

devices (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
ptp	Class	ptp	No

ptp (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
apts	Boolean	true, false	No
clock	Class	clock	No
detect_ptsf_unusable	Boolean	true, false	No
double_failure_clock_class	Integer	min: 0, max: 255	No
freerun_clock_class	Integer	min: 0, max: 255	No
frequency_priority	Integer		No
holdover_spec_clock_class	Integer	min: 0, max: 255	No
holdover_spec_duration	Integer		No
holdover_spec_traceable_override	Boolean	true, false	No
ipv6_verify_checksum	Boolean	true, false	No
log_best_primary_clock_changes	Boolean	true, false	No
log_servo_events	Boolean	true, false	No
min_clock_class	Integer	min: 0, max: 255	No
network_type_high_pdv	Boolean	true, false	No
performance_monitoring	Boolean	true, false	No
phase_difference_threshold_breach	Integer		No
physical_layer_frequency	Boolean	true, false	No
profiles	List	profiles	No
servo_slow_tracking	Integer		No
startup_clock_class	Integer	min: 0, max: 255	No
time_of_day_priority	Integer		No
transparent_clock_domain_all	Boolean	true, false	No
uncalibrated_clock_class	Integer	min: 0, max: 255	No
uncalibrated_traceable_override	Boolean	true, false	No
uncalibrated_unless_from_holdover	Boolean	true, false	No
utc_offset_baseline	Integer		No
utc_offsets	List	utc_offsets	No
virtual_port	Class	virtual_port	No

clock (iosxr.devices.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
clock_class	Integer	min: 0, max: 255	No
domain	Integer	min: 0, max: 255	No
identity_eui_64	String		No
identity_mac	Any	String or Choice[router] or String[Regex: ^.*[\$\%]\{.*$]	No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No
profile	Choice	g-8265-1, g-8275-1, g-8275-2	No
profile_clock_type	Choice	primary, slave, t-bc, t-gm, t-tsc	Yes
time_source	Choice	atomic-clock, gps, terrestrial-radio, ptp, ntp, hand-set, other, internal-oscillator	No
timescale	Choice	ptp, arb	No

profiles (iosxr.devices.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
announce_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
announce_grant_duration	Integer	min: 60, max: 1000	No
announce_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
announce_timeout	Integer	min: 2, max: 10	No
clock_operation	Choice	one-step, two-step	No
cos	Integer	min: 0, max: 7	No
cos_event	Integer	min: 0, max: 7	No
cos_general	Integer	min: 0, max: 7	No
delay_asymmetry_unit	Choice	nanoseconds, microseconds, milliseconds	No
delay_asymmetry_value	Integer	min: -500000000, max: 500000000	No
delay_request_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
delay_request_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
delay_response_grant_duration	Integer	min: 60, max: 1000	No
delay_response_timeout	Integer	min: 100, max: 100000	No
dscp	Integer	min: 0, max: 63	No
dscp_event	Integer	min: 0, max: 63	No
dscp_general	Integer	min: 0, max: 63	No
interop	Class	interop	No
ipv4_ttl	Integer	min: 1, max: 255	No
ipv6_hop_limit	Integer	min: 1, max: 255	No
masters	List	masters	No
multicast	Choice	enable, disable, mixed	No
multicast_target_address	Choice	01-1B-19-00-00-00, 01-80-C2-00-00-0E	No
name	String		Yes
port_state	Choice	any, master-only, slave-only	No
slaves	List	slaves	No
source_ipv4_address	IP		No
source_ipv6_address	IP		No
sync_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
sync_grant_duration	Integer	min: 60, max: 1000	No
sync_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
sync_timeout	Integer	min: 100, max: 100000	No
transport	Choice	ethernet, ipv4, ipv6	No
unicast_grant_invalid_request	Choice	deny, reduce	No

utc_offsets (iosxr.devices.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
date	String		Yes
offset_value	Integer		Yes

virtual_port (iosxr.devices.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
clock_accuracy	Integer		No
clock_class	Integer		No
enable	Boolean	true, false	No
gm_threshold_breach	Integer		No
local_priority	Integer		No
offset_scaled_log_variance	Integer		No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No

interop (iosxr.devices.configuration.ptp.profiles)

Name	Type	Constraint	Mandatory	Default Value
domain	Integer	min: 0, max: 255	No
egress_conversion	Class	egress_conversion	No
ingress_conversion	Class	ingress_conversion	No
profile	Choice	default, g-8265-1, g-8275-1, g-8275-2	No

masters (iosxr.devices.configuration.ptp.profiles)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
clock_class	Integer	min: 0, max: 255	No
delay_asymmetry_unit	Choice	nanoseconds, microseconds, milliseconds	No
delay_asymmetry_value	Integer	min: -500000000, max: 500000000	No
multicast	Choice	enable, mixed	No
non_negotiated	Boolean	true, false	No
priority	Integer	min: 0, max: 255	No

slaves (iosxr.devices.configuration.ptp.profiles)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
non_negotiated	Boolean	true, false	Yes

egress_conversion (iosxr.devices.configuration.ptp.profiles.interop)

Name	Type	Constraint	Mandatory	Default Value
clock_accuracy	Integer	min: 0, max: 254	No
clock_class_default	Integer	min: 0, max: 255	No
clock_class_mappings	List	clock_class_mappings	No
offset_scaled_log_variance	Integer	min: 0, max: 65535	No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No

ingress_conversion (iosxr.devices.configuration.ptp.profiles.interop)

Name	Type	Constraint	Mandatory	Default Value
clock_accuracy	Integer	min: 0, max: 254	No
clock_class_default	Integer	min: 0, max: 255	No
clock_class_mappings	List	clock_class_mappings	No
offset_scaled_log_variance	Integer	min: 0, max: 65535	No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No

clock_class_mappings (iosxr.devices.configuration.ptp.profiles.interop.egress_conversion)

Name	Type	Constraint	Mandatory	Default Value
class_from	Integer	min: 0, max: 255	Yes
class_to	Integer	min: 0, max: 255	Yes

Data Normalization

MAC Address Formats

The following attributes accept MAC addresses in any of three formats:

• PTP Master/Slave addresses
• PTP Clock idenfity

1. colon-separated (e.g., "aa:bb:cc:dd:ee:ff")
2. dash-separated (e.g., "aa-bb-cc-dd-ee-ff")
3. dotted (e.g., "aabb.ccdd.eeff")

All 3 formats can be used interchangeably. The normalization layer converts the user-specified format to colon-separated before sending to the device.

Address Selection

Master and slave peer lists accept IPv4, IPv6, and MAC addresses in a single masters: or slaves: list. The address type is automatically detected:

• IPv4: dotted-decimal notation (e.g., 10.3.3.3)
• IPv6: colon-hex notation (e.g., 2001:db8::3)
• MAC: colon, dash, or dotted format (e.g., aa:bb:cc:dd:ee:f4, aa-bb-cc-dd-ee-ff, aabb.ccdd.eeff)

Example YAML Code

Example-1: Global PTP with clock profile g-8275-1 and virtual port.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        ptp:
          min_clock_class: 128
          frequency_priority: 10
          time_of_day_priority: 10
          physical_layer_frequency: true
          log_best_primary_clock_changes: true
          log_servo_events: true
          clock:
            domain: 24
            priority1: 128
            priority2: 128
            profile: g-8275-1
            profile_clock_type: t-bc
            timescale: ptp
            time_source: gps
            identity_mac: router
          virtual_port:
            priority1: 128
            priority2: 129
            clock_class: 6

Example-2: PTP profile with ethernet transport, masters, and slaves.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        ptp:
          profiles:
            - name: PROFILE-1
              transport: ethernet
              port_state: master-only
              clock_operation: one-step
              multicast: mixed
              cos: 6
              sync_interval: 2
              announce_interval: 2
              announce_timeout: 5
              delay_request_interval: 2
              masters:
                - address: 10.3.3.3
                  priority: 100
                  non_negotiated: true
                  multicast: enable
                - address: "aa:bb:cc:dd:ee:f4"
                  priority: 100
                  multicast: enable
              slaves:
                - address: 10.2.2.2
                  non_negotiated: true

Example-3: PTP profile with interop conversions and delay asymmetry.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        ptp:
          profiles:
            - name: INTEROP
              transport: ipv4
              source_ipv4_address: 10.1.1.1
              delay_asymmetry_value: 1000
              delay_asymmetry_unit: microseconds
              interop:
                domain: 24
                profile: g-8275-2
                egress_conversion:
                  priority1: 128
                  priority2: 128
                  clock_accuracy: 33
                  clock_class_default: 6
                  clock_class_mappings:
                    - class_from: 6
                      class_to: 13
                ingress_conversion:
                  priority1: 128
                  priority2: 128
                  clock_accuracy: 33
                  clock_class_default: 6