Orolia WR-Z16 User manual

WR-Z16
MODEL
User Manual
Revision: v3.4
Date: 14-October-2022

© 2022 Orolia. All rights reserved.
The information in this document has been carefully reviewed and is believed to be accurate and up-to-
date. Orolia assumes no responsibility for any errors or omissions that may be contained in this doc-
ument, and makes no commitment to keep current the information in this manual, or to notify any person
or organization of updates. This User Manual is subject to change without notice. For the most current
version of this documentation, please see our web site at orolia.com.
Orolia reserves the right to make changes to the product described in this document at any time and
without notice. Any software that may be provided with the product described in this document is fur-
nished under a license agreement or nondisclosure agreement. The software may be used or copied only
in accordance with the terms of those agreements.
End-user customers of Orolia products may, without the need for a written license from Orolia, repro-
duce and modify any Orolia product documentation accompanying such products, for distribution within
their organization in order to use the products.
Orolia authorized partners, systems integrators, government contractors, and other similarly-situated
third-party installers may, without the need for a written license from Orolia, reproduce Orolia product
documentation (including media type changes) and create derivative works thereof in the form of com-
pilations, for distribution to their end-users.
Except as described above, no part of this publication may be reproduced, stored in a retrieval system, or
transmitted in any form or any means electronic or mechanical, including photocopying and recording for
any purpose without the written permission of Orolia.
Other products and companies referred to herein are trademarks or registered trademarks of their
respective companies or mark holders.
Orolia USA, Inc.
• 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 Orolia, the
global leader in Resilient Positioning, Navigation and Timing Solutions.
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

CONTENTS
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 14
2.6 Rack Installation 16
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

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 from SSH 23
3.2.5 Connecting on Windows 24
3.2.5.1 Logging from UART 24
3.2.5.2 Logging from SSH 25
3.2.6 Logging from web 25
CHAPTER 4
GUI & CGI Tools 29
4.1 Parameters API Introduction 30
4.1.1 Table representation 31
4.2 The Web GUI 32
4.2.1 Network configuration from web 34
4.3 CLI Configuration 36
4.3.1 Network configuration from CLI 37
4.4 CLI Monitoring 39
4.4.1 Listing parameters 39
4.4.1.1 Readback a specific parameter 40
4.4.2 Applying changes online 41
4.4.3 Other functionalities 41
4.5 Other CLI tools 42
CHAPTER 5
Timing 43
5.1 Multi-sources & Resiliency 44
5.1.1 Timing Sources 44
5.1.2 FOCA: The Failover Clock Algorithm 44
5.1.3 Virtual Clock Overview 47
5.2 General Timing Management 48
5.2.1 Presets 49
5.2.1.1 WR Slave @ wr0 (BC) [default] 49
5.2.1.2 External Atomic Clock (GM) 49
5.2.1.3 External GNSS Receiver (GM) 50
5.2.1.4 WR Slave @ wr0 àwr1 (BC) 50
IV WR-Z16 User Manual • TABLE OF CONTENTS

5.2.1.5 WR Slave @ wr0 / PTP Fan-Out 51
5.2.1.6 WR Slave @ wr0>wr1 / PTP Fan-Out 51
5.2.1.7 Manual Free-Running 51
5.2.1.8 Custom 52
5.2.2 Reference topology 55
5.2.3 Timing source info 56
5.3 White Rabbit 58
5.3.1 Configuration 58
5.3.2 Info/Overview 58
5.3.2.1 Active servo 58
5.3.2.2 Port Instance 59
5.4 IEEE 1588-2008 (PTPv2) 62
5.4.1 License 63
5.4.1.1 PTP license management 64
5.4.2 Configuration 65
5.4.2.1 Configuration of PTP Profiles 67
5.4.3 Info/Overview 69
5.5 External Reference (GM) 73
5.5.1 Configuration 73
5.5.2 Info/Overview 74
5.6 NTP 75
5.6.1 Configuration 75
5.6.1.1 NTP Provider 75
5.6.1.2 NTP Timing Source Configuration 76
5.6.2 Info/Overview 77
5.6.3 Stratum Levels 77
5.7 Holdover 78
5.7.1 Configuration 79
5.7.2 Info/Overview 80
5.8 Miscellaneous 81
5.8.1 Update Leap Seconds File 81
CHAPTER 6
Security & Authentication 83
6.1 Upload SSH keys 84
WR-Z16 User Manual • TABLE OF CONTENTS V

