Safran WR-Z16 User manual

User Manual
Revision: v5.0
Date: 25-July-2023
ELECTRONICS & DEFENSE
WR-Z16
MODEL

© 2023 Safran. All rights reserved.
Information furnished by Safran is believed to be accurate and reliable. However, no
responsibility is assumed by Safran for its use, nor for any infringements of patents or
other rights of third parties that may result from its use. Safran reserves the right to
make changes without further notice to any products herein. Safran makes no warranty,
representation or guarantee regarding the suitability of its products for any particular
purpose, nor does Safran assume any liability arising out of the application or use of any
product or circuit, and specifically disclaims any and all liability, including without lim-
itation consequential or incidental damages. No license is granted by implication or oth-
erwise under any patent or patent rights of Safran. Trademarks and registered
trademarks are the property of their respective owners. Safran products are not inten-
ded for any application in which the failure of the Safran product could create a situation
where personal injury or death may occur. Should Buyer purchase or use Safran
products for any such unintended or unauthorized application, Buyer shall indemnify
and hold Safran and its officers, employees, subsidiaries, affiliates, and distributors harm-
less against all claims, costs, damages, and expenses, and reasonable legal fees arising
out of, directly or indirectly, any claim of personal injury or death associated with such
unintended or unauthorized use, even if such claim alleges that Safran was negligent
regarding the design or manufacture of the part.
Safran Electronics & Defense
safran-navigation-timing.com
Safran Trusted 4D
• 45 Becker Road, Suite A, West Henrietta, NY 14586 USA
• 3, Avenue du Canada, 91974 Les Ulis, France
The industry-leading Seven Solutions products you depend on are now brought to you by Safran.
Do you have questions or comments regarding this User Manual?
èE-mail: [e-mail]
WR-Z16 User Manual I

Blank page.
II WR-Z16 User Manual

WR-Z16 User Manual • TABLE OF CONTENTS III
CHAPTER 1
Introduction 1
1.1 About this Document 2
1.2 About WR-Z16 2
1.3 About WRZ-OS 3
1.4 About White Rabbit / High-Accuracy Technology 4
CHAPTER 2
Product Description 7
2.1 Front panel 8
2.2 Rear panel 9
2.3 Monitoring LEDs 10
2.3.1 System Status 10
2.3.2 Timing Output 11
2.3.3 Timing Input 12
2.3.4 SFP Ports 12
2.4 Product Specifications 13
2.5 Safety Notes 15
2.6 Rack Installation 17
2.7 Regulatory Compliance 18
2.7.1 EMC 18
2.7.2 Safety 18
2.7.3 RoHS 18
CHAPTER 3
Device Connectivity 19
3.1 Default Configuration 20
3.2 Connecting to the Device 20
3.2.1 Necessary Items for Connectivity 20
3.2.2 Logging from the UART 20
CONTENTS

3.2.3 Logging from SSH 21
3.2.4 Connecting on Linux (Ubuntu 18.04 LTS) 22
3.2.4.1 Logging from UART 22
3.2.4.2 Logging in from SSH 23
3.2.5 Connecting on Windows 24
3.2.5.1 Logging in from UART 24
3.2.5.2 Logging in from SSH 25
3.2.6 Logging in from web 25
CHAPTER 4
GUI & CGI Tools 27
4.1 Parameters API Introduction 28
4.1.1 Table representation 29
4.2 The REST-API 31
4.2.1 Accessing the REST-API Documentation 31
4.2.2 Interacting with the REST-API 31
4.2.2.1 HTTP Methods 31
4.2.2.2 GET Formats 32
4.2.3 Accessing the REST-API through the documentation page 33
4.2.4 Accessing the REST-API through Postman 36
4.2.4.1 About Postman 36
4.2.4.2 Downloading and Installing Postman 36
4.2.4.3 Familiarizing Yourself with Postman 36
4.2.4.4 Importing the White Rabbit Collection 38
4.2.4.5 Configuring the ‘baseUrl’ 39
4.2.4.6 Obtaining the Access Token 40
4.2.4.7 Making a Request 40
4.3 The Web GUI 41
4.3.1 Network configuration from web 43
4.4 CLI Configuration 45
4.4.1 Network configuration from CLI 47
4.5 CLI Monitoring 49
4.5.1 Listing parameters 49
4.5.1.1 Readback a specific parameter 50
4.5.2 Applying changes online 50
4.5.3 Other functionalities 51
IV WR-Z16 User Manual • TABLE OF CONTENTS

