1. Manuals
  2. Brands
  3. SEVEN Manuals
  4. Network Hardware
  5. WR-ZEN Series
  6. User manual

SEVEN WR-ZEN Series User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
User Guide v3.3
WR-ZEN Family
The family of ultra-accurate WR nodes providing timing through widely
used timing protocols such as PTP, NTP, PPS/10MHz and others
Headquarters
Web:
https://sevensols.com/
Seven Solutions
Sales:
Calle Periodista Rafael Gómez Montero, 2
info.spain@orolia.com
CETIC-UGR 13, 18014
Support:
Granada - SPAIN
support.spain@orolia.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WR-ZEN Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for SEVEN WR-ZEN Series

Summary of Contents for SEVEN WR-ZEN Series

  • Page 1 WR-ZEN Family The family of ultra-accurate WR nodes providing timing through widely used timing protocols such as PTP, NTP, PPS/10MHz and others Headquarters Web: https://sevensols.com/ Seven Solutions Sales: Calle Periodista Rafael Gómez Montero, 2 info.spain@orolia.com CETIC-UGR 13, 18014 Support: Granada - SPAIN...
  • Page 2 v3.3-a 12/07/2022 Chapter 1: Introduction...

  • Page 3: Revisions

    v3.3-a 12/07/2022 Revisions Date Description V3.0-a 24-Jul-2020 Fully updated documentation of wr-zynq-os-3.0 for WR-Z16 family V3.1-a 30-Oct-2020 Improve PTP profiles + sync-E configuration, add new VCS code and fix some OID errors V3.1-b 26-Jan-2021 Fixing missing references in the document V3.2-a 05-Apr-2022 Improving LLDP and NTP section...

  • Page 4: Acronyms

    v3.3-a 12/07/2022 Acronyms Acronyms Description Boundary Clock (Disciplined by a master and discipling slaves) BMCA Best Master Clock Algorithm Free Running (Undisciplined local oscillator) GLONASS Globalnaya Navigatsionnaya Sputnikovaya Sistema Grand Master GNSS Global Navigation Satellite System Global Positioning System High Accuracy Hold-Over HTTP Hypertext Transfer Protocol...

  • Page 5: Highlights Legend

    v3.3-a 12/07/2022 Highlights legend To make important information stand out from the documentation some boxes have been created. The information to highlight has been categorized into 4 groups: Warning Information that warns the user about configurations/actions that could reach possible malfunction or damage.

  • Page 6: Table Of Contents

    v3.3-a 12/07/2022 Table of Content REVISIONS ................................3 ACRONYMS ................................4 HIGHLIGHTS LEGEND ............................5 TABLE OF CONTENT .............................. 6 CHAPTER 1: INTRODUCTION ........................11 1.1 A ......................... 11 BOUT THIS OCUMENT 1.2 A WR ZEN F ........................ 12 BOUT AMILY 1.3 A WRZ-OS ..........................
  • Page 7 v3.3-a 12/07/2022 3.3.4 O ........................... 37 INDOWS 3.4 L ........................40 OGGING FROM WEB CHAPTER 4: GUI & CLI TOOLS ........................43 4.1 I API ................... 43 NTRODUCTION TO ARAMETERS 4.1.1 T ......................44 ABLE REPRESENTATION 4.2 T GUI ........................... 45 HE WEB 4.2.1 N ................
  • Page 8 v3.3-a 12/07/2022 5.9.1 U ....................100 PDATE ECONDS CHAPTER 6: SECURITY & AUTHENTICATION ..................102 6.1 P ......................102 ASSWORD ANAGEMENT 6.2 U ........................103 PLOAD KEYS 6.3 HTTPS ............................103 6.4 TACACS+ ............................. 106 6.4.1 V TACACS+ ..............106 ERIFICATION OF INSTALLATION 6.4.2 TACACS+ C...
  • Page 9 v3.3-a 12/07/2022 8.1.2 C ........................142 HECK ICENSES 8.1.3 O ........................144 RDER ICENSES 8.1.4 L ..................144 OCAL ICENSES ANAGEMENT 8.1.5 L ........................147 ICENSE ERVER 8.2 F ........................149 IRMWARE PDATE 8.2.1 H ................149 ARDWARE VERSION AND FIRMWARE 8.2.2 U ......................
  • Page 10 v3.3-a 12/07/2022 Chapter 1: Introduction...

  • Page 11: Chapter 1: Introduction

    v3.3-a 12/07/2022 Chapter 1: Introduction 1.1 About this Document This document corresponds to the user guide of the WR-ZEN family. It describes the essential information about the WR-ZEN TP hardware, its features, and the configuration options. It has been written to allow users who have their first contact with the device to easily connect it to the management network and distribute precise timing (PTP or WR) through its optical interfaces.

  • Page 12: About Wr Zen Family

    v3.3-a 12/07/2022 1.2 About WR ZEN Family The White Rabbit ZEN Time Providers (aka. WR-ZEN TP) are high performance timing nodes family whose design is based on the Xilinx Serie-7 FPGAs that combines an Artix-FPGA with a Dual-Core ARM. It is composed of the next products: •...
  • Page 13 v3.3-a 12/07/2022 A typical intra-datacenter network topology is shown in the figure below, where the WR-ZEN family devices work as Boundary Clocks and are key elements for distributing the timing through each cabinet of the datacenter. Different end nodes are included in the diagram to illustrate the interoperability with different interfaces.

  • Page 14: About Wrz-Os

    v3.3-a 12/07/2022 1.3 About WRZ-OS The WR-ZEN family is part of a full ecosystem of products which allows to maintain the sub- nanosecond accuracy in the synchronization from the external time reference to the end nodes of the timing network, where different timing interfaces are provided to interoperate with third- party equipment.

  • Page 15: About White Rabbit / High-Accuracy Technology

    v3.3-a 12/07/2022 1.4 About White Rabbit / High-Accuracy Technology One of the key-feature of the WR-ZEN family is that it fully supports the White Rabbit 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, White Rabbit is also known as “PTP High Accuracy”...

  • Page 16: Chapter 2: Product Description

    v3.3-a 12/07/2022 Chapter 2: Product description 2.1 Front panel Figure 2 WR-ZEN TP front panel Name Information Ref.  10/100/1000 ethernet network interface (eth0 Management §0 (§0, §0) Ethernet (RJ45) & eth1)  Slot placed to allow the use of FMC cards FMC expansion port §0 ...
  • Page 17 v3.3-a 12/07/2022  Digital output  High level output: 2.5V +/-0.2V (with 50 Ω termination) Timing input  SMA connector (F) PPS input §0  50 Ω termination  TTL input (3.3V) ● SMA connector (F) 10 MHz input §0 ●...
  • Page 18 v3.3-a 12/07/2022 Figure 2:2 WR-ZEN TP 32-BNC front panel Name Information Ref.  10/100/1000 ethernet network interface (eth0 & Management §0 (§0, Ethernet (RJ45) §0) eth1)  Slot placed to allow the use of FMC cards FMC expansion port  1GBps SFP compatible 2x SFP Fiber Ports §0, §0 ...
  • Page 19 v3.3-a 12/07/2022 Timing input  SMA connector (F) PPS input §0  50 Ω termination  TTL input (3.3V) ● SMA connector (F) 10 MHz input §0 ● 50 Ω termination ● 1 Veff (+/-30%) sine wave  BNC connector (F) Configurable ...
  • Page 20 v3.3-a 12/07/2022 Pin#5: ✖ Pin#7: ✖ Pin#8: ✖ Pin#6: TXD (USB-RJ45/RS232 adaptor not included) Power Supply  Swappable Power Supply #1 §0 & monitorable module: -100-240VAC, 50-60Hz, (80W Max)  Swappable Power Supply #2 §0 & monitorable module: -100-240VAC, 50-60Hz, (80W Max) #17 Ground §0 ...
  • Page 21 v3.3-a 12/07/2022  1GBps SFP compatible 2x SFP Fiber Ports §0, §0  Serial UART Mini-USB (B) 1x ARM Mini-USB (B) UART Timing output  SMA connector (F) 10 MHz output §0 (§0,  Output from PLL §0)  High level output: 2.5V...

  • Page 22: Back Panel

    v3.3-a 12/07/2022 Pin#5: ✖ Pin#7: ✖ Pin#8: ✖ Pin#6: TXD (USB-RJ45/RS232 adaptor not included) Power Supply  Swappable #15L Power Supply #1 §0 & monitorable module: -100-240VAC, 50-60Hz, (80W Max)  Swappable #15R Power Supply #2 §0 & monitorable module: -100-240VAC, 50-60Hz, (80W Max) Ground §0...
  • Page 23 v3.3-a 12/07/2022 slot #J1 Plug’n’play module For swappable modules slot #J2 Plug’n’play module For swappable modules §0 slot #J3 By default, we provide the WR-ZEN-TP with one FAN on slot #J3 Plug’n’play module For swappable modules slot #J4 Ground §0 Ground connector of the device Table 2:4 - Back Panel of the WR-ZEN TP Legend Chapter 2: Product...

  • Page 24: Monitoring Leds

    v3.3-a 12/07/2022 2.3 Monitoring LEDs The status of the WR-ZEN family devices 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- ZEN.

  • Page 25: Sfp Ports

    v3.3-a 12/07/2022 ⬤ ⬤ ⬤ Blinking Device is loading in failsafe mode and for each module skipped ⬤ ⬤ ⬤ Yellow during initialization the device blinks in orange Table 2:5 - Status LED behavior 2SFP Ports 2.3.2 The network ports of the device are arranged in a dual stack SFP cage. The following table represents only the two first ports but can be extrapolated to the other ones.
  • Page 26 v3.3-a 12/07/2022 1x Low-Pin count FMC slot (LPC) ▪ Using HPC-FMC footprint to support extra GTP channel/clock on board SFP Ports 2x 1GbE Clocks I/O 5x SMA coaxial connectors (3.3V/50Ω): ▪ 10MHz SIN OUT ref.clock (PLL) ▪ CLK TTL OUT ▪...

  • Page 27: Wr-Zen Tp-Fl

    v3.3-a 12/07/2022 2.4.2 WR-ZEN TP-FL System On-Chip Xilinx Zynq series Dual ARM® CortexTM-A9 MP@ 866 MHz ▪ 512 MB DDR3 (32-bit bus) Memory ▪ 256 Mbits Quad-SPI Flash ▪ 16GB SD Card Physical Dimension Dimension 444 mm x 43 mm x 221 mm / (1 Rack Unit) Color White (Metallic) Environmental Conditions...

  • Page 28: Wr-Zen Tp-32Bnc

    v3.3-a 12/07/2022 2.4.3 WR-ZEN TP-32BNC System On-Chip Xilinx Zynq series Dual ARM® CortexTM-A9 MP@ 866 MHz ▪ 512 MB DDR3 (32-bit bus) Memory ▪ 256 Mbits Quad-SPI Flash ▪ 16GB SD Card Physical Dimension Dimension 428 mm x 88 mm x 220 mm / (2 Rack Units) Color White (Metallic) Environmental Conditions...

  • Page 29: Safety Notes

    v3.3-a 12/07/2022 2.5 Safety Notes Warning Do not block the air vents which are located on the front panel of the device, the internal temperature might increase and damage the equipment. Warning The FAN modules must only be replaced by a skilled person. Once reinstated, its screw must be tightened up using a flat-blade screwdriver with at least 0.8Nm to avoid any manual manipulation.

  • Page 30: Installing The Switch In A Rack

    v3.3-a 12/07/2022 The use of dust covers is recommended for the unused SFP/SFP+ slots. 2.6 Installing the Switch in a Rack The devices have been designed to be mounted in a standard 19-inch (48.3 cm) equipment rack and thus respect the physical dimensions previously stated. Recommendations The following guidelines are provided to prevent bodily-injury when mounting or servicing this unit in a rack:...
  • Page 31 v3.3-a 12/07/2022 �� Step 4: Align the mounting holes in the L bracket with the mounting holes in the equipment rack posts. �� Step 5: Secure the device using four 3/4-inch screws through the elongated holes in the L bracket and into the threaded holes in the mounting post (or the clip-nuts or cage-nuts). Chapter 2: Product description...

  • Page 32: Regulatory Compliance

    v3.3-a 12/07/2022 2.7 Regulatory Compliance Symbols Legend Caution, risk of electric shock Identify parts of the equipment that have risk of electric shock such as power supplies. Disconnection, all power plugs All power sources shall be disconnected before servicing to avoid shock hazard. Equipotentiality Identify the terminal(s) which, when connected together, bring the various parts of the device to the same potential, not necessarily being the earth...

  • Page 33: Chapter 3: Device Connectivity

    v3.3-a 12/07/2022 Chapter 3: Device connectivity 3.1 Default configuration The ZEN family devices are factory configured with the following default settings: Port/service Default value eth0 Waits for DHCP offer eth1 192.168.77.100 • Slave on WR0 (BC) Timing Preset • WR master on all other ports HTTPS Disabled •...

  • Page 34: Logging From Uart

    v3.3-a 12/07/2022 3.3.1 Logging from UART In order to connect to the WR-ZEN device, it is required to connect the RJ45-RS232(m) and RS232(f)-USB cable to the RJ45 management port at the front panel. Multiple software can be used to read from the UART in the computer depending on the operating system used for that purpose (e.g.

  • Page 35: O Nlinux (Ubuntu 18.04 Lts)

    v3.3-a 12/07/2022 ○ Connect the host interface (your PC) to the same LAN, so that it will get another IP address. ○ Retrieve the IP address assigned to the device using UART or by scanning the local network. DHCP IP address Leaving aside common DHCP leasing, the assigned IP should persist between device reboots, as it will ask for the same address after every bootup.
  • Page 36 v3.3-a 12/07/2022 Where ttyUSB<x> corresponds to the instance of the USB-UART driver. In most of the case, it will be ttyUSB0 (e.g., only one USB-UART cable connected to the PC) and the expected output is as follow: $ sudo picocom -b 115200 /dev/ttyUSB0 Calling 'sudo /usr/bin/picocom -b 115200 /dev/ttyUSB0 -b 115200' Exiting Ctrl+A, then Ctrl+X picocom v2.2...

  • Page 37: O Nwindows

    v3.3-a 12/07/2022 USB device discovery The target device’s name may vary depending on the already connected ones. The dmesg | grep tty command can be used to discover which name has been set to the connected device. This is an example output: [4.616728] cp210x 3-6.1.2:1.0: cp210x converter detected [4.620195] usb 3-6.1.2: cp210x converter now attached to ttyUSB0 In the case of the above output, /dev/ttyUSB0 would be the device’s name.
  • Page 38 v3.3-a 12/07/2022 Figure 3:1 - Device manager. New serial port detected. Afterwards, the connection can be made through Putty, as shown in the Figure 3:2. The connection type should be marked as Serial at <1>.The serial port name COM<number> should be placed at <2>, and the port speed (115200 Bd) at <3>.
  • Page 39 v3.3-a 12/07/2022 Figure 3:2 - Putty configuration for serial port connection. 3.3.4.2 Logging from SSH It is also possible to connect to the device via SSH with Putty The process to connect to the UART using Windows (XP, Vista, 7, 8, 10) is explained below: Download and install the Putty Tool.

  • Page 40: Logging From Web

    v3.3-a 12/07/2022 3.4 Logging from web Once the device is set with an IP address, it can be accessed by typing http://<device_ip> in the browser address bar. By default, https is disabled but if it has been enabled, the address bar should be replaced by https://<device_ip>.
  • Page 41 v3.3-a 12/07/2022 Figure 3:4 - Login page of the web interface. Having logged in, all sections from the web interface will be shown, as in the Figure 3:5. Further instructions on the available features and how to use them in the WR-ZEN's web interface are detailed in the GUI &...
  • Page 42 v3.3-a 12/07/2022 working or is unreachable, will the local credentials be available again. This can render the device accessible only by UART. Chapter 3: Device connectivity...

  • Page 43: Chapter 4: Gui & Cli Tools

    v3.3-a 12/07/2022 Chapter 4: GUI & CLI Tools Depending on its preference a user can use the web GUI or the CLI tools to perform a standalone management of the device. This section will briefly explain the main interactions for both methods and will also provide a detailed example about the configuration of the network interfaces.
  • Page 44 v3.3-a 12/07/2022 Disabled: Currently disabled, writing will not apply anything, and the value read value might be invalid. • Visibility: Expert parameters are by default hidden unless toggling the expert mode. Then, the disabled parameters are meaningless and thus temporary hidden to improve legibility.

  • Page 45: The Web Gui

    v3.3-a 12/07/2022 Table 4:1 - Configuration parameters of the network interface. The second table (Table 4:2) corresponds to the parameters that provide information (read-only) about the corresponding interface: name Value Type Description 1.xxx0.x /net/<iface>/xxx Directory related to the <iface> name where OIDs follow the given pattern: wr0 →...
  • Page 46 v3.3-a 12/07/2022 As shown in section §0, the device requires the user to log in to enable further navigation. Once this step is performed, the web GUI is divided in three main parts. On the left column, a navigation menu is displayed showing all the different tabs available in the device. Figure 4:2 - Settings menu in web interface.

  • Page 47: Network Configuration From Web

    v3.3-a 12/07/2022 Figure 4:3 - Time sources configuration in web interface. Finally, a settings menu on the upper right corner is showed. This menu allows to change the password, enable the expert mode that includes additional parameters and log out from the device.
  • Page 48 v3.3-a 12/07/2022 Then in the CONFIG panel, the user must disable the DHCP option by clicking No in the drop- down list box. If the DHCP is leaved enable (Yes), the IPv4 fields will be blocked as read-only, and the displayed values will be retrieved from DHCP responses. Figure 4:5 - Network interface panel in web GUI.
  • Page 49 v3.3-a 12/07/2022 Figure 4:7 - Warning message to reboot the device so a saved change can take effect. DNS Resolution The last tab of network configuration entitled DNS can be used to add a custom DNS server needed to resolve IP address. This is useful in case an URL is used instead of an IP when configuring the server for a device (e.g., NTP, Auth, etc.).

  • Page 50: Cli Configuration Wrz Config

    v3.3-a 12/07/2022 4.3. CLI Configuration: wrz_config If the user prefers to configure the device from the command line, it is recommended to simply execute the wrz_config command. This tool provides an interactive menu directly from the command line with a structure similar to the web GUI.

  • Page 51: Network Configuration From Cli

    v3.3-a 12/07/2022 Expert parameters To ease the navigation during configuration some expert parameters are by default hidden. In the main, menu the user can toggle a configuration flag to make visible these expert parameters. Changes applied at reboot It is important to highlight that the changes performed through the wrz_config tool will only be applied at next reboot.
  • Page 52 v3.3-a 12/07/2022 Figure 4:9 - wrz_config interface. Network interfaces to change. 4. At this point (Figure 4:7), the user should first disable the DHCP, if the static IPv4 settings must be loaded. Figure 4:10 - wrz_config interface. Interface parameters to change. 5.

  • Page 53: Cli Monitoring Gpa Ctrl

    v3.3-a 12/07/2022 Figure 4:11 - wrz_config interface. File in which to save the new applied configuration. 6. Afterwards, select Exit or press <Esc> to return to the command line. Verify network configuration after reboot Network configuration changes are only applied at startup. Thus, it is recommended to reboot the device to verify that the IP settings has been properly updated using the typical ifconfig <ifname>...
  • Page 54 v3.3-a 12/07/2022 Figure 4:12 - Example of gpa_ctrl usage to list power supplies parameters. It shows the list of related parameters displayed in 5 columns: 1. The state of the parameters. In this example only the status of the right power supply (0.9110.1) is in a critical state (C).

  • Page 55: Applying Changes Online

    v3.3-a 12/07/2022 4.4.2 Applying changes online If a parameter is writeable, this means that it can be directly applied by using the following syntax: gpa_ctrl <module_name> <param_path> <new_value> For example, to disable the alert for the right power supply the user must execute: gpa_ctrl hald pws/pwsr/disable_alert Yes If the command returns without any errors, this mean that the changes have been properly applied.
  • Page 56 v3.3-a 12/07/2022 └─ "Global Status. 0:ok; otherwise:error." 0.9120.2 pws/pwsr/temperature └─ "Temperature ºC" 0.9120.3 pws/pwsr/v_in : 0.000000 └─ "Power Supply: Volts IN" 0.9120.4 pws/pwsr/v_out : 0.000000 └─ "Power Supply: Volts Out" 0.9120.5 pws/pwsr/power_in : 0.000000 └─ "Power consumed from Line Watts" 0.9120.6 pws/pwsr/power_out : 0.000000...

  • Page 57: Other Cli Tools

    v3.3-a 12/07/2022 4.5 Other CLI tools This section enumerates some other tools that are referenced across the user-guide in order to manage the device from the console. • wrz_version: Legacy tool to get information about version of firmware and hardware. •...

  • Page 58: Chapter 5: Timing

    v3.3-a 12/07/2022 Chapter 5: Timing The main purpose of the WR-ZEN family is to distribute ultra-accurate synchronization through a timing network. The device can be configured as a Grand-Master (§5.5 External Reference (GM)0) to retrieve time from an external source and then redistribute it using IEE1588-2008/PTPv2 (§05.5 External Reference (GM)) or White Rabbit (§05.5 External Reference (GM)) protocols.

  • Page 59: Foca: The Failover Clock Algorithm

    v3.3-a 12/07/2022 of PTP+SyncE as timing source, allows to re-distribute timing using WR without significant penalties. NTP Timing source (Survey mode) Due to its poor accuracy, NTP protocol is always in Survey Mode and thus cannot actively discipline the local clock. Then, a maximum total of 5 timing sources of the same or different types can be handled.
  • Page 60 v3.3-a 12/07/2022 ending with the holdover to slowly drift until corrective maintenance. It also illustrates how the two strategies of the FOCA algorithm behave. Figure 5:1 - Multi-timing sources handle by FOCA policy with its two strategies: only fall-down (blue) & re-evaluation (purple) An example of the behavior is given by the scenario illustrated in Figure 5:23 where the following events are shown: Figure 5:23 - FOCA algorithm under scenario 1...

  • Page 61: Virtual Clock Overview

    v3.3-a 12/07/2022 Another key aspect of FOCA is how to determine when there is a “failure” on a timing source. Some cases are obvious such as the link is down, no packets are exchange but other cases can be more complex to identify: all these cases are detailed in the appendix VCS code tables (§0). For a deeper understanding of the behavior of the FOCA algorithm it is recommend reading the section §0 in the appendix where more scenarios are detailed.
  • Page 62 v3.3-a 12/07/2022 Figure 5:4 5- Virtual Clock Overview • Status: Summarizes the timing status with Disabled, OK, Warning & Critical values. It is also related to the “Timing Output LED” §¡Error! No se encuentra el origen de la referencia.). • Active Reference: A text to inform which timing sources have been selected by the strategy (e.g., FOCA) to actively discipline the device.

  • Page 63: General Timing Management

    v3.3-a 12/07/2022 5.2 General Timing Management To ease the configuration of the device the WRZ-OS implements presets to allow a quick setup of the timing sources and of the master ports to redistribute time. If the device has been shipped with the holdover option, this timing source will be, by default, configured as the last timing source independently of the preset.
  • Page 64 v3.3-a 12/07/2022 10MHz signal. The user can use the GM Offset field to compensate this fixed delay. 5.2.1.3 External GNSS Receiver (GM) • The primary timing source is provided using an external GNSS receiver reference through the front-panel 10 MHz and 1PPS inputs (Grand-Master). •...
  • Page 65 v3.3-a 12/07/2022 5.2.1.5 WR Slave @ wr0 / PTP Fan-Out • The primary timing source is provided using WR protocol through interface wr0. • The wr1 is configured as WR master and the ethernet ports (i.e., eth0 & eth1) are configured as PTP masters.
  • Page 66 v3.3-a 12/07/2022 It is highly recommended to avoid integrating a Manual Free-Running device to a timing network in production as in some corner cases the BMCA/FOCA algorithms might select this timing source when it is not the expected choice. 5.2.1.8 Custom The Custom Preset has been designed to permit modifications of any previous presets in order to meet any kind of user needs.
  • Page 67 v3.3-a 12/07/2022 5.2.1.8.1 Fanout ports configuration The presets define the type of protocol selected for all the interfaces. If the user needs a specific combination that mixes WR on some ports and PTP/IEEEE-1588 on others, he/she first select the Custom preset and then configure the Fan-out ports. 5.2.1.8.1.1 Through Web After applying the Custom profile under the Timing >...

  • Page 68: Reference Topology

    v3.3-a 12/07/2022 o If the source rank is set to 0, the port will not be included as a timing source. o This parameter is not used when the port role is Master. Figure 5:8 - Port configuration (e.g., wr0) from CLI tool PTP modes on "Custom"...
  • Page 69 v3.3-a 12/07/2022 Figure 5:9 - Reference topology with different presets. • External Reference Layer: It includes the devices that will be fed by several external references (in grey), such as an Atomic Clock or a GNSS receiver, and will receive ToD (Time of Day) from an NTP server (external or embedded).

  • Page 70: Timing Source Info

    v3.3-a 12/07/2022 Some devices in the reference topology strategically include the holdover option (HO) to ensure continuous operation even if not locked to any timing sources. This option is automatically enabled if detected and the provided presets can be used without any modifications.
  • Page 71 v3.3-a 12/07/2022 3.13x0.6 Is Active <Boolean> Flag that indicates if this timing source has been selected by the policy to actively discipline the virtual clock of our device. Then the timing source can be expanded to show its advanced view by clicking on the button: (➕) Figure 5:11 - Advanced info Timing Source #1.
  • Page 72 v3.3-a 12/07/2022 Chapter 5: Timing...

  • Page 73: White Rabbit

    v3.3-a 12/07/2022 5.3 White Rabbit 5.3.1 Configuration After configuring if White Rabbit is a Slave (Timing Source) or a Master port, the only configuration that might be realized is which Transport Protocol should be used. By default, WR uses the data layer (RAW Ethernet packets - IEEE 802.3) to communicate to other WR devices but it can be configured to also use the UDP/IPv4 packets.
  • Page 74 v3.3-a 12/07/2022 1.1220.11 Delay MS <Decimal> (f64) Calculated Delay between Master and Slave Unit: s considering asymmetry and fixed delays. 1.1220.21 Egress <Decimal> (f64) Fixed latency between the moment when a PTP Latency Unit: ns packet is timestamped to its exit on the physical layer (i.e., optical fiber).
  • Page 75 v3.3-a 12/07/2022 5. Free-Running 1.xx10.20 Peer MAC <Data Array> (6 x MAC address of the latest peer. 1.xx10.23 Peer VID <Integer> (u16) VLAN ID of the connected peer. 1.xx10.25 Peer N Tx PTP <Integer> (u32) Number of transmitted PTP packet on this port. 1.xx10.26 Peer N Rx PTP <Integer>...
  • Page 76 v3.3-a 12/07/2022 1.xx10.5 Ext State 0. Disabled State of the extension. If PTP Only this means that the 1. Active WR extension has not been detected. 2. PTP Only 1.xx10.5 Rx Sync ID <Integer> (u16) Receive Sync Sequence ID. 1.xx10.5 Peer VID <Integer>...

  • Page 77: Ieee 1588-2008

    v3.3-a 12/07/2022 5.4 IEEE 1588-2008 (PTPv2) The IEEE 1588-2008 (PTPv2) module offers interoperability with a wide range of 3 party devices. It has been specifically designed to work as PTP master while supporting the following profiles: • Default • Telecoms profiles: o G.8265.1 o G.8275.1+Sync-E •...

  • Page 78: Configuration

    v3.3-a 12/07/2022 Delay Req ratio [1 msg/128s,128 msg/s] ([-7,7]) 1 msg/sec Clock Quality & Timing Properties Clock Class From VCS or user defined (0-255) Priority1 From VCS or user defined (0-255) Priority2 From VCS or user defined (0-255) Clock Accuracy From VCS (See §0) Unknown Variance...
  • Page 79 v3.3-a 12/07/2022 PTPv2 configuration tab. Section (§0) should be read in case the user needs to modify the role for a specific port. PTP provides many options to support a wide range of applications. Then, the PTP profiles restrain some specific settings in order to limit compatibility to only a subset of PTP.
  • Page 80 v3.3-a 12/07/2022 19.xx13.56 Sync-E <Bool> Disable/Enable Sync-E operation mode 19.xx13.20 Announce <Enums> Rate of announce messages transmitted to be used Rate Default: 1 packet/s BMCA/FOCA. From packet each [2,4,8,16,32,128] seconds to [1,2,4,8,16] packets per second. 19.xx13.21 Sync Rate <Enums> Rate of sync (and follow-up) messages from master Default: 1 packet/s slave (Figure...
  • Page 81 v3.3-a 12/07/2022 Figure 5:16 – Simplified PTP packets exchange for delay measurement (1) End-to-end (2) Peer-to-peer. 5.4.2.1 Configuration of PTP Profiles A valid license is needed to perform the configuration of PTP profiles. The easiest way to configure a specific PTP profile is through the web interface. The user can quickly select its desired profile as illustrated in Figure and then all the related settings will be modified accordingly to fit the selected profile.
  • Page 82 v3.3-a 12/07/2022 5.4.2.1.1 Telecom ITU-T 8275.1 The objective of this profile is to distribute accurate time over a full timing support network with sync-e capability. Range Default name Note Value 19.xx13.x net/<iface>/1/cfg 19.xx13.9 Transport Layer 2 VLAN tags not allowed Protocol (IEEE802.3) 19.xx13.10 Delay Mechanism...
  • Page 83 v3.3-a 12/07/2022 19.xx13.22 Delay Req Rate 1/16 19.xx13.24 PTP Timescale 19.xx13.56 Sync-E Disabled 5.4.2.1.3 Power Profile: IEEE C37.238-2011 This profile has been created to target Power Systems Applications. Range Default name Note Value 19.xx13.x net/<iface>/1/cfg 19.xx13.9 Transport Layer 2 VLAN tags (IEEE802.1Q) Protocol...

  • Page 84: Info/Overview

    v3.3-a 12/07/2022 5.4.3 Info/Overview Each PTP port runs its own PTP instance indendently on a specific process. The information about the instance can be obtained from command line, using for example the following command for the first port (wr0): gpa_ctrl wptpd net/wr0/1/info/ Or through the web interface as shown in Figure , where each port is displayed by a row (see Table 5:5 for more details on the provided parameters).
  • Page 85 v3.3-a 12/07/2022 name Value Type Description 19.xx12.x net/<iface>/1/info/ Information of the corresponding iface port instance. 19.xx12.2 Port State <Enum> Current state of the port that changes according 0. None to the PTP protocol events. • 1. Initializing If this port is configured as a timing source, it 2.
  • Page 86 v3.3-a 12/07/2022 Then if a specific interface is not disabled (Port State ≠ None), by clicling on the (+) a user will expand the interface to its Advanced View to get more information about the PTP exchange. The bi-directional exchanges of PTP is resumed in Figure where the number of packets for each type of messages is provided by the parameters in advanced view (see Table 5:6).

  • Page 87: External Reference (Gm)

    v3.3-a 12/07/2022 (Incrementing for Master instances each time a DelayReq is received) 19.xx62.4 Sync-E State <Enum> State of the sync-E slave 0. Unknown 1. Locked 2. Unlocked 9.xx21.2 SSM Code <Enum> SSM code received by ESMCd client in the last Not Initalized event packet QL PRC...
  • Page 88 v3.3-a 12/07/2022 3.7110.2 Align PPS <Boolean> Enable this to align the PPS output to the PPS input during the locking procedure. It should be enabled when using a GNSS receiver as external reference as PPS might be shifted from 10MHz after each GNSS relock.
  • Page 89 v3.3-a 12/07/2022 5.5.2 Info/Overview The GM timing source provides its own overview panel where the user can easily audit (Figure ) the condition of its external reference. Figure 5:19 - Overview tab for GM timing source. It basically offers a readback of the configuration value (Source Type, Source Rank, Align PPS and PPS Mandatory) as detailed §0, along with an user friendly Message that summarize the state of the GM internal state machine and a Detected value that reports the situation with the external reference inputs signals.

  • Page 90: Ntp

    v3.3-a 12/07/2022 5.6 NTP This section is about the configuration and monitorization related to the NTP protocol. Periodic pooling of NTP offset In the current version of WRZ-OS it is recommended to set the NTP server in every node of the topology, either GM or BC, to check the coherence of the timing reference. 5.6.1 Configuration 5.6.1.1 NTP Provider The WRZ-OS allow the device to provide its time through NTP on the management interfaces...

  • Page 91: Info/Overview

    v3.3-a 12/07/2022 ▪ The first panel provides the configuration shared by all the NTP timing sources: Name Value Type Description 3.7001.x ntp/cfg/xxx Common configuration to all NTP timing sources. 3.7001.2 Refresh Rate <Integer> Time lapse between NTP server queries (in seconds). Default: 30 3.7001.3 Retries <Integer>...

  • Page 92: Stratum Levels

    v3.3-a 12/07/2022 ▪ Undefined 5.6.3 Stratum Levels The NTP stratum is a measure for synchronization distance from the reference clock which might not always reflect the timing performance such as jitter or delay. In other words, a server synchronized to a stratum (n) server will be running at stratum (n+1) where the upper limit for stratum is 15.

  • Page 93: Timing Outputs

    v3.3-a 12/07/2022 5.7 Timing outputs In order to configure the timing outputs placed in the devices, the different setting options can be found in the entry called Timing Outputs, where both the main ports and the expansion ports (if available) can be easily configured. Note that all these configurations can be set through the CLI as well, just like shown in 0.
  • Page 94 v3.3-a 12/07/2022 Figure 5:21 - WR-ZEN TP-FL timing outputs expansion card configuration Regarding the expansion configuration in the WR-ZEN TP-32BNC, four channels (A, B, C, D) can be set attending to several parameters. The mode can be selected among xPPS, 10MHz and IRIG- B for A &...
  • Page 95 v3.3-a 12/07/2022 Figure 5:22 - WR-ZEN TP-32BNC timing outputs expansion card configuration. Blocks A & B configuration It is relevant to mention that when setting the mode in blocs A & B (xPPS, 10MHz, IRIG-B), both outputs will be exactly equal. Currently it is not possible to have different configurations in these two blocks.

  • Page 96: Holdover (Optional)

    v3.3-a 12/07/2022 0.1811.1 User offset <Integer> Change manually to modify the pre-calibration in Default: 0 order to compensate for users' cable length. 0.18xx.x io/output/fmc/fpo/x/xxx Information related to each specific output block. 0.18xx.0 Mode <String> Output provided through the specific block, which can be PPS or 10 MHz, among others.

  • Page 97: Configuration

    v3.3-a 12/07/2022 Learning: In order to maintains the best accuracy during enough time the holdover is learning about its environment using adaptative algorithms. This learning period has been set to 3 days in order to ensure to fulfill the accuracy specifications. a.

  • Page 98: Info/Overview

    v3.3-a 12/07/2022 timing source. Then the user can allow to trigger the holdover between W 3.7210.1 Time to expire <Integer> Time until the holdover is considered out of Default: 79800 specification and expired (default ~24h) 3.7210.2 Force Trigger <Enum> Force to manually trigger the holdover (START) or to 0.
  • Page 99 v3.3-a 12/07/2022 5. ACTIVATED 6. EXPIRED 3.7210.0 Time Learning <Integer> Time the holdover has been in LEARNING state (in seconds) 3.7210.1 Time <Integer> Seconds elapsed since holdover activation Holdover 3.7210.2 Trigger Origin <Enum> Trigger origin of last one launched • NONE •...

  • Page 100: Miscellaneous

    v3.3-a 12/07/2022 5.9 Miscellaneous This section allows to configure various settings that do not fit in any previous categories. The parameters can be seen below: Name Value Type Description 3.8010.x misc/cfg/xxx Miscellaneous Timing configuration. 3.8010.0 Time Zone <String> Configure the device time zone such that local time is properly displayed (web interface, LCD screen).
  • Page 101 v3.3-a 12/07/2022 Figure 5:24 - Manual Leap seconds update. You can modify the leap seconds file using the CLI (all FW versions): Save as a file the "leap-seconds.list" in the link above.Through CLI, use "scp leap-seconds.list root@<IP>: /media/data/usr/local/etc/custom-leap-seconds.list"(replace <IP> with the device's IP) to copy the new file into the device.Reboot the device.

  • Page 102: Chapter 6: Security & Authentication

    v3.3-a 12/07/2022 Chapter 6: Security & Authentication The WR-ZEN family incorporates several mechanisms in order to provide enhanced security to the system. TACACS+ and RADIUS are integrated to enable remote authentication for network access control through a centralized server. Additionally, the secure version of the network protocols used in the system are implemented, e.g.

  • Page 103: Upload Ssh Keys

    v3.3-a 12/07/2022 6.2 Upload SSH keys The first time a device is accessed via SSH by a host, its IP should be added to the known hosts list as illustrated below. Then the password corresponding to the root user will be asked (default password is ‘root’...
  • Page 104 v3.3-a 12/07/2022 The WR-ZEN family includes the possibility of activating HTTPS. This can be done from the web interface by following the next steps: The options about HTTPS can be accessed under: Security > HTTP/HTTPS as shown in the Figure below: Figure 6:2 –...
  • Page 105 v3.3-a 12/07/2022 Figure 6:3 – Using HTTPS with generated certificate. The third option of the menu () allows to upload a certificate from your PC and run HTTPS using that certificate. Figure 6:4 – Using HTTPS with uploaded certificate. Once the secure mode has been activated, an info message will be shown advising that the next connection will be done on HTTPS.

  • Page 106: Tacacs

    v3.3-a 12/07/2022 Finally, the fourth option allows to use Diffie-Hellman parameters in the TLS key exchange. This is optional, but recommended. There are two buttons to generate and download the DH parameters file. Diffie-Hellman generation time To generate the Diffie-Hellman parameters file, it is required to reboot the device and wait up to 20 minutes, or even more in some particular cases.

  • Page 107: Tacacs+ Client Configuration

    v3.3-a 12/07/2022 Figure 6:5 – TACACS setup for verifying the installation. 6.4.2 TACACS+ Client configuration Once the server is configured, it is necessary to configure the client. In this section, the client will be configured on the WR-ZEN family device. For that purpose, gpa_ctrl is used to configure IP and secret.
  • Page 108 v3.3-a 12/07/2022 Figure 6:6 - SSH connection with the WR-ZEN board Figure 6:7 - tac_plus output with debug information TACACS and RADIUS configured in same client When TACACS and RADIUS work and have been configured on the same client device, be careful with the order of the configuration lines in /etc/pam.d/sshd.

  • Page 109: Radius

    v3.3-a 12/07/2022 6.5 RADIUS RADIUS (Remote Authentication Dial In User Service) is a security protocol for AAA (Authorization, authentication and accounting), which is used to provide centralized authentication for users who want to gain access to the network. This section will define the processes necessary to install and configure the RADIUS client on up to two servers on the WR-ZEN family device.

  • Page 110: Radius Client Configuration

    v3.3-a 12/07/2022 Figure 6:8- Set-up RADIUS for verifying the installation 6.5.3 RADIUS client configuration Once the server is configured, the client must be configured as well. This section explains how to do it on the WR-ZEN family. The use of gpa_ctrl allows to configure ip and secret. These parameters can be found in security module: root@zen-305:~# gpa_ctrl -s security auth/radius/server1_ip 172.17.5.39...
  • Page 111 v3.3-a 12/07/2022 Figure 6:9 - SSH connection with the WR-ZEN board Figure 6:10. Freeradius failed attempt with debug information Chapter 6: Security & Authentication...
  • Page 112 v3.3-a 12/07/2022 TACACS and RADIUS configured in same client When TACACS and RADIUS work and have been configured on the same client device, be careful with the order of the configuration lines in /etc/pam.d/sshd. The TACACS configuration line must be added always in first place and after it, the RADIUS configuration line.

  • Page 113: Firewall

    v3.3-a 12/07/2022 6.6 Firewall The WRZ-OS is shipped with the standard iptable firewall that came in most of the Linux distribution. The default rules applied is to forbid everything in the timing network (the optical fiber interface named wrX) so that only the necessary services can be accessed. The table below resume the port that can be accessed: Timing (wrX) Service...

  • Page 114: Chapter 7: Monitoring & Logging

    v3.3-a 12/07/2022 Chapter 7: Monitoring & Logging The WR-ZEN family device includes enhanced monitoring and logging tools to ease its deployment and manageability during operation. 7.1 Syslog Syslog is a standard for message logging. It allows separating the software that generates messages, the system that stores them, and the software that reports and analyzes them.

  • Page 115: Permanent Logs

    v3.3-a 12/07/2022 7.1.1.1 Systemlog In the same way as a normal Linux device, the kernel and the userspace processes send information to a central logger. Its contents can be found at /var/log/systemlog and it centralizes all logs in a unique file via syslog. The log entries have the following format: 06:19:06 zen-425...
  • Page 116 • Collectd databases • Information about uboot and versions Support service The Seven Solutions support service will require the wrz_logdump information in order to debug any issues. Please, download and attach this information when opening a support ticket. All the logging information under /var/log/ is rotated by security reasons. This prevents to use all the available memory in the device in case the log files suddenly increase and is performed automatically when the file size exceeds 5 MB.

  • Page 117: Configuration

    v3.3-a 12/07/2022 Log rotation The rotation only affects the files with extension .log. Other files contained in /var/log/ folder are not affected. 7.1.5 Configuration The logging configuration can be performed through the wrz_config tool in the CLI. Once the tool is launched, the logging configuration parameters can be found under Management >...

  • Page 118: Configuration

    In order to understand the SNMP configuration, it is important to enumerate the configuration files in the device: • /wr/etc/snmp/SEVEN-PRODUCT-MIB.txt: It contains the MIB file with all the SNMP OIDs in the device. • /etc/snmp/snmpd.conf: It contains the global SNMP configuration. This file can be modified to customize the configuration.
  • Page 119 v3.3-a 12/07/2022 Name Value type Description 13.3002.1 Community <String> Name of the community. name (i.e., public) 13.3002.2 Access view <Enum> Access view options. - none: Disable SNMP v1 and - basic: Show basic SNMP information. extended: Show extended SNMP information. - all: Show all SNMP information.
  • Page 120 v3.3-a 12/07/2022 • v3: Parameters for SNMP v3 users and passwords. There are Name Value type Description 13.3X10.1 User name <String> (i.e., Name of the SNMPv3 user. userSNMP) 13.3X10.2 Access view <Enum> Access view options: - none - none: Disable SNMP v1 and v2. - basic - basic: Show basic SNMP information.
  • Page 121 SNMP configuration files customization Seven Solutions is not responsible of any damage caused by the user while manually modifying the SNMP configuration files. If it is needed to restore the default credentials in /etc/snmp/snmpd.conf and /var/lib/snmp/snmpd.conf the following command can be used:...
  • Page 122 v3.3-a 12/07/2022 Alternatively, the groups definition can be modified to create and add communities. For that purpose, the information from the mapping section in /usr/share/snmp/snmpd.conf can be used as a reference to modify the /etc/snmp/snmpd.conf file. 7.2.1.3 Specific SNMPv3 configuration By default, there are four created users in the device: snmpv3 User Auth...

  • Page 123: Snmp Traps

    v3.3-a 12/07/2022 13.3800.7 Change now <Enum> Force the password change. - N: No. - Y: Yes. In order to create additional users in SNMPv3, the /etc/snmp/snmpd.conf can be modified using the createUser instruction: createUser <user_name> <auth> <new_auth_password> <priv> The access_mode for these users can be assigned as following: <access_mode>user <user_name>...
  • Page 124 v3.3-a 12/07/2022 Figure 7:3 - SNMP traps scheme. Main parts: • SNMP Trap: The device sends a trap to a monitoring device; the traps are defined in a MIB file. • snmptrad: It receives the SNMP trap and manages it. •...
  • Page 125 • wrzTrapModKey: Contains the module name associated to the generated trap. The best way to review our traps definitions is read trap section in SEVEN-PRODUCT-MIB.txt file. You can find this file inside your device at /wr/etc/snmp/SEVEN-PRODUCT-MIB.txt. 7.2.2.2 Trap notifications There are different events that trigger the generation of a trap in the device including startup, shutdown, module open or close and parameter status.
  • Page 126 v3.3-a 12/07/2022 13.3900.1 Community <String> Name of the community. name (i.e., public) 13.3900.2- NMS IP 1-4 <IP address> Destination NMS IP address. (i.e., 192.168.1.5 or 192.168.1.0/24) 13.3900.6 Start/shutdown <Enum> Enable/disable startup and shutdown traps. - Enabled. - Disabled. 13.3900.7 Modules <Enum>...
  • Page 127 $1 $host $ip $vars After this step, it is important to copy the MIB file from the device into the NMS. sudo root@deviceip:/wr/etc/snmp/SEVEN-PRODUCT-MIB.txt /usr/share/snmp/mibs Finally, the snmptrapd service must be stopped and re-run to view all the received traps.

  • Page 128: Lldp

    v3.3-a 12/07/2022 7.3 LLDP The WR-ZEN family device supports the Link Layer Discovery Protocol (LLDP), which functions at the link layer (Layer 2 of OSI model) to discover neighboring devices and their capabilities. 7.3.1 Standard (IEEE 802.1AB-2005) TLVs The WRZ-OS supports the mandatory and standard TLVs defined by the LLDP (IEEE 802.1AB-2005) protocol as listed below: •...

  • Page 129: Info/Overview

    v3.3-a 12/07/2022 20.1100.0 Enable <Boolean> Enable sharing/collecting information between direct neighbors using LLDP. 7.3.3 Info/Overview Only from command line In the current release (v3.1.x), LLDP information is not displayed by the web interface and can be only visualized from SNMP or using the CLI. For each active network interface, LLDP will send its own information to the corresponding peer and recollect the information from the same peer if compatible with LLDP.
  • Page 130 v3.3-a 12/07/2022 20.xx12.x net/wrX/peer/1/dev/timing Information about the timing configuration of the neighbor 20.xx12.1 Status <String> General status of the peer device. (i.e., Ok) 20.xx12.2 VCS Code <Integer> Virtual clock use case code. (i.e., 20001) 20.xx12.3 Message <String> Extra information for the vcs_code (Locked state, (i.e., Locked warning condition, etc).

  • Page 131: Healthing

    v3.3-a 12/07/2022 7.4 Healthing The healthing module provides general information about the system health for monitoring purposes. This includes information about the fans, power supplies, memories, or temperature between others. 7.4.1 Information/Overview The associated parameters can be accessed through the Healthing tab in the web GUI or the command line: Name Value type...
  • Page 132 v3.3-a 12/07/2022 Additionally, to these parameters, the system defines several smart alerts that comprise the information from several parameters to ease the monitoring, providing a quick overview of the general status: Name Value type Description 2.1002.1 Global state <Enum> Global status including timing and system 0.

  • Page 133: Configuration

    v3.3-a 12/07/2022 2. Stopped 3. I2C Error 0.92x0.2 Status Back <Enum> Status of the back ventilator of fanX module. 4. OK 5. Unplugged 6. Stopped I2C Error 7.4.2 Configuration Inside the healthing module, there are a few parameters that can be configured: Figure 7:5 - Healthing configuration through CLI.

  • Page 134: Lcd Screen Menu

    v3.3-a 12/07/2022 0.9220.5 Fan 1 disable <Enum> Disable fan 1 alerts. - No alert - Yes 7.5 LCD screen menu The WR-ZEN TP family includes an LCD screen where you can see some configuration values and the state of the device. 7.5.1 Screen Saver This is the screen you usually see when not interacting with the device.

  • Page 135: Main Menu

    v3.3-a 12/07/2022 This screen shows the general status of your device. Status can be: • Ok: All is ok. • Alert: There is at least a parameter with warning values. • Critical: There is a problem with at least one parameter value or module. If you press INFO/CTRL button, the main menu will show.
  • Page 136 v3.3-a 12/07/2022 1. REVIEW PARAMETERS This screen shows the global status of the modules running in the device. • S: Status: o OK: all is ok. o ! (warning): at least one parameter in warning range. o X (critical): at least one parameter in critical range, or there is a problem with the module.
  • Page 137 v3.3-a 12/07/2022 Where is the number of parameters in that condition. If you select any of the above options, the screen will show information about the parameters that caused the special status. If there are 0 parameters with a special status, it will not enter the sub-menu.
  • Page 138 v3.3-a 12/07/2022 When you select ETH0 or ETH1 option the details of the Ethernet interface will appear: When you select WR0 or WR1 option the details of the White Rabbit interface will appear. 3. WR STATS In this sub-menu you can review the information about white rabbit: 4.

  • Page 139: External Monitoring Tool

    v3.3-a 12/07/2022 In this section you can perform simple predefined actions like rebooting the device or restore the default configuration. The options are: • POWER OFF: Power off the device in a safe way. • REBOOT: Reboot the device. • REBOOT WR: Reboot white rabbit. •...
  • Page 140 v3.3-a 12/07/2022 Figure 7:6 - Monitoring tool dashboard. The monitoring tool allows the user to be conscious of the device status and the specific topology designed on their network. It is useful to control some parameters as the offset from master time.
  • Page 141 v3.3-a 12/07/2022 The application also helps to prevent issues in the network due to periodic controls that can be performed. Furthermore, an alert storage functionality is added to the tool, allowing the user to obtain the anomaly reason in a quick and easy way. Chapter 7: Monitoring &...

  • Page 142: Chapter 8: Device Maintenance

    Overview as shown in the figure below: Matching Device hardware Seven Solutions distributes different WRZ-OS firmwares according to the hardware family and version of the device. The user must follow indications provided in §0 to get the corresponding firmware before proceeding to its update.
  • Page 143 v3.3-a 12/07/2022 Figure 8:1 - Checking available licenses. Each possible license available for the WR-ZEN family device is represented by a single box where its status is summarized by the color of the box: • Grey: License is not available (See Figure 8:1 - Checking available licenses.). •...

  • Page 144: Order Licenses

    Once the purchase has been confirmed, an email will be sent providing the credentials to access to the Seven Solutions Licenses Portal. 8.1.4 Local Licenses Management In order to perform local licenses management by directly uploading licenses files to the device the user first needs to login to the license portal by clicking on the following link: https://flex1667.flexnetoperations.com/flexnet/operationsportal/logon.do...
  • Page 145 v3.3-a 12/07/2022 • This panel (Figure ) allows to map any purchased licenses to this specific device. The user only needs to specify the quantity of a given feature license to associate to the device and save it. Figure 8.3 - Mapping Purchased Licenses to Device. •...
  • Page 146 In case a local license needs to be used in another device the user should first remote it from the previous device before associating it to the new one. • Access Seven Solutions Flexera Portal. Go to the “previous" device. •...

  • Page 147: License Server

    (e.g., an offline/backup device will not consume any licenses until it is connected to the network). In order to get more information about this alternative, contact Seven Solutions that will provide assistance on the solution that best fits the topology and help through its setup.
  • Page 148 v3.3-a 12/07/2022 Chapter 8: Device Maintenance...

  • Page 149: Firmware Update

    SSH/SCP. Matching Device hardware Seven Solutions distributes different WRZ-OS firmwares according to the hardware family and version of the device. The user must follow indications provided in §0 to get the corresponding firmware before proceeding to its update.

  • Page 150: Using Web Interface

    v3.3-a 12/07/2022 8.2.2 Using Web interface Once the web GUI of the device has been properly opened (See §0), navigate to the Management > Firmware Update panel. • The corresponding firmware tar ball can be drag-n-dropped or Browse from the PC. •...

  • Page 151: Using Ssh/Scp

    v3.3-a 12/07/2022 • In case an incompatibility (Figure ) has been detected, the user should NOT continue with the flashing procedure except if the support team has confirmed that this is the way to fix a specific problem. Figure 8:7 - Force flashing incompatible firmware. 8.2.3 Using SSH/SCP A new firmware can be updated using SSH and SCP protocols.

  • Page 152: Recovery Mode

    v3.3-a 12/07/2022 Warning: The version to be flashed is older than the current one, therefore the default password and user are going to be set. The device will be automatically rebooted... This will reset device factory version your modifications will be lost Do you want to continue? [y/N] ? 8.3 Recovery Mode If an error has occurred (e.g., power down, wrong firmware) during a firmware update procedure...

  • Page 153: Manual Recovery Mode

    v3.3-a 12/07/2022 Figure 8:8 - Management panel in recovery mode Configuration: One of the first things to do when a device is in recovery mode is to try to back-up its configuration, so it is easy to import it back or load it to another device. Reboot: Then, try to reboot the device as the recovery mode has already performed an automatic filesystem check and cleaning.

  • Page 154: Factory Config Mode

    v3.3-a 12/07/2022 Wait until the recovery image is loaded from QSPI dataflash (This can take more than 1 minute). 8.3.1.2 From Serial UART The recovery mode can also be started from Uboot console (Connected to the serial RJ45-UART) when it is not possible to access the reset button: Press any key when seeing: Loading wr7shw preboot...

  • Page 155: Failsafe Mode

    v3.3-a 12/07/2022 8.5 Failsafe Mode The Failsafe mode allows to only load the minimal Linux services (i.e., logging, network, ssh, web) but using the normal firmware stored in SD card. It has been mainly designed for advanced users that might have blocked the startup of the device through a bad customization of init.d services. So, if after a failed customization, a device does not provide usable access to its console (ssh or UART), the failsafe mode can be entered by following the procedure: 1.

  • Page 156: Chapter 9: Troubleshooting

    v3.3-a 12/07/2022 Chapter 9: Troubleshooting This section intends to help the user understand how to identify an issue in the WR-ZEN family, as well as giving some guidance to figure out the cause of the problem. 9.1 Frequently answered question (FAQ) A list of the most commonly asked questions will be described here, as well as the solutions that can be applied for each of the situations.

  • Page 157: Health General Status

    v3.3-a 12/07/2022 9.2 Health general status In order to check the device general status, there are multiple alternatives: • SSH / mini-USB UART: If you connect to the device via SSH/UART you will be able to check the WR-ZEN sync status by typing: gpa_ctrl healthingd gpa_ctrl tmgrd vclock/info/...

  • Page 158: How To Report An Error

    If one of the devices experiments any technical issues, it would be recommendable to contact the Seven Solutions Support Team, which will be in charge of addressing the problem. These are the steps that should be followed in case a problem happens.
  • Page 159 v3.3-a 12/07/2022 Severity="info") local0.* @<rsyslog server1 IP> local0.* @<rsyslog server2 IP> Chapter 9: Troubleshooting...

  • Page 160: Warranty

    For warranty or non-warranty replacement please write to our Support Team at TimingSupport@orolia.com. 9.7 Contact For more information about our company and products please contact us: Website www.sevensols.com Address Seven Solutions S.L. Calle Periodista Rafael Gómez Montero, CETIC-UGR 18014 Granada – SPAIN Phone (+34) 958 285 024 Email info.spain@orolia.com...

  • Page 161: Chapter 10: Appendix

    v3.3-a 12/07/2022 Chapter 10: Appendix 10.1 VCS Code The Virtual Clock Status Code has been created to easily identify the timing status of a device and easily troubleshoot in case it has failed. The VCS code are also used by the FOCA algorithm to detect a failure within a timing source and switch to the next available one.

  • Page 162: Boundary Clock (Bc Vcs Code)

    v3.3-a 12/07/2022 We have the same reference on all the network but Locked: Time of given valid: GM: Front- WARNING Day was not set During boot we can not reach NTP server (timeout panel (NTP error) or IP not configured). The ToD used is provided by release ToD or last shutdown ToD.
  • Page 163 v3.3-a 12/07/2022 Lost connected The Link has been lost due to a link down (VSC- CHANGEOVER reference - link 20301), but holdover was learnt (READY) and was Holdover down quickly and automatically triggered (ACTIVATED) The BC clock has link with upstream device but WR/PTP Internal does not properly receive any PTP announce...
  • Page 164 v3.3-a 12/07/2022 Passive: The GM is in this network is in Free-Running. This Upstream GM in CRITICAL* WR/PTP @ passive timing source can become active only if no Free-Running ifname better time source is available. GM announce itself to be now in FR, if we have an Upstream GM in CHANGEOVER active HO we should exit through this state and fail...

  • Page 165: Others

    v3.3-a 12/07/2022 10.1.3 Others Clock Messager Active Description Class VSC- HO Status Referenc For ports, "Ready" means that the link is up and some announce messages sent by a master has Timing source is ready X been received. For GM, "Ready" means that 10M/PPS has been detected properly In case we get an unexpect behavior because some of the src modules (ppsi,ptpd,gnss,hald)
  • Page 166 v3.3-a 12/07/2022 The device was previously in a HO exit state but a enter the holdover time source until it has fin expired. 7>187 Internal HO CRITICAL Holdover Expired Even if we will still be connected internally to the 187>248 Oscillator clock, we announce ourself exactly like FR and we all reset...

  • Page 167: Failover Scenarios

    v3.3-a 12/07/2022 10.2 Failover scenarios Coming soon… 10.3 Persistent Custom Files When an expert user needs to modify some configuration with custom settings (e.g., complex firewall rules) or wants to add new tools to the “official” firmware, he can use the custom mount directories mechanisms: This allow to store persistent files by placing them into the second ext4 partition on the SD drive mounted as /media/data which will be then mounted at next boot into the operating system directories:...

  • Page 168: Timing Outputs

    v3.3-a 12/07/2022 10.4 Timing outputs In the following chart, the relevant electrical information about the timing outputs in several WR- ZEN family devices is shown. Note that some of these devices are equipped with expansion cards (e.g., FPO in the case of the WR-ZEN TP-FL). Termination at the Device Channel...

  • Page 169: Tacacs+ And Radius Server Configuration

    v3.3-a 12/07/2022 10.5 TACACS+ and RADIUS server configuration 10.5.1 TACACS+ server installation and configuration In order to install TACACS+ on a server with Ubuntu 18.04, it is possible to use APT to install version 4.0.4 of the package tacacs+ by using the following command: apt-get install tacacs+ After this, it can be verified if the service is running by using the command: service tacacs_plus status...

  • Page 170: Radius Server Installation And Configuration

    v3.3-a 12/07/2022 If the WR-ZEN has been used as the client, the password must be configured for the root user. Registration of new users is not allowed in this device so root is the only existing user. After finishing with the settings, it is necessary to restart the protocol by using the following command: service tacacs_plus restart 10.5.2 RADIUS server installation and configuration...
  • Page 171 v3.3-a 12/07/2022 The configuration of the users can be done in the file /etc/freeradius/3.0/users by using the following lines: username Cleartext-Password "userpassword" [other-configs] An example can be: test-radius Cleartext-Password := "password" If the WR-ZEN has been used as the client, the password must be configured for the root user.
  • Page 172 12/07/2022 Web: Headquarters https://sevensols.com/ Seven Solutions Sales: Calle Periodista Rafael Gómez Montero, 2 info.spain@orolia.com CETIC-UGR 13, 18014 Support: Granada - SPAIN support.spain@orolia.com Chapter 10: Appendix...

This manual is also suitable for:

Wr-z16

Table of Contents