6.2 HTTPS 84
6.3 TACACS+ 87
6.3.1 Verification of TACACS+ installation 87
6.3.2 TACACS+ Client configuration 87
6.4 RADIUS 89
6.4.1 RADIUS configuration files 89
6.4.2 Verification of RADIUS installation 90
6.4.3 RADIUS client configuration 90
6.5 Firewall 92
6.5.1 Example to only allow a specific IP for management 92
CHAPTER 7
Monitoring & Logging 95
7.1 Syslog 96
7.1.1 Session logs 96
7.1.2 Permanent logs 97
7.1.3 Remote logs 97
7.1.4 Logging tools 97
7.1.5 Configuration 98
7.2 SNMP 99
7.2.1 Configuration 100
7.2.1.1 General configuration 102
7.2.1.2 Specific SNMP v1/v2 configuration 103
7.2.1.3 Specific SNMPv3 configuration 104
7.2.2 SNMP Traps 105
7.2.2.1 Trap objects 106
7.2.2.2 Trap notifications 107
7.2.2.3 Trap configuration 108
7.2.2.4 Basic trap receptor NMS configuration 108
7.3 LLDP 109
7.3.1 Standard (IEEE 802.1AB-2005) TLVs 110
7.3.2 Configuration 110
7.3.3 Info/Overview 111
7.4 Healthing 114
7.4.1 Information/Overview 114
7.4.2 Configuration 116
VI WR-Z16 User Manual • TABLE OF CONTENTS

7.5 External monitoring tool 117
CHAPTER 8
Device Maintenance 119
8.1 Licenses 120
8.1.1 List of related Licenses 120
8.1.2 Check Licenses 120
8.1.3 Order Licenses 122
8.1.4 Local Licenses Management 122
8.1.4.1 Map a feature to a device 123
8.1.4.2 Create A New Device 124
8.1.4.3 Load local license file in the device 124
8.1.4.4 Remove local license from device 125
8.1.5 License Server 126
8.2 Firmware Update 126
8.2.1 Hardware version and firmware 127
8.2.2 Using Web interface 127
8.2.3 Using SSH/SCP 129
8.3 Recovery Mode 130
8.3.1 Manual recovery mode 131
8.3.1.1 Using reset button 131
8.3.1.2 From Serial UART 132
8.4 Factory Config Mode 132
8.5 Failsafe Mode 133
APPENDIX
Appendix 135
9.1 Acronyms 136
9.2 Troubleshooting 137
9.2.1 Frequently answered questions (FAQ) 137
9.2.2 Health general status 138
9.2.3 Virtual State Clock Code Error 139
9.2.4 How to report an error 139
9.2.5 Rsyslog template to improve remote login 139
9.2.6 Warranty 140
WR-Z16 User Manual • TABLE OF CONTENTS VII

9.2.7 Contact 140
9.3 Technical Support 141
9.3.1 Regional Contact 141
9.4 VCS Code 141
9.4.1 Grand Master (GM VCS Code) 142
9.4.2 Boundary Clock (BC VCS Code) 143
9.4.3 Others 146
9.5 Persistent Custom Files 147
9.6 TACACS+ and RADIUS server configuration 148
9.6.1 TACACS+ server installation and configuration 148
9.6.2 RADIUS server installation and configuration 149
9.7 List of supported SFPs 150
9.8 List of Tables 151
9.9 List of Images 151
9.10 Document Revision History 153
INDEX
VIII WR-Z16 User Manual • TABLE OF CONTENTS