4.6 Other CLI tools 52
CHAPTER 5
Timing 53
5.1 Multi-sources & Resiliency 54
5.1.1 Timing Sources 54
5.1.2 FOCA: The Failover Clock Algorithm 54
5.1.3 Virtual Clock Overview 57
5.2 General Timing Management 59
5.2.1 Presets 59
5.2.1.1 WR Slave @ wr0 (BC) [default] 59
5.2.1.2 External Atomic Clock (GM) 59
5.2.1.3 External GNSS Receiver (GM) 60
5.2.1.4 WR Slave @ wr0 àwr1 (BC) 61
5.2.1.5 WR Slave @ wr0 / PTP Fan-Out 61
5.2.1.6 WR Slave @ wr0>wr1 / PTP Fan-Out 62
5.2.1.7 Manual Free-Running 62
5.2.1.8 Custom 62
5.2.2 Reference topology 65
5.2.3 Timing source info 67
5.3 White Rabbit 69
5.3.1 Configuration 69
5.3.2 Info/Overview 69
5.3.2.1 Active servo 69
5.3.2.2 Port Instance 70
5.4 IEEE 1588-2008 (PTPv2) 74
5.4.1 License 74
5.4.1.1 PTP license management 75
5.4.2 Configuration 76
5.4.2.1 Configuration of PTP Profiles 77
5.4.3 Info/Overview 81
5.5 External Reference (GM) 85
5.5.1 Configuration 85
5.5.2 Info/Overview 86
5.6 NTP 87
WR-Z16 User Manual • TABLE OF CONTENTS V

5.6.1 Configuration 87
5.6.1.1 NTP Provider 88
5.6.1.2 NTP over Fiber Optics (wrX ports) 88
5.6.1.3 NTP Timing Source Configuration 89
5.6.2 Info/Overview 89
5.6.3 Stratum Levels 90
5.7 Holdover 90
5.7.1 Configuration 92
5.7.2 Info/Overview 93
5.8 Miscellaneous 94
5.8.1 Update Leap Seconds File 95
CHAPTER 6
Security & Authentication 97
6.1 Upload SSH keys 98
6.2 HTTPS 98
6.3 TACACS+ 100
6.3.1 Verification of TACACS+ installation 100
6.3.2 TACACS+ Client configuration 101
6.4 RADIUS 103
6.4.1 RADIUS configuration files 103
6.4.2 Verification of RADIUS installation 103
6.4.3 RADIUS client configuration 104
6.5 Firewall 106
6.5.1 Example to only allow a specific IP for management 106
CHAPTER 7
Monitoring & Logging 109
7.1 Syslog 110
7.1.1 Session logs 110
7.1.2 Permanent logs 111
7.1.3 Remote logs 111
7.1.4 Logging tools 111
7.1.5 Configuration 112
7.2 SNMP 114
VI WR-Z16 User Manual • TABLE OF CONTENTS

7.2.1 Configuration 114
7.2.1.1 General configuration 117
7.2.1.2 Specific SNMP v1/v2 configuration 119
7.2.1.3 Specific SNMPv3 configuration 119
7.2.2 SNMP Traps 121
7.2.2.1 Trap objects 122
7.2.2.2 Trap notifications 122
7.2.2.3 Trap configuration 123
7.2.2.4 Basic trap receptor NMS configuration 124
7.3 LLDP 125
7.3.1 Standard (IEEE 802.1AB-2005) TLVs 125
7.3.2 Configuration 126
7.3.3 Info/Overview 126
7.4 Healthing 129
7.4.1 Information/Overview 129
7.4.2 Configuration 133
CHAPTER 8
Device Maintenance 137
8.1 Licenses 138
8.1.1 List of related Licenses 138
8.1.2 Check Licenses 138
8.1.3 Order Licenses 140
8.1.4 Local Licenses Management 140
8.1.4.1 Map a feature to a device 141
8.1.4.2 Create A New Device 142
8.1.4.3 Load local license file in the device 142
8.1.4.4 Remove local license from device 143
8.1.5 License Server 144
8.2 Firmware Update 145
8.2.1 Hardware version and firmware 145
8.2.2 Using Web interface 146
8.2.3 Using SSH/SCP 147
8.3 Recovery Mode 147
8.3.1 Manual recovery mode 149
8.3.1.1 Using reset button 149
WR-Z16 User Manual • TABLE OF CONTENTS VII

