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

Safran WR-ZEN Series User Manual

Hide thumbs Also See for WR-ZEN Series:
Table of Contents

Advertisement

Quick Links

Download this manual
ELECTRONICS & DEFENSE
WR-ZEN
SERIES
User Manual
Revision: v5.1
Date: 23-February-2024

Advertisement

Table of Contents
loading

Related Manuals for Safran WR-ZEN Series

Summary of Contents for Safran WR-ZEN Series

  • Page 1 ELECTRONICS & DEFENSE WR-ZEN SERIES User Manual Revision: v5.1 Date: 23-February-2024...
  • Page 3 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,...
  • Page 4 Blank page. WR-ZEN Series User Manual...

  • Page 5: Table Of Contents

    2.5 Safety Notes 2.6 Rack Installation 2.7 Regulatory Compliance 2.7.1 EMC 2.7.2 Safety 2.7.3 RoHS CHAPTER 3 Device Connectivity 3.1 Default Configuration 3.2 Connecting to the Device 3.2.1 Necessary Items for Connectivity • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 6 4.3 The Web GUI 4.3.1 Network configuration from web 4.4 CLI Configuration 4.4.1 Network configuration from CLI 4.5 CLI Monitoring 4.5.1 Listing parameters 4.5.1.1 Readback a specific parameter 4.5.2 Applying changes online • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 7 5.2.1.12 PTP Slave @ wr0 (BC) / PTP 5.2.2 Reference topology 5.2.3 Timing source info 5.3 White Rabbit 5.3.1 Configuration 5.3.2 Info/Overview 5.3.2.1 Active servo 5.3.2.2 Port Instance 5.4 IEEE 1588-2008 (PTPv2) 5.4.1 License 5.4.1.1 PTP license management • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 8 6.4 RADIUS 6.4.1 RADIUS configuration files 6.4.2 Verification of RADIUS installation 6.4.3 RADIUS client configuration 6.5 Firewall 6.5.1 Example to only allow a specific IP for management CHAPTER 7 Monitoring & Logging • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 9 7.6.1.1 Database Schema 7.6.1.2 Accessing the RAW Data using the API 7.6.2 Runtime Statistics 7.6.2.1 Accessing Runtime Statistics from the CLI 7.6.2.2 Accessing Runtime Statistics through SNMP 7.6.2.3 Accessing Runtime Statistics through the REST-API • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 10 APPENDIX Appendix 9.1 Acronyms 9.2 Troubleshooting 9.2.1 Frequently asked questions (FAQ) 9.2.2 Health general status 9.2.3 Virtual State Clock Code Error 9.2.4 HTTPS Firefox Error 9.2.5 How to report an error • TABLE OF CONTENTS VIII WR-ZEN Series User Manual...
  • Page 11 9.9 TACACS+ and RADIUS server configuration 9.9.1 TACACS+ server installation and configuration 9.9.2 RADIUS server installation and configuration 9.10 List of supported SFPs 9.11 List of Tables 9.12 List of Images 9.13 Document Revision History INDEX • TABLE OF CONTENTS WR-ZEN Series User Manual...
  • Page 12 BLANK PAGE. • TABLE OF CONTENTS WR-ZEN Series User Manual...

  • Page 13: Introduction

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

  • Page 14: About This Document

    1.1  About this Document About this Document This document is the main user guide of the WR-ZEN Series. It describes the essential information about the WR- ZEN hardware, its features, and con- figuration 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.

  • Page 15: About Wrz-Os

    IP CORE. This license might be available per port or within a pack. About WRZ-OS The WR-ZEN is part of a full ecosystem of products which maintain sub-nano- second accuracy synchronization from an external time reference to the end CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

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

    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 CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 17 Local Area Networks (LANs). 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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 18 1.4  About White Rabbit / High-Accuracy Technology BLANK PAGE. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 19: Product Description

    CHAPTER 2 Product Description The Chapter presents an overview of the WR-ZEN Series, its capabilities, main technical features and specifications. The following topics are included in this Chapter: 2.1 Front panel 2.2 Rear panel 2.3 Monitoring LEDs 2.4 Product Specifications 2.5 Safety Notes...

  • Page 20: Front Panel

    ● By default, it is con- figured to output 10MHz "Virtual Clock Overview" on PPS output ● SMA connector page 63 Digital output ● ● High level output: 2.5V +/- 0.2V (with 50 Ω ter- mination) Timing input CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 21 "LCD screen menu" on LCD Display ●Panel for alert & con- page 150 figuration information "Recovery Mode" on page 175 Power/Reset ●Power On/Off the device and Alarm button perform a factory reset CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 22: Table 2-2: Front Panel Of The Wr-Zen Tp 32-Bnc Legend

    (with 50 Ω termination) "Virtual Clock Overview" on CLK TTL out- ● SMA connector page 63 ● High level output: 2.5V 0.2V (with 50 Ω termination) ● By default, it is con- figured to output 10MHz CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 23 8x Con- ● BNC connector figurable Digital output ● PPS/10 MHz ●High level output (Select- able 50Ω termination): ● 3V +/- 0.2V (with 50Ω termination) ● 3.3V +/- 0.2V (without 50Ω adaptation) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 24 Power Supply ●Swappable & monitorable #16 L Power Supply module: - 100- 240VAC, 50- 60Hz, (80W Max) Power Supply ● Swappable & mon- itorable module: - 100- 240VAC, 50- 60Hz, (80W Max) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 25: Table 2-3: Front Panel Of The Wr-Zen Tp-Fl Legend

    (with 50 Ω termination) "Virtual Clock Overview" on CLK TTL out- ● SMA connector page 63 ● High level output: 2.5V 0.2V (with 50 Ω termination) ● By default, it is con- figured to output 10MHz CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 26 Pin #3 Pin #4 ✖ ✖ Pin #6: Pin #7: Pin #8: #5: ✖ ✖ ✖ Power Supply ●Swappable & monitorable #15 L Power Supply module: - 100- 240VAC, 50- 60Hz, (80W Max) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 27: Rear Panel

    #J1 Plug-and-play mod- For swappable modules ule slot #J2 Plug-and-play mod- For swappable modules - By default, we provide the WR- ule slot #J3 ZEN-TP with one FAN on slot #J3 CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 28: Monitoring Leds

    Reset button is held during the booting procedure: ●● ● ing Red & - If released: entering recovery mode Green - If hold > 15s: entering reset factory mode ●●● Steady Red Device is booting in recovery mode ●●● CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 29: Sfp Ports

    Blinks in orange each time a packet is received on this port Link down When link is down led C is dis- ▼ abled ▼ Link up When link is up the led C stays in green CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 30: Product Specifications

    10MHz SIN OUT ref.clock (PLL) CLK TTL OUT PPS OUT (LVTTL) PPS IN (LVTTL) 10MHz IN (TTL/CMOS/ECL/clipped sine) Timing: Common outputs to provide Timing 2xRJ45, ToD (NMEA) RS485 2xDB9, 4x configurable* xPPS/CLK CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 31: Wr-Zen Tp-Fl

    Clocks I/O: 5x SMA connectors (3.3V @50Ω): 10MHz SIN OUT ref.clock (PLL) CLK OUT (LVTTL) PPS OUT (LVTTL) PPS IN (LVTTL) 10MHz IN (TTL/CMOS/ECL/clipped sine) LCD: Information panel for alert & network CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 32: Wr-Zen Tp-32Bnc

    Fanout: 32 BNC configurable outputs divided in 2 groups (1.7V/50Ω): A&B: 10MHz (xPPS under license) with 50Ω termination C&D: xPPS, IRIG-B with selectable 50Ω termination LCD: Information panel for alert & network Debug: USB Mini-B (ARM-UART) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 33: Safety Notes

    SAFETY: Before You Begin Installation DANGER! 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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 34 Temperature: -10°C ~ +50°C; Humidity; 0% ~ 90% RH Note: The use of dust covers is recommended for the unused SFP/SFP+ slots. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 35: Rack Installation

    2. Use a tape measure to verify the interior dimensions of the rack. 3. Carefully lift the device and position the rear of the device between the equipment rack mounting posts and slide the device into the rack until the CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 36: Regulatory Compliance

    L bracket and into the threaded holes in the mounting post (or the clip-nuts or cage-nuts). Regulatory Compliance 2.7.1 EN55032:2015 AC:2016 EN55035:2017 EN61000-3-2:2014 EN61000-3-3:2013 FCC: 47 CFR Part 15B (10–1–15 Edition) ICES-003 Issue 6 2.7.2 Safety IEC 62368-1:2014 AC:2015 A11:2017 2.7.3 RoHS 2011/65/UE 2015/863/UE CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 37: Device Connectivity

    CHAPTER 3 Device Connectivity This chapter includes instruction to aid in device connectivity. The following topics are included in this Chapter: 3.1 Default Configuration 3.2 Connecting to the Device CHAPTER • WR-ZEN Series User Manual...

  • Page 38: Default Configuration

    Logging from the 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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 39: Logging From Ssh

    Connect the RJ-45 Ethernet cable to the eth0 interface and to a LAN network with a DHCP server. Connect the host interface (your PC) to the same LAN, to obtain another IP address. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 40: Connecting On Linux (Ubuntu 18.04 Lts)

    $ 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 port is : /dev/ttyUSB0 lowcontrol : none baudrate is : 115200 parity is : none CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 41: Logging In From Ssh

    Ubuntu distributions (and many others) have already installed all ssh- related tools necessary to connect to the device. The user does not need to perform any specific steps and can directly follow instructions detailed in "Logging from SSH" page 27. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 42: Connecting On Windows

    3.2.5.1 Logging in from UART The connection to the UART in the WR-ZEN Series can be made by using Putty, the SSH and Telnet client for Windows, as it supports serial connections too. When having connected the RJ45-RS232-USB cable to the Windows PC, a new serial port identified by COM<number>...

  • Page 43: Logging In From Ssh

    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>. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 44 Dashboard page of the web interface Further instructions on the available features and how to use them in the WR- ZEN's web interface are detailed in the "GUI & CGI Tools" on page 33 section. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 45: Gui & Cgi Tools

    The following topics are included in this Chapter: 4.1 Parameters API Introduction 4.2 The REST-API 4.3 The Web GUI 4.4 CLI Configuration 4.5 CLI Monitoring 4.6 Other CLI tools CHAPTER • WR-ZEN Series User Manual...

  • Page 46: Parameters Api Introduction

    Write: can directly apply (online) the value. Load: can save the value (it will be applied at next restart). Disabled: Currently disabled, writing will not apply anything and the value read value might be invalid. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 47: Table 4-1: Configuration Parameters Of The Network Interface

    Directory related to the <iface> name where OIDs follow the given pattern: wr0 → 201x, wr1 → 211x, ..., wr15 → 361x & eth0 → 680x, eth1 → 690x. 0.xxx0.7 DHCP <Bool> Enable/Disable the DHCP IPv4 discovery. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 48: Table 4-2: Information Related To The Network Interface

    Transmitted bytes on <iface>. (u32) 0.xxx0.12 Rx Bytes <Integer> Received bytes on <iface>. (u32 0.xxx0.13 Tx Errors <Integer> Transmission errors on <iface>. (u32) 0.xxx0.14 Rx Errors <Integer> Reception errors on <iface>. (u32 CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 49: The Rest-Api

    Postman or via its own applic- ation. Also, the REST-API is testable directly from the documentation page. 4.2.2.1 HTTP Methods The user can interact with the device using four HTTP methods: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 50: Get Formats

    The computed metrics for the parameter. Note: To know the supported values of a parameter, the user shall make a complete query where the enum object will show the valid range. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 51: Accessing The Rest-Api Through The Documentation Page

    Obtain an authentication token by clicking the “Authorize :lock: “ button on the top of the page and inserting the credentials: Open the Authorize dialog for obtaining a token: Enter the credentials in the Authorize form. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 52 Once the token was correctly obtained, proceed to close the dialog and tests the REST-API. Choose a parameter and a method. If using the “GET” method, choose also a “format”. For example: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 53 4.2  The REST-API Open the `GET /v1/preset` method and click in “Try it out”. Choose a format string (for example: complete) and click in “Execute”. Check the response of the request. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 54: Accessing The Rest-Api Through Postman

    API calls without having to develop test software, and the format of the data returned can be easily analyzed for inclusion into scripts or applications that can consume the data. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 55: Downloading And Installing Postman

    URLs used previously will be suggested via auto-complete. Note that parameters entered in the URL input field bar or in the key/value editor will not automatically be URL-encoded. To manually encode the CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 56: Importing The White Rabbit Collection

    Capture documentation for requests in a description field. 4.2.4.4 Importing the White Rabbit Collection Safran’s Postman™ collection for White Rabbit Time Servers provides examples of how to pull and send data through the API. To import this collection: CHAPTER •...

  • Page 57: Configuring The 'Baseurl

    “White Rabbit Solutions”, and in the “Variables” tab, edit the Current Value of the baseUrl variable and set it to http://<ip>:8201/, where <ip> valid address that reach device (e.g. http://10.22.26.106:8201/ ) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 58: Obtaining The Access Token

    In the request editor, edit the username and password variables with the appropriate values for the device. Click on the “Send” button. In the response window, copy the value of the returned “access_ token” CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 59: Making A Request

    For doing this: Open the desired request in the sidebar (for example, /v1/preset/Read Pre- set). Navigate to the “Authorization” tab. Introduce the access token. Click on the “Send” button. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 60: The Web Gui

    (or your updated credentials). A dashboard tab will then be shown with the main information of the device, product image, status panel, basic timing information, system and version information, and network con- figuration. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 61 The Management Menu links to pages for Info, Logging, Maintenance, Firmware Update, System Alerts, Licenses, and Import/Export config. The Product Image provides real-time depictions of the status of any con- nected ports or power supplies (functioning interfaces will appear GREEN). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 62: Network Configuration From Web

    IP for eth0 network interface follows. After logging in to the unit, select the Administration drop- down in the Main Navigation bar, and then select the Network page: Figure 4-4: Web GUI Network Page Navigation CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 63 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.). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 64: Cli Configuration

    The user can then navigate between the different menus and sub-menus using arrow keys and the <Select> and <Exit> actions. To get more information about a specific parameter such as its description or its corresponding OID the user can press the <Help> action. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 65: Network Configuration From Cli

    To set the IP address for the eth0 management interface: 1. The first step is to execute the wrz_config command from a terminal. Then, the Network section must be selected from the main menu: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 66 Interface parameters to change Do not forget to <Save> the changes once the configuration is done. The following message will prompt. To load this configuration at next reboot the default filename (.config) must be used. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 67: Cli Monitoring

    If the user directly executes gpa_ctrl without any arguments, it will list all the parameters of the WRZ-OS. Then, by specifying some arguments and options the user can slightly modify its usage. gpa_ctrl [OPTIONS] [<module_name> [<path> [<write_val>]]] CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 68: Readback A Specific Parameter

    It might also be interesting to only readback a specific parameter. To only get the status of the left and right power supplies the user should execute: root@zen-425:~# gpa_ctrl hald pws/pwsl/status; echo $? root@zen-425:~# gpa_ctrl hald pws/pwsr/status; echo $? Warning: C pws/pwsr/status NOT DETECTED CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 69: Applying Changes Online

    To improve legibility, the parameters can be displayed in a tree view by adding the –t flag: The user can get more information about the parameters by using the verbose flag -v: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 70: Other Cli Tools

    How to report an error" on page 186). More information about each tool can be found in their respective section or simply by adding the -h flag to output the help message embedded in the execut- able. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 71: Timing

    Timing The following topics are included in this Chapter: 5.1 Multi-sources & Resiliency 5.2 General Timing Management 5.3 White Rabbit 5.4 IEEE 1588-2008 (PTPv2) 5.5 External Reference (GM) 5.6 NTP 5.7 Holdover 5.8 Miscellaneous CHAPTER • WR-ZEN Series User Manual...

  • Page 72: Multi-Sources & Resiliency

    The FOCA has been designed for the purpose of automatically switching from one timing source to another by applying the following policy: In case of failure of the active timing source, switch to the next ready timing source. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 73 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 the next image where the following events are shown: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 74 ("Grand Master (GM VCS Code)" on page 189). For a deeper understanding of the behavior of the FOCA algorithm it is recom- mend reading the section "Others" on page 196 in the appendix where more scen- arios are detailed. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 75: Virtual Clock Overview

    NTP, NMEA, etc. The following figure displays the overview panel of the virtual clock information when the device is using an external reference from front-panel (GM) as the act- ive source. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 76 Code and provides a precise but simple way to identify the current timing status of the device. The complete table with all VCS codes is detailed in the Appendix, under "VCS Code" on page 189. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 77: Survey Mode

    Configuration - > Timing General. Under the preset tab, select Custom preset and click Apply. Under Fanout Configuration, select Fanout Source #wr0 as MASTER and Fanout Source #wr1 as SURVEY as seen in the following image: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 78 The Active Servo table reports parameters regarding the slave interface: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 79 The configuration of the WR survey mode can be accessed by using the Web UI and the CLI configuration. WR Survey Mode via the Web UI Login into the device dashboard (Editor: link to WebUI section). Navigate to Configuration->Timing General CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 80 To view these parameters in the device CLI, use the command: gpa_ctrl ppsi net/wrX -A where wrX is the desired survey interface. Once executed, all interfaces para- meters are shown. Some parameters of interest could include: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 81: External Reference (Gm) Survey Mode

    Chose the mode Survey. Reboot the device. Tip: The device must be set to Boundary Clock mode to use the Sur- vey Mode with an External Reference. GM Survey Mode via the Web GUI CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 82 Once all the requirements are met, the phase can be read using the command gpa_ctrl hald spll/survey. For example: root@z16-014:~# gpa_ctrl hald spll/survey ---             hald ------------------------------------------- --------------|    0.8500.1   spll/survey/gm_phase                 : 10913                ps  CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 83: General Timing Management

    The other (wr1) is configured as WR master. This is the default preset as it is the standard/legacy configuration of most of the WR devices. This is the simplest Boundary Clock behavior where the device is dis- CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 84: External Atomic Clock (Gm)

    The primary timing source is provided using an external GNSS receiver ref- erence through the front-panel 10 MHz and 1PPS inputs (Grand-Master). All SFP ports (i.e., wr0-wr1) are configured as WR masters. Clock accuracy is announced below or equal to 100 nanoseconds. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 85: External Atomic Clock (Gm) / Ptp

    Here, Atomic Clocks means that a very stable oscillator based on hyperfine trans- ition (e.g, Caesium) that provides very low daily uncertainties (e.g., 1 ns/day) is combined with a GNSS receiver to remove its slow drift using averaging CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 86: External Gnss Receiver (Gm) / Ptp

    PPS). This causes a jump in the time reference. To avoid this situation, the user should configure the GNSS to not output any PPS before locking to GNSS signals. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 87: Wr Slave @ Wr0 > Wr1 (Bc)

    WR Slave @ wr0 / PTP Fan-Out Web GUI selection: BC: wr0|PTP The primary timing source is provided using WR protocol through interface wr0. All ports except wr0 and wr1 are configured as PTP slaves. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 88: Wr Slave @ Wr0>Wr1 / Ptp Fan-Out

    5.2.1.11 Custom The Custom Preset has been designed to allow unique selections for timing source and fanout settings in order to meet any kind of user needs. If the user CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 89 Set the Protocol field to determine the communication method used for that interface. The Protocol field options are DISABLED, WR, PTP, and NTP. If an interface is left as DISABLED, no timing information will be output by CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 90 Then each port can be configured independently with: Protocol: WR, PTP, NTP, Disabled Role: Master, Slave, Auto , Survey Source Rank: [0-255], Order the timing source given the source rank pri- orities where: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 91: Ptp Slave @ Wr0 (Bc) / Ptp

    The following figure summarizes how devices can be configured with different presets to operate on a generic timing network. To improve the com- prehensibility of the reader, this reference topology has been separated in sev- eral theoretical layers: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 92 White Rabbit network to other 3rd party devices in the cab- inet via PTP, via 10MHz/PPS (legacy devices), etc. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 93: Timing Source Info

    Name of the corresponding timing source. wr0, front- panel, eth1, etc.) 3.13x0.2 Type Type of timing source, each type can have slightly different state machines to properly handle its tim- ing source. HO/FR CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 94: Table 5-1: Timing Source Info Description

    Force BMCA decision using 1st priority (Lower values Default: 128 take precedence). 3.13x1.3 Priority2 <Integer> Manually force BMCA to select a clockID when clock Default: 128 quality is the same (Lower values take precedence). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 95: White Rabbit

    When the device is running as a WR Boundary Clock, this means that one of the fiber network interfaces is an active slave. The data related to how the servo dis- ciplines the internal oscillator can thus be visualized under the active servo panel. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 96: Port Instance

    Port Instance A WR port instance is then associated to each network interface. The table dis- played in the following image provides a quick overview of the state of each inter- face. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 97 Number of received PTP packet on this port. If the interface is currently running WR (“Port State” not “Disabled”), the user can expand (+) a specific interface to display an Advanced Overview (See the figure below): CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 98 VLAN ID of the connected peer. 1.xx31.xx net/<wrX>/1/clk/Q/ Clock Quality of the cor- responding WR port instance (wrX). 3.13x1.1 Clock Identity <Data Array> (8 x u8) Unique identity of PTP instance in the network. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 99 To obtain more details about time properties & clock quality of a given WR port instance, the user should use gpa_ctrl tool with the -a (expert) flag or with the –A (expert & disabled) flag. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 100: Ieee 1588-2008 (Ptpv2)

    IPv4 or Ethernet (layer 2) IPv4 Domain 0-255 Announce ratio [1 msg/128s, 16 msg/s] ([-7,4]) 1 msg/sec Sync ratio [1 msg/128s,128 msg/s] ([-7,7]) 1 msg/sec Delay Req ratio [1 msg/128s,128 msg/s] ([-7,7]) 1 msg/sec Advanced Settings CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 101: Ptp License Management

    Then, the PTP profiles restrain some specific settings in order to limit compatibility to only a subset of PTP. The user should thus consider these restrictions when configuring PTP for a specific pro- file. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 102 (i.e., 8265.1) 19.xx13.20 Announce <Enums> Default: Rate of announce messages transmitted Rate 1 packet/s to be used by BMCA/FOCA. From 1 packet each [2,4,8,16,32,128] seconds to [1,2,4,8,16] packets per second. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 103: Configuration Of Ptp Profiles

    A valid license is needed to perform the configuration of PTP profiles. If your pre- sets allow a valid MASTER or SLAVE port state, then you will be able to configure your PTP profiles for each port by navigating to Configuration > IEEE 1588-2008 (PTP). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 104 The objective of this profile is to distribute frequency within 16 ppb over a net- work with some non-aware PTP nodes. Range Default Name Note Value 19.xx13.x net/<iface>/1/cfg 19.xx13.9 Transport IPv4/UDP Only IPv4/UDP allowed. IP address Protocol must be set before selecting this profile. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 105 The range also includes the single default value 254 ([0, 127] and 254). 19.xx13.11 Transport Multicast Only Multicast allowed. Mode 19.xx13.20 Announce Only 1 packet/s allowed Rate 19.xx13.21 Sync Rate Only 1 packet/s allowed CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 106 Announce Rate Only 1 packet/s allowed 19.xx13.21 Sync Rate Only 1 packet/s allowed 19.xx13.23 Peer Delay req Only 1 packet/s Rate allowed 19.xx13.24 PTP Timescale Default Profile This profile has default settings. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 107: Info/Overview

    (see the table "PTP information for a port interface" on the next page more details on the provided parameters). The PTP Overview page is located at Overview > Timing > IEEE-1588-2008 (PTPV2). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 108: Table 5-3: Ptp Information For A Port Interface

    0. Two Step ation received from the master. We 1. One Step currently only support Two Step PTP. 2. Disabled 19.xx12.26 Rx Sync Packets <Integer> Number of received sync messages (Incrementing for Slave instances) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 109: Table 5-4: Advanced Ptp Information For A Port Instance

    (equivalent to delay_MS) 19.xx12.26 Rx Sync Packets <Integer> Number of received sync mes- sages (Incrementing for Slave instances) 19.xx12.28 Rx DelayReq Packets <Integer> Number of received delay request message (Incrementing for Master instances) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 110 Master instances each time a DelayReq is received) 19.xx12.67 Tx PeerDelayReq Pack- <Integer> Number of transmitted peer delay request messages (Incre- menting for Slave instances when a PTP exchange is com- pleted) CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 111: External Reference (Gm)

    GM source. • STARTUP_ ONLY The user can also configure the following parameters independently from the chosen preset: Name Value Type Description 3.7110.x gm/cfg/xxx Configuration of the GM timing source (By Preset). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 112: Info/Overview

    The GM timing source provides its own overview panel under Overview > Timing General > External Reference (GM), where the user can easily audit the condition of its external reference (see figure below). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 113: Ntp

    GM or BC, to check the coherence of the timing ref- erence. 5.6.1 Configuration The WRZ-OS supports NTP over management interfaces (ethX) and fiber optics ports (wrX). NTP configuration is described in the following sections. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 114: Ntp Provider

    NTP time is distributed over UDP and thus it requires the interface to have an IP and subnet configured on the subnet where NTP is going to be served. The NTP Stratum can be configured using the table in the previous section. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 115: Ntp Timing Source Configuration

    NTP server status. Warns if the NTP server Status • OK cannot be reached. • NTP sync error • NTP stopped replying 3.70x5.0 Offset <Integer> Time offset between the device and the NTP reference server (in seconds). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 116: Stratum Levels

    NTP time. Holdover The WR- ZEN can be ordered with an optional holdover oscillator (OCXO) in order to ensure an accuracy of 1.5µs even after 24 hours. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 117 This mean that if the active timing source of a device is HO, it will stick to it until reaching the expired states (Failure state of HO). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 118: Configuration

    79800 3.7210.2 Force Trigger <Enum> Force to manually trigger the holdover 0. STOP (START) or to expire it (STOP) without wait- 1. START ing the expiration timer. NONE, does nothing. 2. NONE CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 119: Info/Overview

    If you have ordered the hold- over option but the device does not detect it, please contact "Technical Support" page 188. Figure 5-18: Holdover overview Name Value Type Description 3.7220.x holdover/info/xxx Information about the Holdover timing source CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 120: Miscellaneous

    Name Value Type Description 3.8010.x misc/cfg/xxx Miscellaneous Timing con- figuration. 3.8010.0 Time Zone <String> Configure the device time zone such that local time is properly displayed (web interface, LCD screen). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 121: Update Leap Seconds File

    In order to always ensure a correct UTC-TAI correction, the device that can act as Grand-Master on the network, can also manually update this file through the Con- figuration > Misc panel: Figure 5-19: Manual Leap seconds update. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 122 5.8  Miscellaneous Note: Updating the leap seconds file can be performed hot by apply- ing the configuration, so there is no need to reboot. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 123: Security & Authentication

    SCP, HTTPS, SNMPv3, and a firewall is included to provide a robust system against malicious users. The following topics are included in this Chapter: 6.1 Upload SSH keys 6.2 HTTPS 6.3 TACACS+ 6.4 RADIUS 6.5 Firewall CHAPTER • WR-ZEN Series User Manual...

  • Page 124: Upload Ssh Keys

    Hypertext Transfer Protocol over TLS (HTTPS) is the encapsulation of HTTP over a Transport Layer Security (TLS) secured channel, which is the primary protocol used to send data between a web browser and a website. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 125 Finally, the last section of the HTTP/HTTPS menu enables Diffie-Hellman para- meters in the TLS key exchange. This is optional but recommended. There are two buttons to generate and download the DH parameters file. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 126: Tacacs

    Then the device will ask for credentials, which will be validated by the TACACS+ server and grant access to the user if the authen- tication was successful. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 127: Tacacs+ Client Configuration

    For example, in the screenshots of figure a successful access with the TACACS+ password the first time, failed the second time and succeeded the third. Below you can see the verbose tac_plus output. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 128 This is because when the RADIUS configuration is the first line, authentication of the first password always goes to the RADIUS server and, if is the password of TACACS, the CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 129: Radius

    Verification of RADIUS installation In order to verify the installation, the following set- up is configured (Figure ). When a user authenticates a device, this device will send a message to the CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 130: Radius Client Configuration

    The following figure shows an access using the password that was configured in the users file, but failing the first try. Looking at the output of freeradius at the host, it is possible to get the information from the first failed attempt: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 131 6.4  RADIUS Figure 6-6: SSH connection with the WR-ZEN board Figure 6-7: Freeradius failed attempt with debug information CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 132: Firewall

    ##First append the current rule to existing rule (overwise flush) iptables -A INPUT -i eth0 -s 192.168.7.1 -j ACCEPT iptables -A INPUT -i eth0 -j DROP CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 133 (UART) to the device as it is easy to make an error and fully block the network access to this device. To revert the changes, the user should perform a factory reset or delete the /us- r/local/etc/iptables.rules files. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 134 6.5  Firewall BLANK PAGE. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 135: Monitoring & Logging

    The following topics are included in this Chapter: 7.1 Syslog 7.2 SNMP 7.3 LLDP 7.4 Healthing 7.5 LCD screen menu 7.6 Service Persistent Raw Data and Runtime Statistics CHAPTER • WR-ZEN Series User Manual...

  • Page 136: Syslog

    It contains the kernel/user event logging. Systemlog In the same way as a normal Linux device, the kernel and the userspace pro- cesses send information to a central logger. Its contents can be found at CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 137: Permanent Logs

    The wrz_logdump tool is responsible for generating the logdump. The logdump is a set of compressed files that can be easily shareable, which provides all the information about the current state and log of the device. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 138: Configuration

    The systemlog file under /var/log/systemlog Information about uboot and versions Note: The Safran 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 for security reasons. This prevents to use all the available memory in the device in case the log files sud- denly increase and is performed automatically when the file size exceeds 5 MB.
  • Page 139 13.2000.6 Log N rotate <Integer> (i.e., Number of logdumps rotations stored in the device. Logging can also be configured via the Web GUI. Navigate to Management > Log- ging (see image below). CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 140: Snmp

    /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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 141 Name of the corresponding loc- ation) ation. 13.3000.2 Contact <String> (i.e.,user- Contact information. @dom.com) 2. v1/v2: Parameters for SNMP v1 and v2. Name Value Type Description 13.3002.1 Community <String> (i.e., public) Name of the name community. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 142 Caution: The default community name is public. For security reas- ons, it is recommended to change this parameter. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 143: General Configuration

    To configure SNMP via the Web GUI, log in to the device and navigate to Admin- istration > SNMP. In order to configure SNMP from the CLI, the wrz_config tool must be accessed. Once it has been launched, the SNMP configuration is under Management > SNMP. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 144 In order to create custom SNMP groups, the configuration file /us- r/share/snmp/snmpd.conf can be modified to define or modify them. Caution: SNMP configuration files customization: Safran is not responsible for any damage caused by the user while manually modi- fying the SNMP configuration files.

  • Page 145: Specific Snmp V1/V2 Configuration

    In the case of SNMP v3 the default passwords can be modified using the para- meters under the change password sub-tree: Name Value Type Description 13.3800.0 User name <String> (i.e., userSNMP) Name of the SNMPv3 user. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 146: Snmp Traps

    SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message. The SNMP traps include current sysUpTime value, an OID identi- CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 147: Trap Objects

    7.2.2.1 Trap objects The generated traps in the device contain different objects in order to provide general and specific information about the trigger of the notification. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 148: Trap Notifications

    Trap generated when a parameter changes to a critical status. outofrangeParam: Trap generated when a parameter goes to an out of range value. TrackedParam: Trap generated when a tracked parameter changes its value. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 149: Trap Configuration

    • Enabled in an alert status or • Disabled back to a normal status. Note: Default traps configuration: By default, all traps are enabled using the public SNMPv2 community for informative purposes. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 150: Basic Trap Receptor Nms Configuration

    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 /us- r/share/snmp/mibs Finally, the snmptrapd service must be stopped and re- run to view all the received traps. sudo service snmptrapd stop sudo snmptrapd -f -m all CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 151: Lldp

    Management > LLDP as shown below. Figure 7-4: LLDP configuration from CLI Alternatively, the LLDP can be configured using the following parameters: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 152: Info/Overview

    The information gathered by each port running LLDP is then structured into three categories: Device: Information related to the system run by the neighbor. Port: Information related to the neighbor port. Management: Information about how the corresponding neighbor is man- aged. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 153 Information about the tim- ing con- figuration of the neighbor 20.xx12.1 Status <String> (i.e., Ok) General status of the peer device. 20.xx12.2 VCS Code <Integer> (i.e., 20001) Virtual clock use case code. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 154 20.xx22.6 Temperature <Decimal> (i.e., 0.000000) SFP temperature. 20.xx22.7 Reception Path <Decimal> (i.e., 0.000000) SFP power meas- Power urement for Rx path. 20.xx30.x net/wrX/peer/1/mgmt Information about how the corresponding neighbor is man- aged. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 155: Lldp Locked Logging

    /var/log/systemlog, here there is an example: Oct 18 13:05:24 zen-303 root: /wr/bin/lldp-collect 2>&1 | logger &  Oct 18 13:05:25 zen-303 root: /usr/sbin/lldpd -x 2>&1 | logger &  Oct 18 13:05:25 zen-303 lldpd[4007]: no privilege separation available  CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 156: Healthing

    The associated parameters can be accessed through the Web GUI or the com- mand line. The Web GUI has three Healthing pages, located under Overview > Healthing. The Healthing System Overview page provides all necessary information on tem- perature, computer usage, etc.: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 157 7.4  Healthing Figure 7-5: Healthing System Overview The Healthing Power Overview page contains all necessary information related to the status and functionality of the power supplies: Figure 7-6: Healthing Power Overview CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 158 2.1001.32 CPU load 5 <Decimal> (i.e., 0.054199) Average CPU load during the last 5 minutes. 2.1001.33 CPU load 15 <Decimal> (i.e., 0.054199) Average CPU load during the last 15 minutes. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 159 The devices incorporate redundant power supplies and fans. In order to ensure their proper behavior, their information can be checked too in the web GUI under Healthing or through the command line: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 160: Configuration

    <Enum> 0. OK 1. Unplugged 2. Stopped I2C Status of the Error back ventilator of fanX module. 7.4.2 Configuration There are a few parameters that can be configured. In the CLI, these parameters are configured via the Healthing module: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 161 Healthing Web GUI settings The healthing, fans and power supply configuration parameters can be found in the following table: Name Value Type Description 2.1000.0 Screen saver <Integer> (i.e., 1) Not used in WR-ZEN device. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 162: Lcd Screen Menu

    - No alerts. - Yes LCD screen menu The WR- ZEN family includes an LCD screen where you can see some con- figuration values and the state of the device. 7.5.1 Screen Saver CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 163: Main Screen

    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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 164: Main Menu

    ! (warning): at least one parameter in warning range. X (critical): at least one parameter in critical range, or there is a prob- lem with the module. W: All parameters in warning range. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 165 INFO/CTRL button. When the last parameter was reached, a short press over INFO/CTRL exits this screen, returning to the previous menu. NETWORK In this section you can review the parameters regarding the network interfaces of the device. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 166 WR1: information about fiber interface White Rabbit 1. 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. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 167 The options are: POWER OFF: Power off the device in a safe way. REBOOT: Reboot the device. REBOOT WR: Reboot white rabbit. TOGGLE M/GM: Activate/Deactivate Grand-Master mode. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 168: Service Persistent Raw Data And Runtime Statistics

    The time error between a Slave Clock and a Master Clock from_master act/servo/delay_ Delay between Master and Slave act/servo/delay_ Measured round trip time including fixed+semistatic delays act/servo/mean_ Cable round trip time excluding fixed+semistatic (cRTT) delay CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 169: Persistent Raw Data

    M0010 TEXT, M0011 REAL, M0012 REAL, M0013 REAL, M0014 REAL Column names of the _raw table correspond with the data of the METRIC_ID column stored in the _info table. For this particular ppsi example: CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 170 TIMESTAMP, M0000, M0001, M0002, M0003 from ppsi_raw; TIMESTAMP M0000 M0001 M0002 M0003 1699978917 Adjusting 8239778.69 -2.36115e-07 -4.72166e- Phase 1699978918 Adjusting 8239778.69 -2.36115e-07 -4.72166e- Phase 1699978919 Adjusting 8246688.591 -3.14177e-07 -6.2827e-07 Phase 1699978920 Adjusting 8250518.773 6.07921e-07 1.215681e-06 Phase CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 171 SQLite3 console. See the example in "Dumping the Database Manually" on the next page. Both API and the toll will output a CSV file, whereas the manual mode allows more flexibility. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 172: Accessing The Raw Data Using The Api

    Along with the data values for a specific time frame, raw data endpoints can return statistics (min, max, mean, stdev) if requested. Tip: Please keep in mind that raw data retrieving and statistics cal- culations are computationally expensive operations. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 173: Runtime Statistics

    # gpa_ctrl ppsi net/wr0/1/servo/delay_MM -M id:0:min: 0.000000000000 id:1:max: 0.000000000000 id:2:mean: 0.000000000000 To reset only the statistic with ID 2: # gpa_ctrl ppsi net/wr0/1/servo/delay_MM -Mr2 Result: # gpa_ctrl ppsi net/wr0/1/servo/delay_MM -M2 id:2:mean: 0.000000000000 CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 174: Accessing Runtime Statistics Through Snmp

            "oid": "1.2020.25",         "access_str": "RX",         "vtype_str": "f64",         "unit": "ns",         "desc": "The time error between a Slave Clock and a Master Clock (Legacy WR: clock offset)",         "enum_dic": {},         "metrics_dic": {           "min": 0.000000007383,           "max": 0.000000291743, CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 175 To reset the runtime metrics using the REST-API, use the gpa/reset-param-met- rics endpoint, specifying the parameter to reset. Please refer to "The REST-API" on page 37 section of this manual, and to the Swagger page of the API, for more information. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 176 7.6  Service Persistent Raw Data and Runtime Statistics BLANK PAGE. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 177: Device Maintenance

    CHAPTER 8 Device Maintenance The following topics are included in this Chapter: 8.1 Licenses 8.2 Firmware Update 8.3 Recovery Mode 8.4 Factory Config Mode 8.5 Failsafe Mode CHAPTER • WR-ZEN Series User Manual...

  • Page 178: Licenses

    The status of the licenses on the device can be retrieved under: Management > Licenses as shown in the figure below: Note: Matching Device hardware: Safran distributes different WRZ- OS firmwares according to the hardware family and version of the device. The user must follow indications provided in "Firmware...
  • Page 179 Red: License is not available (See Figure 8:1 - Checking available licenses.). Yellow: License is in trial. Green: License is properly activated. Name Value Type Description 12.2xyy. licenses/xxx/yyy/ Information about license feature <yyy> in group <xxx>. 12.2xyy.1 Feature Name <String> License feature name. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 180: Order Licenses

    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 CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 181: Map A Feature To A Device

    At this point the license(s) is(are) associated but still not generated yet. By clicking on the Action > Download Capability Response a license file (.bin) will be automatically generated and downloaded. After refreshing the screen, the corresponding Status should be updated to License generated. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 182: Create A New Device

    Load local license file in the device In order to load the generated license file, the user first needs to access to the Management > Licenses within the web interface of the device. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 183: Remove Local License From Device

    Select the quantity of the corresponding license to remove and Click Save. Review that the Status of the licenses to remove is Waiting for con- firmation. Then click on Action > Download Capability Response. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 184: 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 Safran for assist- ance on the solution that best fits the topology and help through its setup.

  • Page 185: Firmware Update

    3.4 soft- ware version: wr-zynq-os-v<XXX>-<YYYMMDD>-ZENx.x_binaries.tar wr-zynq-os-v<XXX>-<YYYMMDD>-ZEN3.x_binaries.tar wr-zynq-os-v<XXX>-<YYYMMDD>-ZEN_binaries.tar But not the one that correspond to another device: wr-zynq-os-v<XXX>-<YYYMMDD>-Z16x.x_binaries.tar Or the one that corresponds to another hardware version CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 186: Using Web Interface

    Using SSH/SCP A new firmware can be updated using SSH and SCP protocols. This method allows a secure way to perform a batch firmware update to many devices at the same time. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 187: Recovery Mode

    Once the device has been booted in recovery mode, it should apply the network configuration previously saved in the .config file. However, it might occasionally be impossible to recover the network configuration. In those cases, the device CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 188 (WARNING: Any specific network settings will be removed). If none of these actions can return the device to a normal booting mode, contact "Technical Support" on page 188 to get more help. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 189: Manual Recovery Mode

    Factory Config Mode In case a miss configuration of the device invalids its correct login, one can manu- ally reset the configuration to default factory value by using one of the following methods. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 190: Reset Via Front Panel Lcd Screen

    U-Boot 2015.04-wr7s-v2.10-z16 (Apr 26 2022 - 10:51:49) Z16v4 WR_Z16-v4.1-S01_183 Environment found in flash CTRL button is pressed! ....Setting reset factory boot mode To complete the factory reset, hold the Reset button for 20s. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 191: Failsafe Mode

    Factory reset vs. Failsafe mode: If the device initialization is blocked due to a custom script, it might be easier to directly per- form a factory reset even if this means that the device will lose all its configuration. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...
  • Page 192 8.5  Failsafe Mode BLANK PAGE. CHAPTER • WR-ZEN Series User Manual Rev. v5.1...

  • Page 193: Appendix

    9.6 List of Parameters with Statistics Enabled 9.7 Timing outputs 9.8 Low Jitter Setup 9.9 TACACS+ and RADIUS server configuration 9.10 List of supported SFPs 9.11 List of Tables 9.12 List of Images 9.13 Document Revision History • APPENDIX WR-ZEN Series User Manual...

  • Page 194: Acronyms

    Power Supply Round Trip Time Small Form-factor Pluggable Transceiver for fiber link Secure Shell SNMP Simple Network Management Protocol SyncE Synchronous Ethernet International Atomic Time (Temps Atomique International) Time of Day Coordinated Universal Time White Rabbit WR-ZEN Series User Manual...

  • Page 195: Troubleshooting

    What does the Error 500 mean while uploading the firmware? What is recommended to fix this issue? In this case, the best modus operandi is to reboot before flashing the device. Also check the file is not corrupted. WR-ZEN Series User Manual...

  • Page 196: Health General Status

    Monitoring Tools User Guide to get SNMP working. You will be able to both consulting or changing configurations on the WR-ZEN with the SNMP commands. After having installed SNMP on your host, all parameters on the WR-ZEN can be checked by typing: WR-ZEN Series User Manual...

  • Page 197: Virtual State Clock Code Error

    To do so, first access the API Swagger website on https://<MACHINE- IP>:8201 and accept its certificate, then access the administration website and accepts its offered certificate as well (see figure below). WR-ZEN Series User Manual...

  • Page 198: How To Report An Error

    How to report an error 1. If one of the devices experiments any technical issues, it would be recom- mendable to contact the Safran Support Team (see "Technical Support" on page 188), which will be in charge of addressing the problem. These are the steps that should be followed in case a problem happens.

  • Page 199: Rsyslog Template To Improve Remote Login

    @<rsyslog server1 IP> local0.* @<rsyslog server2 IP> 9.2.7 Warranty The WR-ZEN device is fully factory tested and warranted against manufacturing defects for a period of one year. Failure of the WRZ device due to installation WR-ZEN Series User Manual...

  • Page 200: Technical Support

    To request technical support for your WR-ZEN unit, please go to the "Timing Support" page of the Safran website, where you can not only submit a support request, but also find additional technical documentation. Phone support is available during regular office hours under the telephone num- bers listed below.

  • Page 201: Vcs Code

    GM (or provide too low voltage) VSC- CRITICAL Unlocked: GM: Internal 10MHz and PPS signals 10103 10MHz+PPS Oscillator are not properly con- not present nected to the GM (or provide too low voltage) WR-ZEN Series User Manual...
  • Page 202 GM can not guarantee the UTC- TAI convertion even if the currently leap seconds used is still valid. If gm/cfg/leapsec_file_ ignore option is active, this status will never occur and will be noted as VSC-10000. WR-ZEN Series User Manual...

  • Page 203: Boundary Clock (Bc Vcs Code)

    WR and the upstream device provide all the inform- ation properly VSC- Locked BC: PTP @ The BC clock is 20001 ifname locked using PTP and the upstream device provide all the inform- ation properly WR-ZEN Series User Manual...
  • Page 204 No WR/PTP con- Internal The BC clock 20303 nected reference Oscillator has link with upstream device but does not prop- erly receive any PTP announce mes- sage (or any other mes- sages). This include the servo_state- e=NOT_ UPDATED WR-ZEN Series User Manual...
  • Page 205 VSC- CRITICAL Upstream device Passive The GM is not 22320 in Free-Running WR/PTP @ available in this ifname network. This passive timing source can become active only if no bet- ter time source is available. WR-ZEN Series User Manual...
  • Page 206 CHANGEOVER Upstream GM in BC: Hol- GM announce 21201 Free-Running dover itself to be now in FR, if we have an active HO we should exit through this state and fail to the HO timing source WR-ZEN Series User Manual...
  • Page 207 BC is using its ifname Holdover. Accuracy will decrease over time and when the HO expir- ation time has passed, the upper BC will be announced as FR (the tim- ing will then be placed into a critical state). WR-ZEN Series User Manual...

  • Page 208: Others

    Timing For ports, "Ready" 09000 source is means that the link is ready up and some announce messages sent by a master has been received. For GM, "Ready" means that 10M/PPS has been detected prop- erly WR-ZEN Series User Manual...
  • Page 209 Iddle VSC- Holdover Passive The Holdover timing 92400 Ready source has been learn- ing in background from the active timing source. It is now ready to being triggered. VSC- Holdover Passive Transitional state 92401 Ready WR-ZEN Series User Manual...

  • Page 210: Persistent Custom Files

    This allow to store per- sistent files by placing them into the second ext4 partition on the SD drive moun- ted as /media/data which will be then mounted at next boot into the operating system directories: WR-ZEN Series User Manual...

  • Page 211: List Of Parameters With Statistics Enabled

    Currently, two services, ppsi and hald, perform raw data collection and keep runtime statistics. PPSI The service ppsi keeps record of the following parameters for every WR inter- face, and for the active servo. Parameter Description act/servo/state State of the servo WR-ZEN Series User Manual...

  • Page 212: 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). WR-ZEN Series User Manual...
  • Page 213 1 Ohm (optimal) xPPS & ~ 3.3 V 2.06 32BNCEXP32BNC V2.2 50 Ohm (optimal) 10MHz ~ 3.0 V 1.67 C & D 1 Ohm (optimal) ~ 3.3 V 50 Ohm (optimal) xPPS ~ 3.0 V 2.06 1.67 WR-ZEN Series User Manual...

  • Page 214: Low Jitter Setup

    For the same reason stated right before, a user should not mix LJ and non- LJ devices in the same setup (or, if he/she wants to do so, he/she should be aware that the devices derived from it will have higher phase noise). WR-ZEN Series User Manual...

  • Page 215: Tacacs+ And Radius Server Configuration

    = test-tacacs { pap = cleartext password It is possible to encrypt the password with the "tac_pwd" terminal command and enter the password to the settings as follows: pap = des yD0g3Qn/0ZDsg Being yD0g3Qn/0ZDsg the encrypted password. WR-ZEN Series User Manual...

  • Page 216: Radius Server Installation And Configuration

    Rules updated (v6) The clients must be configured in /etc/freeradius/3.0/clients.conf by adding their IPs with the "shared secret". For example, this can be done as fol- lows: client nashostname { ipaddr = 172.17.5.13 secret = ourchosensecret WR-ZEN Series User Manual...

  • Page 217: List Of Supported Sfps

    (dBm) (dBm) AXGE-1254-0531 T1310/R1490 -9 ~ -3 10km AXGE-3454-0531 T1490/R1310 -9 ~ -3 10km 1000BASE-BX BiDi SFP T1550/R1490 -1 ~ 4 <-31 120km 1550nm-TX/1490nm-RX 120km 1000BASE-BX BiDi SFP T1490/R1550 -1 ~ 4 <-31 120km 1490nm-TX/1550nm-RX 120km WR-ZEN Series User Manual...

  • Page 218: List Of Tables

    Table 5-2: IEEE 1588 configuration with/without license Table 5-3: PTP information for a port interface Table 5-4: Advanced PTP information for a port instance Table 6-1: Default firewall configuration Table 9-1: Safran contact information 9.12 List of Images Figure 1-1: Intra-datacenter WR network topology...
  • Page 219 Figure 7-3: SNMP traps scheme. Figure 7-4: LLDP configuration from CLI Figure 7-5: Healthing System Overview Figure 7-6: Healthing Power Overview Figure 7-7: Healthing Fan Overview Figure 7-8: Healthing configuration through CLI. Figure 7-9: Healthing Web GUI settings WR-ZEN Series User Manual...

  • Page 220: Document Revision History

    Switch to Orolia branding. V4.0 Updated firmware update inform- Feb 2023 ation V5.0 Documented new REST-API and 17-July 2023 updated Web GUI functionality. Updated PTP profile information. Switch to Safran branding. WR-ZEN Series User Manual...
  • Page 221 APPENDIX Description Date V5.1 New Survey Mode information, Met- 22-Feb 2024 rics & Raw Data, updated REST-API, LLDP, and PTP4L information. WR-ZEN Series User Manual...
  • Page 222 BLANK PAGE. WR-ZEN Series User Manual...
  • Page 223 Custom Profile Healthing Holdover 3, 49, 60, 80, 85, 104, Default Dimension HTTP HTTPS Environmental IEEE 1588-2008 External Reference Installation Factory Config LCD screen Factory Config Mode Leap second 87, Failsafe Failsafe Mod License • INDEX WR-ZEN Series User Manual...
  • Page 224 Syslog password Permanent log TACACS+ Presets Technical support Product Specifications Timing Management Timing Sources PTPv2 Troubleshooting RADIUS UART Raw Data Update Rear panel Upgrade Recovery Mode Regulatory Compliance Remote logs Virtual Clock Resiliency RoHS Web GUI WR-ZEN Series User Manual...
  • Page 225 INDEX White Rabbit 2, WR-ZEN TP WR-ZEN TP-32BNC WR-ZEN TP-FL WRZ-OS WR-ZEN Series User Manual...

This manual is also suitable for:

Wr-zen tp-flWr-zen tp-fl 4ppsWr-zen tp-fl 8ppsWr-zen tpWr-zen tp-32bnc

Table of Contents