CHAPTER 1•WR-Z16 User Manual 1
CHAPTER 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

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 doc-
umentation about your WR-Z16.
1.2 About WR-Z16
The WR-Z16 is the reliable precise time fan-out for the most demanding time distribution
applications on 1G Ethernet-based networks.
The WR-Z16 is a standalone device with 16 SFP connectors which provides sub-nano-
second 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 fre-
quency distribution is available through digital clock. The WR-Z16 incorporates failover
mechanisms which combine multi-source redundancy 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 master 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 dia-
gram to illustrate the interoperability with different interfaces.
2CHAPTER 1•WR-Z16 User Manual Rev. v3.4
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
/License 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 con-
figuration 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-nanosecond accur-
acy synchronization from an external time reference to the end nodes of the timing net-
work, where different timing interfaces are provided to inter-operate with third-party
equipment.
1.3 About WRZ-OS
CHAPTER 1•WR-Z16 User Manual Rev. v3.4 3

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.
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 mul-
tiple fans and it has a rear dual power supply. It includes multiple 1PPS/10 MHz on
the SMA or DB9 outputs, standard PTP interoperability on its management inter-
faces, 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 characteristic 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.
Figure 1-2: WR-ZEN TP-FL (left), WR-ZEN TP (middle), WR-ZEN TP-32BNC (right)
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-nano-
second 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) pro-
file, and has the following characteristics:
Time Precision: WR provides a common clock for physical layer in the entire net-
work, allowing synchronization at sub-nanosecond level with picoseconds precision.
In other words, the timing budget consumed by WR is almost insignificant.
4CHAPTER 1•WR-Z16 User Manual Rev. v3.4
1.4 About White Rabbit / High-Accuracy Technology

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 per-
formance is not affected by traffic as with other PTP profiles.
Cost effective solution: WR avoids expensive costs related to calibration and com-
plex deployments with high requirements of maintenance, allowing plug-and-play
links in Local Area Networks (LANs).
Integration: WR is based on existing protocols and standards (such as PTP and Eth-
ernet) so it is very easy to integrate into your existing network infrastructure.
1.4 About White Rabbit / High-Accuracy Technology
CHAPTER 1•WR-Z16 User Manual Rev. v3.4 5

BLANK PAGE.
1.4 About White Rabbit / High-Accuracy Technology
6CHAPTER 1•WR-Z16 User Manual Rev. v3.4

CHAPTER 2•WR-Z16 User Manual 7
CHAPTER 2
Product Description
The Chapter presents an overview of the WR-Z16 Model , its cap-
abilities, 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 14
2.6 Rack Installation 16
2.7 Regulatory Compliance 18

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 recovery/failsafe
mode
"Recovery Mode" on page130
#3 Status LED Green, Orange, Red "System Status" on page10
#4 1x Management
UART (RJ45)
Serial UART RS232 on a RJ45 con-
nector 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 inter-
face (eth0 & eth1)
"Product Specifications" on
page13
#6 16x SFP Fiber
ports
1Gbps SFP compatible "White Rabbit" on page58"IEEE
1588-2008 (PTPv2)" on
page62
Timing input
#7 Timing Input
LED
OK: Green; Warning: Yellow; Critical:
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73
8CHAPTER 2•WR-Z16 User Manual Rev. v3.4
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73
Timing output
#10 Timing Output
LED
OK: Green; Warning: Yellow; Critical:
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47
#12 10 MHz output ● SMA connector (F)
● Digital output
● High level output: 3.0V +/-
0.2V
(with 50 Ω termination)
"Virtual Clock Overview" on
page47
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. v3.4 9

# Name Information Ref.
#2 Power Sup-
ply #1 ● Swappable & monitorable module:
- 100- 240VAC, 50- 60Hz, (80W Max)
#3 Power Sup-
ply #2 ● Swappable & monitorable module:
- 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 Critical alert.
●●● Steady Red There is a Warning or Critical alert related to the device. User
might login to verify the source of the alert.
10 CHAPTER 2•WR-Z16 User Manual Rev. v3.4
2.3 Monitoring LEDs