8.3.1.2 From Serial UART 149
8.4 Factory Config Mode 149
8.4.1 Reset via Front Panel Controls 150
8.4.2 Rest via the CLI 150
8.5 Failsafe Mode 151
APPENDIX
Appendix 153
9.1 Acronyms 154
9.2 Troubleshooting 155
9.2.1 Frequently asked questions (FAQ) 155
9.2.2 Health general status 156
9.2.3 Virtual State Clock Code Error 157
9.2.4 HTTPS Firefox Error 157
9.2.5 How to report an error 158
9.2.6 Rsyslog template to improve remote login 159
9.2.7 Warranty 159
9.3 Technical Support 160
9.3.1 Regional Contact 160
9.4 VCS Code 161
9.4.1 Grand Master (GM VCS Code) 161
9.4.2 Boundary Clock (BC VCS Code) 163
9.4.3 Others 168
9.5 Persistent Custom Files 170
9.6 Low Jitter Setup 171
9.7 TACACS+ and RADIUS server configuration 172
9.7.1 TACACS+ server installation and configuration 172
9.7.2 RADIUS server installation and configuration 173
9.8 List of supported SFPs 175
9.9 List of Tables 175
9.10 List of Images 176
9.11 Document Revision History 177
INDEX
VIII WR-Z16 User Manual • TABLE OF CONTENTS

CHAPTER 1•WR-Z16 User Manual 1
Introduction
The following topics are included in this Chapter:
1.1 About this Document 2
1.2 About WR-Z16 2
1.3 About WRZ-OS 3
1.4 About White Rabbit / High-Accuracy Technology 4
CHAPTER 1

1.1 About this Document
This document is the main user guide of the WR-Z16 Model . It describes the
essential information about the WR-Z16 hardware, its features, and configuration
options.
It is designed to allow users who have their first contact with the device to easily
connect it to a management network and distribute precise timing (PTP or White
Rabbit (WR), for example) through optical interfaces. It also provides advanced
tips for expert users and/or details how to match the security policies defined at
your company.
The set of official manuals also includes the WRZ-OS API guide for complete
documentation about your WR-Z16.
1.2 About WR-Z16
The WR-Z16 is the reliable precise time fan-out for the most demanding time dis-
tribution applications on 1G Ethernet-based networks.
The WR-Z16 is a standalone device with 16 SFP connectors which provides sub-
nanosecond accuracy time over plug-and-play fiber links. It provides very precise
IEEE 1588 (PTP) in all its optical interfaces and supports NTP interoperability.
Picosecond-level frequency distribution is available through digital clock. The
WR-Z16 incorporates failover mechanisms which combine multi-source redund-
ancy and holdover capabilities to ensure continued operation.
Its design is optimized for datacenter environment, where it is typically located in
the top of the hierarchy level of the distribution network. The WR-Z16 can obtain
the external time reference from its 10MHz and 1PPS SMA inputs, from another
White Rabbit device through the SFP ports or it can work as a free running mas-
ter device for the network.
A typical intra-datacenter network topology is shown in the figure below, where
the WR-Z16 is working as the grandmaster and is the key element for distributing
the timing through WR to each cabinet of the datacenter. Different end nodes
are included in the diagram to illustrate the interoperability with different inter-
faces.
2CHAPTER 1•WR-Z16 User Manual Rev. v5.0
1.1 About this Document

