Clock Synchronization Attribute

In this user interface, you can configure and query the NE and port attributes, such as the PTP system time, working mode, packet transmission period on the port, and transmission deviation of the cable, in the PTP clock system.

Background Information

The clock port is a port that is used for the time synchronization between a clock node and another clock node. According to the actual networking situation, several clock ports can be created for a board to connect with other clock nodes. A clock port can be used to trace the PTP clock source. The creation of a clock port is to enable a PTP clock port, so that PTP packets can be received.
Generally, when the transmission time and length of cables at the receiving and sending directions are not consistent, set the transmission deviation of a cable. The actual time difference of cable transmission of the two directions is calculated by GPS in the deployment. In this manner, the PTP clock synchronization process is rectified to ensure the precision of the clock synchronization.
NOTE:
The transmission deviation of a cable means the time difference of the clock signals in the cable transmission at the receiving and sending directions between two NEs. The cable transmission deviation can be represented by time or by length.

Navigation Path

In the NE Explorer, select an NE and then choose Configuration > Clock > PTP Clock > Clock Synchronization Attribute from the Function Tree.

Parameter Description

**Table 1** Parameters for clock synchronization attributes
Parameter	Value	Description
PTP System Time	For example: 2009-02-01 01:01:01	Indicates the PTP system time. You can manually modify this parameter. NOTE: The PTP System Time can be set only when the NE traces the local clock source. The time range for the setting is: 2000-01-01 00:00:00 to 2069-12-31 23:59:59.
DST	Check, Uncheck	Specifies whether to enable the DST.
NE Name	For example: NE7183	Indicates the NE name.
NE Clock Type	OC, BC, TC, TC+BC	Specifies the working mode of the NE according to the network planning. In the OC mode, the communication with the network is performed through only one IEEE 1588 port. In the BC mode, the communication with the network is performed through multiple IEEE 1588 ports, which can be used for connections to multiple subdomains. In the TC mode, a device that measures the time taken for a PTP event message to transit the device and provides this information to clocks receiving this PTP event message. That is, the clock device functions as an intermediate clock device to transparently transmit the clock and process the delay, but does not recover the clock. It can effectively deal with the accumulated error resulted from the master and slave hierarchical architecture. In this manner, the TC ensures that the clock/time synchronization precision meets the application requirement. In the TC+BC mode, the NE has the BC feature and handles only the delay, instead of time synchronization. NOTE: Only the OptiX OSN 8800 series equipment supports the TC mode.
Static BMC	Disabled, Enabled	Displays the status of BMC Algorithm.
Slave Only	YES, NO	Specifies whether the port function as only a slave clock. NOTE: This parameter is available only when NE Clock Type is set to OC. The port of the clock equipment that is SLAVE ONLY cannot be in the MASTER state. That is, this clock equipment cannot function as the clock source for the downstream equipment on the trail. Only the port of the clock equipment that is NON_SLAVE ONLY can be in the MASTER state. That is, this clock equipment can function as the clock source for the downstream equipment on the trail. Hence, at least one clock equipment that is NON_SLAVE ONLY should be included in the PTP system.
PTP Time Adjustment	Enabled, Disabled Default: Enabled	Enables or disables the function of adjusting the PTP time.
Protocol Packet Format	NMEA, UBX Default: UBX	Configures and queries the protocol packet format. Select a value according to the actual time interface protocol. If the protocol is NMEA, select NMEA. If the protocol is UBX, select UBX. NOTE: The Protocol Packet Format is valid only when Interface Protocol Type of the external time interface is set to 1PPS+Time. When Interface Protocol Type of the external time interface is set to DCLS, The Protocol Packet Format can still be set but the parameter value is invalid.
WTR Time(min)	0 - 12 Default: 5	Specifies the time from recovering signal detection to triggering the clock selector. The WTR time is set to prevent the clock selector from responding to a transient signal recovery. In this manner, the clock signals are re-selected as the clock source only when the synchronous clock signals recover from a failure and stay valid within the WTR time. An independent WTR timer is configured for each PTP port. An independent WTR timer is configured for each PTP port.
Local PTP Clock Source No.	WDM NE For example: Company Code: 00259E30, Supplying Code: FF, NE ID: 9-5	Indicates the clock number of the local PTP clock source of the NE.
Current Master Clock No.	WDM NE For example: Company Code: 00259E30, Supplying Code: FF, NE ID: 9-5	Indicates the clock number of the master clock that the NE traces after you specify the clock source for the NE.
Ingress of Current Master Clock	shelf ID(shelf name)-slot number-board name-port number(port name)	Indicates the local clock input interface of the master clock that the NE traces after you specify the clock source for the NE.

