PTP Commands
This chapter describes the commands used for Precision Time Protocol (PTP):
1pps-out offset
Use this command to set 1PPS external interface output signal offset in nano seconds.
Use the no form of this command to set default value 0.
Command Syntax
1pps-out offset <-2048-2048>
no 1pps-out offset
Parameters
<-2048-2048>
Offset value in range. Default is 0
Command Mode
PTP Clock Mode
Default
Default offset value is Zero.
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#1pps-out offset 2048
announce-receipt-timeout
Use this command to set announce-receipt-timeout. Applicable for only G.8275.2, SMPTE and default profile and G 8265.1.
Use the no form of this command to set default value 3.
Command Syntax
announce-receipt-timeout <2-10>
no announce-receipt-timeout
Parameters
<2-10>
announceReceiptTimeout range (default is 3)
Command Mode
PTP Clock Port Mode
Default
Default offset value is Zero.
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#announce-receipt-timeout 3
clear ptp clock stats
Use this command to clear PTP packet statistics.
Command Syntax
clear ptp clock <0-1> stats
Parameters
<0-1>
Clock 0 or 1
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#clear ptp clock 0 stats
clock-accuracy
Use this command to indicate the expected accuracy of the clock.
Use the no form of this command in PTP Clock Mode to set the default value 254.
Use the no form of this command in PTP Clock Port Mode to set the default value 0x21.
Note: Applicable for Non-Ethernet ports for PTP Clock Port mode.
Command Syntax
clock-accuracy <0-255>
no clock-accuracy
Parameters
<0-255>
A number representing the expected clock accuracy.
Command Mode
PTP Clock Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-accuracy 10
(config-ptp-clk)#clock-port 1
(config-clk-port)#clock-accuracy 15
clock-class
Use this command to denote the traceability of the time or frequency distributed by the clock.
Use the no form of this command in PTP Clock Mode to set the default value 248.
Use the no form of this command in PTP Clock Port Mode to set the default value 6 for clock-port.
Note: Applicable for Non-Ethernet ports for PTP Clock Port mode.
Command Syntax
clock-class <0-255>
no clock-class
Parameters
<0-255>
A number representing the traceability of time or frequency of the clock.
Command Mode
PTP Clock Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-class 3
(config-ptp-clk)#clock-port 1
(config-clk-port)#clock-class 7
Clock-port
Use this command to enter PTP Clock Mode.
Use the no form of the command to remove the clock-port configuration.Command Syntax
clock-port <1-128>
no clock-port <1-128>
Parameters
<1-128> | Specifies the number of clock ports. |
Default
None
Command Mode
PTP Clock Mode
Applicability
Introduced in OcNOS version 3.0. The maximum number of port value is changed to 128 in OcNOS version 6.5.3
Example
Explain or describe the example.
#configure terminal
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 55
(config-clk-port)#
clock-type tgm
Use this command to make a clock a grandmaster clock.
Command Syntax
clock-type tgm
Parameters
None
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-type tgm
(config-ptp-clk)#number-ports 2
(config-ptp-clk)#clock-port 2
(config-clk-port)#master-only
(config-clk-port)#network-interface eth1
delay-asymmetry
Use this command to set asymmetric delay in nanoseconds. The value can be entered as milliseconds or nanoseconds.
Note: Entering a value in both milliseconds and nanoseconds will result in the sum of the two values being set.
Use the no form of this command to set default value 0.
Command Syntax
delay-asymmetry {msec <-100-100>|nsec <-1000000-1000000>}
no delay-asymmetry
Parameters
msec <-100-100>
Value of latency in milliseconds.
nsec <-1000000-1000000>
Value of latency in nanoseconds.
Command Mode
PTP Clock Port mode
Applicability
This command introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#delay-asymmetry msec 100 nsec 1000000
description
Use this command to set description for clock port.
Use the no form of this command to delete this description.
Command Syntax
description LINE
no description
Parameters
LINE
Clock port description.
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#description l3
domain
Use this command to set the current synchronization domain:
• For G.8275.1, domain numbers are in the range of 24 - 43 and the default is 24.
• For G.8275.2, domain numbers are in the range of 44 - 63 and the default is 44.
• For the default profile, domain numbers are in the range of 0-127.
• For G 8265.1, domain numbers are in the range of 4-23.
Command Syntax
domain <0-127>
no domain
Parameters
<0-127>
Synchronization domain.
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#configure terminal
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#domain 30
dscp
Use this command to set DSCP value. Applicable for G.8275.2 profile, G 8265.1, SMPTE, and default profile.
Use the no form of this command to set default value 56.
Command Syntax
dscp <0-63>
no dscp
Parameters
<0-63>
DSCP value (default is 56)
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#dscp 2
g8265.1-option
Use this command to set G 8265.1 option1 or 2. Applicable for G.8265.1. Default is option1.
Use the no form of this command to set default value option1.
Command Syntax
g8265.1-option (1|2)
no g8265.1-option
Parameters
1
Set network option 1
2
Set network option 2
Command Mode
PTP Clock mode
Applicability
This command introduced in OcNOS version 4.2.
Example
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#g8265.1-option 2
g8265.1-wtr
Use this command to set G 8265.1 wtr duration. Applicable for G.8265.1. Default is 0.
Use the no form of this command to set default value 0.
Command Syntax
g8265.1-wtr DURATION
no g8265.1-wtr
Parameters
DURATION
Duration value of g8265 WTR master in sec
Command Mode
PTP Clock mode
Applicability
This command introduced in OcNOS version 4.2.
Example
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#g8265.1-wtr 60
gps-offset
Use this command to set GPS offset in nanoseconds and seconds.
Use the no form of this command to set default value 0 nanoseconds.
Command Syntax
gps-offset (sec <-100-100> | nsec <-2048-2048>)
no gps-offset
Parameters
sec <-100-100>
Offset value in seconds.
nsec<-2048-2048>
Offset value in nanoseconds.
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#gps-offset sec 100 nsec 2048
gps position
Use this command to enable survey-in, fixed, and disable mode.
Use the no form of this command to set to default.
Command Syntax
gps position (survey-in <1-1440> <1-10000> | fixed LATITUDE LONGITUDE ALTITUDE |disable)
no gps position
Parameters
survey-in
Mode as survey-in
<1-1440>
Minimum duration in minutes
<1-10000>
Position accuracy limit in centimeters
fixed
Mode as fixed
LATITUDE
GPS fixed latitude in decimal degree format
LONGITUDE
GPS fixed longitude in decimal degree format
ALTITUDE
GPS fixed altitude in meters
disable
Disable position
Command Mode
Configuration mode
Applicability
This command was introduced in OcNOS version 5.1.
Example
For survey-in:
(config)#gps position survey-in 30 1000
For fixed:
(config)#gps position fixed 12.975516 77.712692 919.1
For disable:
(config)#gps position disable
For the no command:
(config)#no gps position
gps satellite-system
Use this command to configure the global navigation satellite system (GNSS). GNSS satellites transmit the navigation and timing data to the GNSS receivers.
Use the no form of this command to unset the configured GNSS.
UBLOX NEO-M8T is a GNSS timing module that receives the signals from the GNSS. The platforms with UBLOX NEO-M8T support the below concurrent GNSS combinations:
Table 1-1: UBLOX neo-m8t supported GNSS combination
GPS | Galileo | GLONASS | BeiDou |
|---|
Yes | Yes | No | No |
Yes | Yes | Yes | No |
Yes | Yes | No | Yes |
Yes | No | Yes | No |
Yes | No | No | Yes |
No | Yes | Yes | No |
No | Yes | No | Yes |
No | No | Yes | Yes |
Command Syntax
gps satellite-system {gps|galileo|glonass|beidou}
no gps satellite-system {gps|galileo|glonass|beidou}
Parameters
gps | Global Positioning System is a satellite based navigation system. |
galileo | Galileo is a satellite based navigation system. |
glonass | GLONASS is a satellite based navigation system. |
beidou | BEIDOU is a satellite based navigation system. |
Default
None
Command Mode
Configuration mode
Applicability
Introduced in OcNOS version 6.5.2 and is applicable for UfiSpace Qumran2 series platforms and Qumran-UX series platforms.
Example
The below example shows how to configure the GNSS:
OcNOS(config)#gps satellite-system gps galileo
OcNOS(config)#gps satellite-system glonass
OcNOS(config)#no gps satellite-system gps galileo
OcNOS(config)#no gps satellite-system glonass
grandmaster-priority2
Use this command to set grandmaster-priority2 for virtual-clock-port. Applicable for g.8275.1 profile. Not applicable to Ethernet interfaces.
Use the no form of this command to set priority2 default value 128.
Command Syntax
grandmaster-priority2 <0-255>
no grandmaster-priority2
Parameters
<0-255>
Priority range
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#grandmaster-priority2 2
holdover
Use this command to enable holdover.
Use the no form of this command to set default duration 120.
Command Syntax
holdover <0-10080>
no holdover
Parameters
<0-10080>
Range of holdover in minutes.
Command Mode
PTP Clock Mode
Default
Default holdover minutes is 120.
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#holdover 15
local-priority (ptp-clk mode)
Use this command to specify the local attribute of the local clock.
Use the no form of this command to set default value 128.
Note: Not supported for default profile.
Command Syntax
local-priority <1-255>
no local-priority
Parameters
<1-255>
A numerical value specifying the local priority
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#local-priority 100
local-priority (ptp-clk-port mode)
Use this command to specify the local attribute of the local clock.
Use the no form of this command to set default value 128.
Command Syntax
local-priority <1-255>
no local-priority
Parameters
<1-255>
Local priority
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 5
(config-clk-port)#local-priority 50
log-announce-interval
Use this command to set log-announce-interval. Applicable for only G.8275.2 profile, G 8265.1, SMPTE and default profile.
Use the no form of this command to set default value:
• -3 for G 8275.2 profile
• 1 for default profile
• 1 for G 8265.1 profile
Command Syntax
log-announce-interval <-3-4>
no log-announce-interval
Parameters
<-3-4>
log-announce-interval range:
-3 to 3 for g8275.2
0 to 4 for default profile
-3 to 4 for g8265.1
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-announce-interval -2
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-announce-interval 2
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-announce-interval 2
log-min-delay-req-interval
Use this command to set log-min-delay-req-interval. Applicable for only G.8275.2 profile, G 8265.1, SMPTE, and default profile.
Use the no form of this command to set default value:
• -6 for g8275.2 profile
• 0 for default profile
• 5 for G 8265.1 profile
Command Syntax
log-min-delay-req-interval <-7-5>
no log-min-delay-req-interval
Parameters
<-7-5>
log-min-delay-req-interval range:
-7 to 0 or g8275.2
0 to 5 for default profile
-7 to 4 for g8265.1
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-min-delay-req-interval -5
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-min-delay-req-interval 5
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-min-delay-req-interval 4
log-sync-interval
Use this command to set log-sync-interval. Applicable for only G.8275.2 profile, G 8265.1 profile, and default profile.
Use the no form of this command to set default value:
• -6 for g8275.2 profile
• 0 for default profile
• -5 for G 8265.1 profile
Command Syntax
log-sync-interval <-7-1>
no log-sync-interval
Parameters
<-7-1>
log-sync-interval range:
-7 to 0 for g8275.2
-1 to 1 for default profile
-7 to 4 for g8265.1
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-sync-interval -4
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-sync-interval -1
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#log-sync-interval -1
master
Use this command to configure master IPv4 and IPv6 address. Applicable for g.8275.2 profile, G 8265.1 profile, SMPTE, and default profile.
Use the no form of this command to delete master address.
Note: Priority is applicable for G 8265.1 profile only.
Command Syntax
master (ipv4 A.B.C.D|ipv6 X:X::X:X) (priority PRIORITY|)
no master (ipv4 A.B.C.D|ipv6 X:X::X:X)
Parameters
A.B.C.D
Master IPv4 address
X:X::X:X
Master IPv6 address
PRIORITY
Priority value of master (Default is 0)
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv4
(config-clk-port)#master ipv4 10.1.1.2
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv4
(config-clk-port)#master ipv4 10.1.1.2
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv4
(config-clk-port)#master ipv4 10.1.1.2 priority 1
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv4
(config-clk-port)#master ipv4 10.1.1.2
master-only
Use this command to set a port to a master-only port.
Use the no form of this command to delete this configuration.
Command Syntax
master-only
no master-only
Parameters
None
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 10
(config-clk-port)#master-only
max-steps-removed
Use this command to specify the maximum number of communication paths between the local clock and the grandmaster clock.
Use the no form of this command to set default value 255.
Command Syntax
max-steps-removed <1-255>
no max-steps-removed
Parameters
<1-255>
Number of communication links between the local clock and the grandmaster clock.
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#max-steps-removed 10
network-interface
Use this command to reference the configured underlying interface that is used by this PTP Port.
Use the no form of this command to delete network-interface.
Command Syntax
network-interface IFNAME
network-interface IFNAME vlan VLAN_ID
network-interface IFNAME port IFNAME
network-interface(gps|prc)
no network-interface
Parameters
IFNAME
The name of a physical interface
VLAN_ID
VLAN ID <1-4094> applicable for g8275.1 profile
gps
GPS interface
prc
SMA/SMB or external interfaces
Command Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface xe2
(config-clk-port)#exit
(config-ptp-clk)#clock-port 2
(config-clk-port)#network-interface xe3 vlan 2
(config-clk-port)#exit
(config-ptp-clk)#clock-port 3
(config-clk-port)#network-interface gps
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface vlan1.2 port xe1
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface vlan1.2 port xe1
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface vlan1.2 port xe1
number-ports
Use this command to set the number of PTP ports on the instance. If the number of ports is larger than one, the clock is configured as a boundary clock, otherwise it's an ordinary clock.
Use the no form of this command to set default value 1.
Command Syntax
number-ports <1-128>
no number-ports
Parameters
<1-128>
Number of PTP ports on this instance.
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#number-ports 3
offset-log-variance
Use the command to specify an offset variance. The offset (scaled logarithmic variance) provides an estimate of the variations of the clock from a linear time scale when it is not synchronized to another clock using the PTP protocol.
Use the no form of this command in PTP Clock Mode to set the default value 65535.
Use the no form of this command in PTP Clock Port Mode to set the default value 0x4E5D for clock-port.
Note: Applicable for Non-Ethernet ports for PTP Clock Port mode.
Command Syntax
offset-log-variance <0-65535>
no offset-log-variance
Parameters
<0-65535>
The offset variance when not synchronized.
Command Mode
PTP Clock Mode
PTP Clock Port Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#offset-log-variance 3000
(config-ptp-clk)#clock-port 1
(config-clk-port)#offset-log-variance 2000
one-way
Use this command to set G 8265.1 one-way. Applicable for G.8265.1. Default is two-way.
Use the no form of this command to set default value.
Command Syntax
one-way
Parameters
None
Command Mode
PTP Clock mode
Applicability
This command was introduced in OcNOS version 4.2.
Example
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#one-way
priority1
Use this command to set the Priority1 attribute of the local clock (as specified in the IEEE-1588 standard). This command applicable only for Default and SMPTE profiles.
Use the no form of this command to set default value 128.
Command Syntax
priority1 <0-255>
no priority1
Parameters
<0-255>
The Priority1 attribute of the local clock.
Default
None
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 6.4.2
Example
Following is an example to execute the CLI.
#configure terminal
(config)#ptp clock 0 profile smpte (config-ptp-clk)#priority1 3
priority2
Use this command to set the Priority2 attribute of the local clock (as specified in the IEEE-1588 standard).
Use the no form of this command to set default value 128.
Command Syntax
priority2 <1-255>
no priority2
Parameters
<1-255>
The Priority2 attribute.
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#configure terminal
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#priority2 3
ptp clock profile
Use this command to enter PTP Clock Mode and to configure the G 8275.1, G 8275.2, default profile, and G 8265.1.
Use the no form of this command to delete PTP clock.
Note: For a single clock configuration, only clock 0 should be configured. Clock 1 is used only for the IWF use case.
Command Syntax
ptp clock <0-1> profile (g8275.1|g8275.2|default|g8265.1|smpte)
no ptp clock <0-1> profile
Parameters
<0-1>
Clock 0 or 1
g8275.1
PTP time/phase g8275.1 telecom profile
g8275.2
PTP time/phase g8275.2 telecom profile
default
PTP time/phase default profile
g8265.1
PTP frequency telecom profile
smpte
PTP SMPTE profile
Command Mode
Configure Mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)exit
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)exit
(config)#ptp clock 0 profile default
(config-ptp-clk)exit
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)exit
(config)#ptp clock 0 profile smpte
(config-ptp-clk)exit
ptp clock profile e2e-transparent
Use this command to configure PTP transparent clock profile.
Use the no form of this command to unconfigure PTP transparent clock profile.
Command Syntax
ptp clock 0 profile e2e-transparent
no ptp clock 0 profile
Parameters
None
Command Mode
Configure mode
Applicability
This command is introduced in OcNOS version 4.2.
Examples
(config)#ptp clock 0 profile e2e-transparent
(config)#no ptp clock 0 profile
ptp-clock-sync
Use this command to initialize the PTP clock from the operating system clock.
Use the no form of this command to disable ptp clock sync.
Command Syntax
ptp-clock-sync
no ptp-clock-sync
Parameters
None
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#ptp-clock-sync
(config)#
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#ptp-clock-sync
reserved-vlan-base-id
Use this command to set the Reserved VLAN base ID.
Use the no form of this command to set default base id 4064.
Command Syntax
reserved-vlan-base-id <2-4094>
no reserved-vlan-base-id
Parameters
<2-4094>
Base VLAN identifier range.
Command Mode
PTP Clock Mode
Default
Default VLAN base ID is 4064.
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#reserved-vlan-base-id 2
servo-history
Use this command to enable servo-history with specified interval.
Use the no form of this command to disable servo-history.
Command Syntax
servo-history <1-60>
no servo-history
Parameters
<1-60>
Enable servo-history in interval of <1-60> minutes (default is 15 minutes)
Command Mode
PTP Clock Mode
Default
Default interval value is 15 minutes.
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#servo-history 2
servo fts
Use this command to enable full time support with synce.
Use the no form of this command to disable servo FTS.
Note: This command is available for default and G.8275.2 profiles only.
Command Syntax
servo fts
no servo
Parameters
None
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#servo fts
(config)#ptp clock 0 profile default
(config-ptp-clk)#servo fts
show ptp clock
Use this command to display a summary of the Precision Time Protocol (PTP) clock status.
Note: The sm-tlv option applicable only for SMPTE profile.
Command Syntax
show ptp clock <0-1> ((dataset (default|current|parent|time-properties|)|)| (sm-tlv))
Parameters
<0-1>
Clock 0 or 1
dataset
The clock dataset
default
The default clock status
current
The current clock status
parent
The clock status of the parent-clock
time-properties
The clock dataset time-properties
Sm-tlv
SMPTE TLV information
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp clock 0
PTP Clock Profile : g8275.1
Holdover Duration : 120 min
Default Dataset:
Two Step Flag : No
Clock Identity : B8:6A:97:FF:FE:F5:F4:C4
Number Of Ports : 1
Priority1 : 128
Priority2 : 128
Slave Only : No
Local Priority : 128
Max Steps Removed : 255
Domain Number : 24
Clock Quality :
Clock Class : 248
Clock Accuracy : 254
Offset ScaledLogVariance : 65535
Current Dataset:
Steps Removed : 0
Offset From Master : 0 (0.000 nsec)
Mean Path Delay : 0
Parent Dataset:
Parent Port ID :
Clock Identity : B8:6A:97:FF:FE:F5:F4:C4
Port Number : 0
Parent Stats : No
Observed Parent O.S.L.V : 65535 (Offset Scaled Log Variance)
Observed Parent P.C.R. : 2147483647 (Phase Change Rate)
Grandmaster Identity : B8:6A:97:FF:FE:F5:F4:C4
Grandmaster Priority1 : 128
Grandmaster Priority2 : 128
Grandmaster Clock Quality :
Clock Class : 248
Clock Accuracy : 38
Offset ScaledLogVariance : 65535
Time Dateset:
Current UTC Offset Valid : False
Current UTC Offset : 36
Leap 59 : False
Leap 61 : False
Time Traceable : False
Frequency Traceable : False
PTP Timescale : True
Time Source : Internal Oscillator
Time of Day : Thu Jan 1 19:52:59 1970
OcNOS#sh ptp clock 0 sm-tlv
SMPTE Sync Metadata:
Default frame rate : 30000/1001
GM Lock Status : 0
Time Address Flags : 0x00
Current Local Offset : -37
Jump Seconds : 0
Time of Next Jump : 0x000000000000
Time of Next Jam : 0x000000000000
Time of Previous Jam : 0x000000000000
Previous Jam Local Offset : 0
Daylight Saving :
Current : Not in effect
Next discontinuity : Not in effect
Previous daily jam event : Not in effect
Leap Second Jump : 0x00
show ptp clock port brief
Use this command to display a summary of PTP ports.
Command Syntax
show ptp clock <0-1> port (<1-31>|) brief
Parameters
<0-1>
Clock 0 or 1
<1-31>
Port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp clock 0 port brief
Clock Intf Port Link
Port Name State Encap State Mechanism
---------------------------------------------------------------------------
1 xe2 Master Eth Up 1-step E2E
2 xe1 Master Eth Up 1-step E2E
show ptp clock port dataset
Use this command to display a summary of PTP ports.
Command Syntax
show ptp clock <0-1> port (<1-31>|) dataset
Parameters
<0-1>
Clock 0 or 1
<1-31>
PTP port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp clock 0 port dataset
Port 1:
Port State : Master
Port Identity : B8:6A:97:FF:FE:F5:F4:C4:00:01
Log Min Delay Req Interval : -4
Peer Mean Path Delay : 0
Log Announce Interval : -3
Announce Receipt Timeout : 3
Log Sync Interval : -4
Delay Mechanism : End to end
Version Number : 2
Local Priority : 128
Master only : False
Signal Fail : False
Network Interface : xe0
Vlan Configured :
Description : l3
TTL : 64
DSCP : 56
Unicast Grant Duration : 300
Configured delay asymmetry : 101000000 nsec
Received Packets : 0
Discarded Packets : 0
Transmitted Packets : 99
show ptp clock port drop-counters
Use this command to display drop-counters of the clock-port.
Command Syntax
show ptp clock <0-1> port (<1-31>|) drop-counters
Parameters
<0-1>
Clock 0 or 1
<1-31>
PTP port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#show ptp clock 0 port drop-counters
Port 1:
Drop Counters
Pkt rcvd on bad port state : 4042
show ptp clock port peer
Use this command to display a peer summary of PTP ports.
Command Syntax
show ptp clock <0-1> port (<1-31>|) peer
Parameters
<0-1>
Clock 0 or 1
<1-31>
PTP port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp clock 0 port peer
Port 1 (1 peers):
Peer #0
IPv4 Address : 10.1.1.2
Clock Identity : e8:c5:7a:ff:fe:2e:63:1c
Received Announce : 3297
Received Sync : 26523
Received Delay Response : 26524
Received Signalling : 9
Transmitted Delay Request : 26524
Transmitted Signalling : 9
show ptp clock port master
Use this command to display a master summary of PTP ports.
Command Syntax
show ptp clock <0-1> port (<1-31>|) master
Parameters
<0-1>
Clock 0 or 1
<1-31>
PTP port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0
Example
#show ptp clock 0 port master
Port 1:
Master #0 : 10.1.1.2
show ptp clock port slave
Use this command to display a slave summary of PTP ports.
Command Syntax
show ptp clock <0-1> port (<1-31>|) slave
Parameters
<0-1>
Clock 0 or 1
<1-31>
PTP port number
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#show ptp clock 0 port slave
Port 1: Slave #0
IPv4 Address : 10.1.1.1
Clock Identity : e8:c5:7a:ff:fe:2e:4b:1c
Delay Mechanism : End to end
log Announce Interval : -3
log Sync Interval : -6
Log Delay Req Interval : -6
show ptp servo
Use this command to display servo information.
Command Syntax
show ptp servo
Parameters
None
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp servo
PTP servo status for clock 0
Servo Config : Phase Correction
Servo State : Warmup
Servo State Duration : 04:26:07
Servo APTS Mode : N/A
Lock Status : Unlocked
Frequency Correction : 0.000 ppb
Phase Correction : 0.000 nsec
Offset From Master : 0.000 nsec
Mean Path Delay : 0 nsec
Sync Packet Rate : 0
Delay Packet Rate : 0
show ptp servo history
Use this command to display servo history.
Command Syntax
show ptp servo history
Parameters
None
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#show ptp servo history
Time Phase Correction Freq Correction
(nsec) (pbb)
-----------------------------------------------------------------------
2000 Jan 06 19:15:01 0.000 0.000
2000 Jan 06 19:17:01 0.000 0.000
2000 Jan 06 19:19:01 0.000 0.000
2000 Jan 06 19:21:01 0.000 0.000
2000 Jan 06 19:23:01 0.000 0.000
2000 Jan 06 19:25:01 0.000 0.000
show ptp clock stats
Use this command to display PTP packet statistics.
Command Syntax
show ptp clock <0-1> stats
Parameters
<0-1>
Clock 0 or 1
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show ptp clock 0 stats
clock 0:
Number of ports : 32
Received Packets : 0
Discarded Packets : 0
Received IPv4 PTP Packets : 0
Received IPv6 PTP Packets : 0
Received L2 PTP Packets : 0
RX Queue Overflows : 0
Transmitted Packets : 346
Port 1:
Received Packets : 0
Discarded Packets : 0
Transmitted Packets : 34
show ptp utc-offset
Use this command to display PTP leap seconds configuration.
Command Syntax
show ptp utc-offset
Parameters
None
Command Mode
Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.4.1.
Example
#show ptp utc-offset
Utc offset baseline is 37
Leap seconds configured:
From 2024-01-01 (3913056000 NTP seconds), utc offset is +38 seconds.
From 2024-07-01 (3928780800 NTP seconds), utc offset is +39 seconds.
slave-only
Use this command to set a clock to a slave-only clock.
Use the no form of this command to unconfigure this option.
Command Syntax
slave-only
no slave-only
Parameters
None
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#configure terminal
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#slave-only
sm-tlv default-frame-rates
Use this command to set the default frame rate. Applicable only for SMPTE profile.For example, if the video default frame rate is 30000/1001 Hz, set first argument to numerator value (i.e 30000) and second argument to denominator value (i.e 1001).
Use the no form of this command to unconfigure default frame rates.
For the complete command reference, refer to
sm-tlv default-frame-rates in
PTP SMPTE Profile Configuration section.
sm-tlv time-address-flags color-frame
Use this command to set sm-tlv color frame. Applicable only for SMPTE profile.
Use the no form of this command to unconfigure sm-tlv color-frame.
For the complete command reference, refer to
sm-tlv time-address-flags color-frame in
PTP SMPTE Profile Configuration section.
sm-tlv time-address-flags drop-frame
Use this command to set sm-tlv drop frame. Applicable only for SMPTE profile.
Use the no form of this command to unconfigure sm-tlv drop-frame.
For the complete command reference, refer to
sm-tlv time-address-flags drop-frame in
PTP SMPTE Profile Configuration section.
source-address address
Use this command to set source-address as configured IP address for G.8275.2 profile, G 8265.1, SMPTE and Default profile.
Use the no form of this command to unconfigure this command. This command supports only if transport mode is multicast.
Command Syntax
source-address ipv4 address A.B.C.D
source-address ipv6 address X:X::X:X
no source-address (ipv4 | ipv6) address
Parameters
ipv4
Configuring Ipv4 address
ipv6
Configuring Ipv4 address
A.B.C.D
IPv4 address.
X:X::X:X
IPv6 address.
Default
None
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in the OcNOS version 6.4.2.
Example
Following is an example to execute the CLI.
OcNOS(config)#ptp clock 0 profile g8275.2
OcNOS(config-ptp-clk)#clock-port 1
OcNOS(config-clk-port)# source-address ipv4 address 10.1.1.1
OcNOS(config)#ptp clock 0 profile g8275.2
OcNOS(config-ptp-clk)#clock-port 1
OcNOS(config-clk-port)#source-address ipv6 address 10:1::1
source-address linklocal
Use this command to set source-address as link local for G.8275.2 profile, G 8265.1, SMPTE, and default profile.
Use the no form of this command to unconfigure this command.
Command Syntax
source-address ipv6 linklocal
no source-address ipv6 linklocal
Parameters
None.
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#source-address ipv6 linklocal
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#source-address ipv6 linklocal
source-address interface
Use this command to set source-address as configured interface ip address for G.8275.2 profile, G 8265.1, SMPTE, and default profile.
Use the no form of this command to unconfigure this command.
Command Syntax
source-address (ipv4 | ipv6) interface IFNAME
no source-address (ipv4 | ipv6) interface
Parameters
ipv4
Configuring Ipv4 address
ipv6
Configuring Ipv4 address
IFNAME
Name of the interface whose IP address is used as the source address.
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 6.4.1.
Example
OcNOS(config)#ptp clock 0 profile g8275.2
OcNOS(config-ptp-clk)#clock-port 1
OcNOS(config-clk-port)#source-address ipv4 interface lo
OcNOS(config)#ptp clock 0 profile g8275.2
OcNOS(config-ptp-clk)#clock-port 1
OcNOS(config-clk-port)#source-address ipv6 interface lo
sm-tlv append disable
Use this command to disable tlv append. Applicable only for SMPTE profile.
Use the no form of this command to unconfigure sm-tlv append disable.
For the complete command reference, refer to
sm-tlv append disable section in
OcNOS Key Feature document, Release 6.4.2.
sm-tlv process disable
Use this command to disable tlv processing. Applicable only for smpte profile.
Use the no form of this command to unconfigure sm-tlv process disable.
For the complete command reference, refer to
sm-tlv process disable section in
OcNOS Key Feature document, Release 6.4.2.
transport
Use this command to set transport type as IPv4 unicast/multicast or IPv6 Unicast/Multicast. Applicable for G.8275.2 profile, G 8265.1, SMPTE and default profile.
Use the no form of this command to unconfigure transport-type.
Command Syntax
transport (ipv4|ipv6|ipv4-multicast|ipv6-multicast)
no transport
no transport ipv6-multicast
Parameters
ipv4
IPv4 Transport Type
ipv6
IPv6 Transport Type
ipv4-multicast
IPv4 Multicast Transport Type
ipv6-multicast
IPv6 Multicast Transport Type
Default
None
Command Mode
PTP Clock Port mode
Applicability
transport (ipv4|ipv6) was introduced in the OcNOS version 4.0.
transport (ipv4-multicast|ipv6-multicast) was introduced in OcNOS version 6.4.2.
Example
Following is an example to execute the CLI.
OcNOS#configure terminal
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv4-multicast
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#no transport
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#transport ipv6-multicast
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#no transport
transport ipv6-multicast type
Use this command to set transport type as ipv6 multicast and we can specify the multicast address type. Applicable for G.8275.2 profile, G 8265.1, SMPTE profile and default profile.
Use the no form of this command to unconfigure transport-type.
For the complete command reference, refer to
transport ipv6-multicast type section in
OcNOS Key Feature document, Release 6.4.2.
ttl
Use this command to set ttl value. Applicable for G.8275.2 profile, G 8265.1, SMPTE and default profile.
Use the no form of this command to set default value 64.
Command Syntax
ttl VALUE
no ttl
Parameters
<1-255>
Setting ttl value (default is 64)
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#ttl 2
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#ttl 2
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#ttl 2
two-step
Use this command to set clock two-step flag.
Note: Applicable for QUX platforms.
Use the no form of this command to set default one-step.
Command Syntax
two-step
no two-step
Parameters
None
Default
Default is one-step.
Command Mode
PTP Clock mode
Applicability
This command introduced in OcNOS version 4.2.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#two-step
unicast-grant-duration
Use this command to set unicast-grant-duration value. Applicable for G.8275.2, G 8265.1, SMPTE and default profile. Default is 300.
Use the no form of this command to set default value 300.
Command Syntax
unicast-grant-duration <60-1000>
no unicast-grant-duration
Parameters
<60-1000>
Unicast-grant-duration value (default is 300)
Command Mode
PTP Clock Port mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#ptp clock 0 profile g8275.2
(config-ptp-clk)#clock-port 1
(config-clk-port)#unicast-grant-duration 70
(config)#ptp clock 0 profile default
(config-ptp-clk)#clock-port 1
(config-clk-port)#unicast-grant-duration 70
(config)#ptp clock 0 profile g8265.1
(config-ptp-clk)#clock-port 1
(config-clk-port)#unicast-grant-duration 70
utc-offset baseline
Use this command to set the UTC leap seconds baseline which is the default value of leap seconds at the time before any configured utc-offset date, to calculate UTC time from TAI timescale: UTC = TAI - offset.
Use the no form of this command to set default value 37 seconds, which is applied on 2017-01-01.
Command Syntax
utc-offset baseline <0-99>
Parameters
<0-99>
UTC leap seconds baseline
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 6.3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#utc-offset baseline 38
(config-ptp-clk)#utc-offset date 2024-07-01 39
(config-ptp-clk)#clock-type tgm
(config-ptp-clk)#number-ports 1
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface xe5
(config-clk-port)#master-only
(config-clk-port)#exit
(config-ptp-clk)#commit
(config-ptp-clk)#exit
utc-offset date
Use this command to set the UTC date when applying new offset value of leap seconds. Multiple dates with offset entries can be added.
Command Syntax
utc-offset date YYYY-MM-DD <0-99>
no utc-offset date YYYY-MM-DD
Parameters
YYYY-MM-DD
Date
<0-99>
Offset in seconds
Command Mode
PTP Clock Mode
Applicability
This command was introduced in OcNOS version 6.3.0.
Example
(config)#ptp clock 0 profile g8275.1
(config-ptp-clk)#utc-offset baseline 38
(config-ptp-clk)#utc-offset date 2024-07-01 39
(config-ptp-clk)#clock-type tgm
(config-ptp-clk)#number-ports 1
(config-ptp-clk)#clock-port 1
(config-clk-port)#network-interface xe5
(config-clk-port)#master-only
(config-clk-port)#exit
(config-ptp-clk)#commit
(config-ptp-clk)#exit