Figure 1-1: Intra-datacenter WR network topology
There are different options and licenses which enable specific functionalities of
the WR-Z16. These options are described in the table below:
Table 1-1: Options and Licenses available in WR-Z16
Option /Li-
cense Description
Holdover
option
An optional holdover oscillator can be included to maintain high accuracy
(<1.5us/24h) even when all timing references are down.
PTP
license
The device is shipped with the default profile of PTPv2/IEEE1588-2008. Other
configuration including specific profiles support requires activation license.
HATI
license
Enable the WR-Z16 to provide high accuracy synchronization to the HATI FPGA
IP CORE. This license might be available per port or within a pack.
1.3 About WRZ-OS
The WR-Z16 is part of a full ecosystem of products which maintain sub-nano-
second accuracy synchronization from an external time reference to the end
nodes of the timing network, where different timing interfaces are provided to
inter-operate with third-party equipment.
The WR-Z16 devices and the WR-ZEN family (WR-ZEN TP, WR-ZEN TP-FL, WR-
ZEN TP-32BNC) run on the same platform (WRZ-OS) sharing the same features,
timing stack and set of tools.
1.3 About WRZ-OS
CHAPTER 1•WR-Z16 User Manual Rev. v5.0 3

All the devices running the WRZ-OS provide multiple interoperability options
that include 1PPS/10 MHz signals, standard PTP, and NTP. They support SNMP
v2/v3, rsyslog, and have an integrated web GUI for intuitive management and
enhanced command line tools for advanced users. The following list contains the
different form factors offered within the WR-ZEN family and a brief description
of their main characteristics:
WR-ZEN TP-FL: A fundamental, cost-effective 1U form factor version of the
WR-ZEN TP. It has a front dual power supply. It includes 1PPS/10 MHz SMA
outputs and standard PTP interoperability on its management interfaces. It
can include a 4 x 1PPS expansion on demand.
WR-ZEN TP: Standard 1U form factor version of the time provider. It
accepts multiple fans and it has a rear dual power supply. It includes mul-
tiple 1PPS/10 MHz on the SMA or DB9 outputs, standard PTP inter-
operability on its management interfaces, IRIG-B, NMEA and ToD.
WR-ZEN TP-32BNC: Expanded 2U form factor version of the WR-ZEN TP.
It has a front dual power supply. It includes 1PPS/10 MHz SMA outputs and
standard PTP interoperability on its management interfaces. The main char-
acteristic is that it includes 32 BNC ports configured to work as 16 x 1PPS
and 16 x 10 MHz outputs. A configuration with 32 x 1PPS is possible with an
optional PPS expansion license.
1.4 About White Rabbit / High-Accuracy Technology
One of the key-features of the WR-Z16 family is that it fully supports the White
Rabbit (WR) protocol, an extension of the IEEE 1588 (PTP), to achieve ultra-
accurate sub-nanosecond synchronization in Ethernet-based networks. Since the
publication of the new IEEE 1588-2019 standard, White Rabbit is also known as
“PTP High Accuracy” (HA) profile, and has the following characteristics:
Time Precision: WR provides a common clock for physical layer in the
entire network, allowing synchronization at sub-nanosecond level with pico-
seconds precision. In other words, the timing budget consumed by WR is
almost insignificant.
Scalability: WR networks are designed to be highly scalable supporting
thousands of nodes and long-distance links within the range of metro area
deployments. Its performance is not affected by traffic as with other PTP
profiles.
Cost effective solution: WR avoids expensive costs related to calibration
and complex deployments with high requirements of maintenance, allow-
ing plug-and-play links in Local Area Networks (LANs).
4CHAPTER 1•WR-Z16 User Manual Rev. v5.0
1.4 About White Rabbit / High-Accuracy Technology

Integration: WR is based on existing protocols and standards (such as PTP
and Ethernet) so it is very easy to integrate into your existing network infra-
structure.
1.4 About White Rabbit / High-Accuracy Technology
CHAPTER 1•WR-Z16 User Manual Rev. v5.0 5

BLANK PAGE.
1.4 About White Rabbit / High-Accuracy Technology
6CHAPTER 1•WR-Z16 User Manual Rev. v5.0