**Table 2** Parameters for the port status
Parameter	Value	Description
Board	For example: Shelf0(subrack)-2–54THA(STND)	Indicates the name of the board that supports the clock domain. You can select a board from the drop-down list.
Port	shelf ID(shelf name)-slot number-board name-port number(port name)	Indicates the name of the ports where the PTP clocks are synchronized.
Clock Type	OC, BC, TC, TC+OC	Specifies the working mode of the port. When you set NE Clock Type of the NE to OC, you can set this parameter to OC only. When you set NE Clock Type of the NE to BC, you can set this parameter to BC only. When you set NE Clock Type of the NE to TC+BC, you can set this parameter to TC or BC. When you set NE Clock Type of the NE to TC, you can set this parameter to TC or TC+OC. When the working mode of the clock on the corresponding port is synchronous, you can set this parameter to TC or TC+OC. NOTE: In the OC work mode, only one clock port can be created. The OptiX OSN 6800 does not support the TC mode.
Step Mode	Single step, Double step	Specifies whether an IEEE 1588 port works in the Single step or Double step mode. In the Single step mode, the actual transmit timestamp is added to the packet to be transmitted. This requires the equipment of higher precision and accuracy. In the Double step mode, the actual transmit timestamp is not added to the packet to be transmitted. Instead, follow-up packets are used.
PTP Packet VLAN	1 to 4094, / Default: /	Specifies the VLAN value of a PTP packet. According to the actual networking requirements, during the interconnection to other client-side equipment, if the PTP packet is forwarded based on VLAN at the client side, the PTP packet that is transmitted must carry VLAN. NOTE: You can set this parameter for data boards only. As a result, this parameter cannot be set for the OptiX OSN 6800. / Indicates that the VLAN ID is invalid.
PTP Packet Encapsulation Format	PTP ETH, PTP IP Default: PTP ETH	Specifies the encapsulation format of the PTP packet. Based on the actual networking, when local client-side equipment is interconnected with other client-side equipment, you need to set the encapsulation format of the PTP packet of the local equipment accordingly because the other client-side equipment may use Layer 2 or Layer 3 forwarding mode. NOTE: You can set this parameter for data boards only. As a result, this parameter cannot be set for the OptiX OSN 6800.
Port Status	LISTENING, MASTER, PASSIVE, SLAVE	Sets the prefigure status of a port.
Current Port Status	MASTER, SLAVE, PASSIVE, LISTENING, PRE_MASTER, FAULTY	Indicates the actual status of the port of the clock source. The port status is calculated according to the clock source quality and priority by using the BMC algorithm.
Reference Clock Source No.	00000000000000000000 to FFFFFFFFFFFFFFFFFFFF	Indicates the clock numbers of the clock sources that the port can trace.
File Type	Text Format, Hex Format	In the text format, a clock source number consists of a corporate code, a complementary code, the NE ID, and an interface number. In the hexadecimal format, a clock source number is represented by hexadecimal codes.
Company Code	001882, 001E10, 00E0FC, 00259E	The company code indicates a company, and 0X001E10 indicates Huawei.
Supplying Code	For example: 10	The supplying code is 10 by default and it cannot be set. The supplying code varies according to the clock sources of different companies.
NE ID	For example: 1.1.1.1	The NE ID, a value in IP address format, is used to indicate an NE.
Interface ID	1 to 65535	The interface ID contains two bytes (16 bits), and thus the range of the interface ID in decimal format is 1-65535. The format of the interface ID is "subrack (3 bits) + slot (6 bits) + interface board (1 bit) + port (6 bits)". For example, port 1 of slot 2 is expressed as 000 000010 0 000001, that is, 257 in decimal format.
Hex Code	00000000000000000000 to FFFFFFFFFFFFFFFFFFFF	It is the value of "company code + NE ID + supplying code + interface ID" in hexadecimal format. For example, if the company code is 001E10, supplying code is 10, NE ID is 1.1.1.1, and interface ID is 257, the hex code is 001E1001010101100101.
Enable ACR	Enabled, Disabled	Sets whether to enable ACR clock function.
Domain ID	0 to 255	Indicates the domain ID. A physical packet switched network (PSN) can be logically divided into several clock domains. The time established within one clock domain is independent of the time in other domains. The ordinary clock (OC) and boundary clock (BC) are defined within the range of one clock domain. That is, the OC and BC process the received IEEE 1588v2 messages within a specified clock domain, and they will discard the IEEE 1588v2 messages from other clock domains. The transparent clock (TC) is not limited within the range of one clock domain. It can process the received IEEE 1588v2 messages: mark the residence time and forward the messages. The TC+BC node is a combined TC and BC. The node can support not only time synchronization but also time transparent transmission.