CHAPTER 2•WR-Z16 User Manual 7
Product Description
The Chapter presents an overview of the WR-Z16 Model , its capabilities, main
technical features and specifications.
The following topics are included in this Chapter:
2.1 Front panel 8
2.2 Rear panel 9
2.3 Monitoring LEDs 10
2.4 Product Specifications 13
2.5 Safety Notes 15
2.6 Rack Installation 17
2.7 Regulatory Compliance 18
CHAPTER 2

2.1 Front panel
Figure 2-1: WR-Z16 front panel
Table 2-1: Front Panel Legend
# Name Information Ref.
#1 Power button Power On/Off the device
#2 Reset Button Button used to perform a factory
reset or enter the recov-
ery/failsafe mode
"Recovery Mode" on
page147
#3 Status LED Green, Orange, Red "System Status" on page10
#4 1x Man-
agement
UART (RJ45)
Serial UART RS232 on a RJ45
connector with pinout
(USB-RJ45/RS232 adaptor not
included)
"Logging from the UART" on
page20
Pin #1:
✖
Pin #2:
✖
Pin #3
RXD
Pin #4
GND
Pin #5:
✖
Pin #6:
TXD
Pin #7:
✖
Pin #8:
✖
#5 2x Man-
agement Eth-
ernet (RJ45)
10/100/1000 ethernet network
interface (eth0 & eth1)
"Product Specifications" on
page13
#6 16x SFP Fiber
ports
1Gbps SFP compatible "White Rabbit" on
page69"IEEE 1588-2008
(PTPv2)" on page74
Timing input
#7 Timing Input
LED
OK: Green; Warning: Yellow; Crit-
ical: Red
"Timing Output" on page11
#8 10 MHz input ●SMA connector (F)
●50 Ωtermination
●1Veff (+/- 30%) digital or
sine wave
"External Reference (GM)"
on page85
8CHAPTER 2•WR-Z16 User Manual Rev. v5.0
2.1 Front panel

# Name Information Ref.
#9 PPS input ●SMA connector (F)
●50 Ωtermination
●TTL input (5V) / LVTTL
input (3.3V)
"External Reference (GM)"
on page85
Timing output
#10 Timing Output
LED
OK: Green; Warning: Yellow; Crit-
ical: Red
"Timing Input" on page12
#11 PPS output ●SMA connector (F)
●Digital output
●High level output: 3.0V +/-
0.2V
(with 50 Ωtermination)
"Virtual Clock Overview" on
page57
#12 10 MHz output ●SMA connector (F)
●Digital output
●High level output: 3.0V +/-
0.2V
(with 50 Ωtermination)
"Virtual Clock Overview" on
page57
2.2 Rear panel
Figure 2-2: Rear panel of the WR-Z16
Table 2-2: RearPanel Legend
# Name Information Ref.
#1 Ground ●Ground connector of the device
Power Supply
2.2 Rear panel
CHAPTER 2•WR-Z16 User Manual Rev. v5.0 9

# Name Information Ref.
#2 Power Sup-
ply #1
●Swappable & monitorable mod-
ule:
- 100- 240VAC, 50- 60Hz, (80W
Max)
#3 Power Sup-
ply #2
●Swappable & monitorable mod-
ule:
- 100- 240VAC, 50- 60Hz, (80W
Max)
Fans
#4 Fan #1 Swappable Fan module with rear & front
fans
- Default airflow: blowing out
"Product Specifications"
on page13
# Fan #2 Swappable Fan module with rear & front
fans
- Default airflow: blowing out
2.3 Monitoring LEDs
The status of the WR-Z16 device can be quickly verified using the 3 visible LEDs
in the front-panel. The tables below detail the behavior of each LED depending
on the status of the WR-Z16.
The blinking behavior of the front panel LEDs is represented by the “Visual”
column in the following tables using a sequence of three consecutive instants.
2.3.1 System Status
This LED is mainly used to inform the state of the system itself (Daemons loaded,
Fans, power-supply, Temperature, CPU load, Available space, etc.). This led is
also used to identify the various stages and modes of the booting procedure.
Table 2-3: Status LED behavior
Visual Behavior Description
●●● Steady Green Device system state is OK. There is no Warning or Crit-
ical alert.
10 CHAPTER 2•WR-Z16 User Manual Rev. v5.0
2.3 Monitoring LEDs