**Table 3** Parameters for port message
Parameter	Value	Description
Port	shelf ID(shelf name)-slot number-board name-port number(port name)	Indicates the name of the ports where the PTP clocks are synchronized.
P/E Mode	P2P, E2E	Specifies the delay mechanism that the time port uses When the parameter is set to P2P, the peer-to-peer delay mechanism is used on time ports. This is applicable to a mesh network. When the parameter is set to E2E, the request-reply delay mechanism is used on time ports. This is applicable to a chain network. NOTE: This parameter cannot be set to P2P for the OptiX OSN 6800.
SYNC Packet Period (s)	1/1024, 2/1024, 4/1024, 8/1024, 16/1024, 32/1024, 64/1024, 128/1024, 256/1024, 512/1024, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 Default: 8/1024	Specifies the period of transmitting SYNC packets.
DELAY Packet Period (s)	1/1024, 2/1024, 4/1024, 8/1024, 16/1024, 32/1024, 64/1024, 128/1024, 256/1024, 512/1024, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 Default: 1	Specifies the period of transmitting DELAY packets. NOTE: This parameter is available only when the P/E Mode parameter is set to E2E.
PDELAY Packet Period (s)	1/1024, 2/1024, 4/1024, 8/1024, 16/1024, 32/1024, 64/1024, 128/1024, 256/1024, 512/1024, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 Default: 128/1024	Specifies the period of transmitting PDELAY packets. NOTE: This parameter is available only when the P/E Mode parameter is set to P2P.
ANNOUNCE Packet Period (s)	4/1024, 8/1024, 16/1024, 32/1024, 64/1024, 128/1024, 256/1024, 512/1024, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 Default: 128/1024	Specifies the period of transmitting ANNOUNCE packets.
ANNOUNCE Packet Timeout Coefficient	2 to 10 Default: 3	Specifies the times of the ANNOUNCE Packet period. The value of this parameter multiplied by the ANNOUNCE Packet period is equal to the timeout interval of receiving ANNOUNCE packets. When the port does not receive ANNOUNCE packets within the set timeout interval, it is considered that the packets cannot arrive and the link fails.

**Table 4** Parameters for cable transmitting warp
Parameter	Value	Description
Port	shelf ID(shelf name)-slot number-board name-port number(port name)	Indicates the name of the ports where the PTP clocks are synchronized.
Warp Direction	Positive, Negative	Indicates the direction of the transmission deviation of the cable. When the parameter is set to Positive, the transmission distance through the receive direction is longer than the distance through the transmit direction, or the transmission time through the receive direction is longer than the time through the transmit direction. When the parameter is set to Negative, When the parameter is set to Positive, the transmission distance through the transmit direction is longer than the distance through the receive direction, or the transmission time through the transmit direction is longer than the time through the receive direction.
Warp Mode	Length, Time Default: Time	Specifies the mode of measuring the transmission deviation of the cable.
Warp Length (m)	Values of parameters vary with different boards and products. 0 to 12000	Specifies the length of the transmission deviation of the cable. Specify the value of the parameter as required, to modify the clock synchronization. NOTE: This parameter is available only when the Warp Mode parameter is set to Length.
Warp Time (ns)	Values of parameters vary with different boards and products.	Specifies the time of the transmission deviation of the cable. Specify the value of the parameter as required, to modify the clock synchronization. NOTE: This parameter is available only when the Warp Mode parameter is set to Time.

Note

NOTE:

The clock function you have purchased may obtain or use some personal information of users when providing services or maintenance. Therefore, you are obliged to formulate a privacy policy according to the applicable law and take sufficient measures to keep the personal information secure.