EndRun Sonoma N12 User Manual

EndRun Sonoma N12 User Manual

Network time server
Table of Contents

Advertisement

Sonoma N12
GPS-Synchronized
User Manual
USM3029-0000-000 Revision 5
June 2017
Network Time Server
"Smarter Timing Solutions"

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Sonoma N12 and is the answer not in the manual?

Questions and answers

Summary of Contents for EndRun Sonoma N12

  • Page 1 "Smarter Timing Solutions" Sonoma N12 Network Time Server GPS-Synchronized User Manual USM3029-0000-000 Revision 5 June 2017...
  • Page 3: Preface

    EndRun Technologies has been dedicated to the development and refinement of the technologies required to fulfill the demanding needs of the time and frequency community since 1998. The instruments produced by EndRun Technologies have been selected as the timing reference for such rigorous applications as computer synchronization, research institutions, aerospace, network quality-of-service monitoring, satellite base stations, and calibration laboratories.
  • Page 4: About This Manual

    Extended Warranty EndRun products are very reliable and rarely need to be returned to the factory for service. After the initial warranty period it is most cost-effective for the customer to repair the unit on an “as needed ba- sis”, rather than pay for an extended warranty or the annually recurring fees of a service contract..
  • Page 5: Warranty Repair

    If the warranty period has expired, we offer repair services for equipment you have purchased from EndRun. Call and ask for a customer service agent. It is important to contact us first as many prob- lems may be resolved with a phone call. Please have the serial number of the unit and the nature of the problem available before you call.
  • Page 6: Table Of Contents

    ........... . i About EndRun Technologies .
  • Page 7 ..........12 Verify Network Configuration .
  • Page 8 Chapter Four - Precision Time Protocol (PTP/IEEE-1588) ....33 ..............33 Option .
  • Page 9 Chapter Six - Simple Network Management Protocol (SNMP) ....49 ............49 SNMPv3 Security .
  • Page 10 ......... . . 65 Firmware: GPS Subsystem Upgrade Page .
  • Page 11 ............79 kernelversion .
  • Page 12 ............97 EndRun Format .
  • Page 13 ........... . . 103 Power Supply Options .
  • Page 14 Appendix D - Third-Party Software ........121 .
  • Page 15 ..........145 Receiver Fault Definitions Appendix H - Specifications .
  • Page 16 This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 17: Chapter One - Introduction

    "Smarter Timing Solutions" Chapter Introduction This chapter introduces the GPS-Synchronized Sonoma Network Time Server and gives a brief over- view of what it is and how it works. What It Is The Sonoma Network Time Server is a precision server of Coordinated Universal Time (UTC) that can be connected via an Ethernet port to any TCP/IP network.
  • Page 18: Gps Receivers

    EndRun developed a timing optimized GPS receiver for additional resilency, accuracy, and reliability. The EndRun GPS Receiver strictly complies to the IS-GPS-200 specification. and began shipping in Sonoma in June 2017. GPS receiver specifications are listed in Appendix H - Specifications.
  • Page 19: Where To Use It

    Where to Use It Since signals from the GPS satellites are available at all locations on the globe, you may deploy the Sonoma virtually anywhere. However, you must be able to install an antenna either on the rooftop or in a window so that satellite transmissions may be received at least several times during the day. For more information see Appendix E - Installing the GPS Antenna.
  • Page 20 C H A P T E R O N E This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 21: Chapter Two - Basic Installation

    Hardware Unpack and check all the items using the shipment packing list. Contact the factory if anything is missing or damaged. The Sonoma N12 Time Server (GPS) shipment typically contains: • Sonoma N12 (part # 3029-0001-000 or #3029- variant) •...
  • Page 22: Sonoma Physical Description

    C H A P T E R T W O Sonoma Physical Description Sync LED This amber LED flashes to indicate synchronization status. Alarm LED This red LED illuminates briefly at power-up, and thereafter whenever a serious fault condition exists. ���������...
  • Page 23: Performing A Site Survey

    Appendix E - GPS Reference Position and command for details. setgpsrefpos If you are unable to achieve GPS lock after trying all of these suggestions, then contact EndRun Cus- tomer Support for assistance. NOTE TO PRECISION TIME PROTOCOL (PTP) USERS If you want to maximize timing accuracy, see Appendix E - Installing the GPS Antenna, Calibrate Your Receiver.
  • Page 24: Installing The Sonoma

    Sonoma has dual power supplies, then multiple power cords may be installed. To de-energize this equipment, disconnect all power cords from the device. Do not install the Sonoma N12 where the operating ambient temperature might exceed 122°F (50°C). Connecting the Optional DC Power The DC Power Input is an option.
  • Page 25: Configuring Ethernet With The Serial Port

    NOTE You must use an RS-232 null-modem cable or adapter if you are connecting the Sonoma N12 to another computer. The cable included in the shipping kit is a null-modem cable. If your computer does not have a serial port, you can use a USB port with a USB-RS232 converter similar to Gearmo GM-FTDI-8.
  • Page 26 “root” user. After correctly entering the password at this prompt, password: the sign on message is shown. It identifies the host system as Sonoma N12 GPS and shows the soft- ware part number, version and build date. The out-of-the-box hostname is set to “Sonoma_N12”, and the domainname is set to “your.domain”.
  • Page 27: Using Netconfig To Set Up Your Ip

    B A S I C I N S T A L L A T I O N If you do not see characters displayed by your terminal program within 30 seconds after the unit is powered up, you must troubleshoot your setup. An incorrectly wired cable or incorrect port setting in your terminal emulation program are the most common problems.
  • Page 28: Verify Network Configuration

    After configuring your ethernet interfaces, you should shutdown the Sonoma and reboot it by issuing this command at the prompt: Sonoma N12 GPS(root@Sonoma_N12:~)-> reboot Verify Network Configuration If you are using the RS-232 serial I/O port to communicate with the Sonoma, you will be able to see the kernel-generated boot messages when the unit reboots.
  • Page 29 If you have configured a nameserver(s) for your network, you may check that by issuing this com- mand: Sonoma N12 GPS(root@host:~)-> cat /etc/resolv.conf search your.domain nameserver 192.168.1.1 nameserver 192.168.1.2 S o n o m a U s e r M a n u a l...
  • Page 30: Check Network Operation

    C H A P T E R T W O Which displays the contents of the /etc/resolv.conf file containing the domain name you entered previ- ously using , and the nameserver IP address(es) to use for that domain. netconfig Check Network Operation With your Sonoma network parameters properly configured, you are ready to test the setup using from a server or workstation that is able to access the network connected to the Sonoma.
  • Page 31: Using Ssh

    Sonoma_N12 GPS 6010-0065-000 v 1.00 Sat Jan 19 14:17:44 UTC 2013 Sonoma_N12 GPS (root@host:~)-> This last line is the standard Sonoma N12 GPS prompt. After configuring the unit, you should change the passwords using the Linux command issued from the prompt.
  • Page 32 C H A P T E R T W O This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 33: Chapter Three - Network Time Protocol (Ntp)

    "Smarter Timing Solutions" Three Chapter Network Time Protocol (NTP) This chapter describes how to configure the Sonoma as an NTP Server. It also includes brief instruc- tion for setting up NTP Clients on your Unix-like or Windows platform. This manual is not a ‘How- To’...
  • Page 34 C H A P T E R T H R E E ******************************************************************************* **********************Network Time Protocol Configuration********************** ******************************************************************************* This script will allow you to configure the ntp.conf and ntp.keys files that control Sonoma_N12 GPS NTP daemon operation. You will be able to create new MD5 authentication keys which are stored in the ntp.keys file.
  • Page 35 N E T W O R K T I M E P R O T O C O L ( N T P ) You will be prompted for the key numbers (1 - 65534), that you want NTP to “trust”.
  • Page 36: Configuring The Sonoma As A Stratum 2 Server

    C H A P T E R T H R E E Configuring the Sonoma as a Stratum 2 Server Operating the Sonoma as a Stratum 1 Server is the recommended mode. However, there are times when Stratum 2 operation is a good strategy: 1.
  • Page 37: Setting Up Ntp Clients On Unix-Like Platforms

    N E T W O R K T I M E P R O T O C O L ( N T P ) Setting Up NTP Clients on Unix-like Platforms To configure your Unix-like computer to use your Sonoma Time Server, you must have success- fully completed the NTP Server basic installation procedure described above.
  • Page 38: Unix-Like Platforms: Md5 Authenticated Ntp Client Setup

    C H A P T E R T H R E E ntpq> Use the command peers to display the NTP peers which your computer is using. One of them should be the Sonoma server which you have just configured. You should verify that it is being ‘reached’. (You may have to continue issuing the peers command for a minute or two before you will see the ‘reach’...
  • Page 39: Configure Ntp

    N E T W O R K T I M E P R O T O C O L ( N T P ) Configure NTP You must edit the ntp.conf file which , the NTP daemon, looks for by default in the /etc directo- ntpd ry.
  • Page 40: Configure Ntp Client For Broadcast

    C H A P T E R T H R E E cation in the broadcast/multicast mode, and you must know which of the trusted keys it is using for broadcast/multicast operation. The example Sonoma configuration shown in Configuring the NTP Server above will be assumed in the example configuration commands shown here.
  • Page 41: Test Broadcast/Multicast

    N E T W O R K T I M E P R O T O C O L ( N T P ) You may remove the line added previously in Unix-like Platforms: Basic NTP Client Setup: server 192.168.1.120 or the authenticated version added in Unix-like Platforms: MD5 Authenticated NTP Client Setup: server 192.168.1.120 key 1 Test Broadcast/Multicast...
  • Page 42: Setting Up Ntp Clients On Windows

    C H A P T E R T H R E E Setting Up NTP Clients on Windows To configure your Windows computer to use your Sonoma Time Server, you must have successfully completed the procedures in Configuring the NTP Server above. Client installation must be per- formed by a user with administrative priviledges.
  • Page 43: Windows: Md5 Authenticated Ntp Client Setup

    N E T W O R K T I M E P R O T O C O L ( N T P ) http://support.ntp.org/bin/view/Main/ExternalTimeRelatedLinks Configure NTP Directory path names are not given in the instructions below because there are multiple ways to install and multiple versions of Windows.
  • Page 44: Create The Ntp.keys File

    C H A P T E R T H R E E Configuring the NTP Server above will be assumed in the example configuration commands shown here. • You have installed NTP on your client computer. • You have successfully performed the Windows: Basic NTP Client Setup on your client computer. Create the ntp.keys File You must create a file named ntp.keys in the /program files/ntp/etc directory (for example).
  • Page 45: Windows: Broadcast/Multicast Ntp Client Setup

    N E T W O R K T I M E P R O T O C O L ( N T P ) you will see the command prompt: ntpq.exe ntpq> Use the command peers to display the NTP peers which your computer is using. One of them should be the Sonoma server which you have just configured.
  • Page 46: Configure Ntp Client For Multicast

    C H A P T E R T H R E E If you are not using MD5 authentication, you would add these lines: disable auth broadcastclient You may remove the line added previously in Windows: Basic NTP Client Setup: server 192.168.1.120 or the authenticated version added in Windows: MD5 Authenticated NTP Client Setup: server 192.168.1.120 key 1...
  • Page 47 N E T W O R K T I M E P R O T O C O L ( N T P ) you will see the command prompt: ntpq.exe ntpq> Use the command peers to display the NTP peers which your computer is using. One of them should be the Sonoma server which you have just configured.
  • Page 48 C H A P T E R T H R E E This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 49: About Ptp

    Command: get_sw_opts Sonoma reply: 00000000000000000000000000000000 In this case, there is no PTP option installed. Contact EndRun Technologies if you would like to obtain PTP for one or both ports. In the cases below, PTP is installed. Command: get_sw_opts Sonoma reply: (PTP installed on port 0 only.)
  • Page 50: Two Gigabit Ports

    C H A P T E R F O U R Two Gigabit Ports The PTP daemon status and configuration is supported from two PTP companion utilities ptpstatx , where x is network port 0 ( or 1 ( . The following table shows the ptpconfigx eth0) eth1)
  • Page 51 P T P / I E E E - 1 5 8 8 One file is modified for each port. Either/etc/ptp0.conf for or /etc/ptp1.conf for . These eth0 eth1 are non-volatile files stored in the FLASH disk /boot/etc directory. You must reboot the Sonoma after running this script for the changes to take effect.
  • Page 52: Ptp Status Using The Network Or Serial Port

    C H A P T E R F O U R ******************************************************************************* ******************************************************************************* The Precision Time Protocol IEEE-1588 V2 configuration has been updated. Please re-boot now for the changes to take effect. ******************************************************************************* ******************************************************************************* ******************************************************************************* Now reboot the system by issuing this command at the shell prompt: reboot PTP Status Using the Network or Serial Port command allows you to query the status of the PTP Subsystem.
  • Page 53: Ptp Operation

    P T P / I E E E - 1 5 8 8 UTCV is the PTP utc offset valid, either TRUE or FALSE. is the PTP clock accuracy one of 25ns, 100ns, 250ns, 1us, 2.5us, 10us, 25us, 100us, 250us, 1ms, 2.5ms, 10ms, or Unknown. is the PTP leap 59 second indicator, either TRUE or FALSE.
  • Page 54 C H A P T E R F O U R clock transmits the PTP epoch (TAI) and sets the PTP Scale to PTP. See About the PTP Second and UTC Time at the end of this chapter for more information. The PTP Multicast TTL is user configured in a range from 1 to 255.
  • Page 55: About The Ptp Second And Utc Time

    P T P / I E E E - 1 5 8 8 The PTP Frequency Traceable indicator is either TRUE or FALSE. The Frequency Traceable is TRUE if the Time Traceable is TRUE, otherwise it is FALSE. About the PTP Second and UTC Time The PTP Time Mode selections are PTP and UTC.
  • Page 56: Disable The Ptp Protocol

    C H A P T E R F O U R Disable the PTP Protocol The instructions below assume that the PTP Option has been installed on Port 0 ( ) of your So- eth0 noma. To check, see the section titled Option at the beginning of this chapter. To disable the Precision Time Protocol on Port 0 issue the following command: chmod -x /etc/rc.d/rc.ptpd0 Copy the rc.ptpd0 file to the non-volatile FLASH area like this:...
  • Page 57: Chapter Five - Security

    "Smarter Timing Solutions" Five Chapter Security Your Sonoma incorporates several important security features to prevent unauthorized tampering with its operation. Many of these are standard multiple-user access control features of the underlying Linux operating system which controls the Sonoma. Others are provided by the additional protocol servers selected for inclusion in your Sonoma, and the way that they are configured.
  • Page 58: Restrict Access

    C H A P T E R F I V E • Direct root logins are only permitted on the local RS-232 console or via SSH. • The secure copy utility, , eliminates the need to use the insecure FTP protocol for transferring program updates to the Sonoma.
  • Page 59: Restrict Access - Https

    S E C U R I T Y This tells to deny access to to all hosts not listed in the /etc/ tcpd in.telnetd, sshd snmpd hosts.allow file. The daemons also parse this file directly prior to granting access to snmpd sshd a requesting host.
  • Page 60: Restrict Query Access - Ntp

    C H A P T E R F I V E After making and saving your changes, you must copy the edited file to the non-volatile FLASH area and reboot the unit: cp -p /etc/httpd/httpd.conf /boot/etc/httpd reboot Restrict Query Access - NTP The Network Time Protocol (NTP) implementation in the Sonoma is built from the reference distri- bution from: http://www.ntp.org...
  • Page 61: Disable Protocols

    S E C U R I T Y restrict default noquery nomodify nopeer restrict 127.0.0.1 nomodify restrict 0::1 nomodify restrict 192.168.1.10 nomodify Disable Protocols See below for instructions on how to completely disable the following protocols: Telnet, Time, Day- time, SSH, SNMP, and HTTPS. See Chapter 4 - PTP/IEEE-1588 Option for how to disable PTP. The Network Time Protocol (NTP) cannot be disabled.
  • Page 62: Re-Enable Snmp, Ssh And Https

    C H A P T E R F I V E Re-Enable SNMP, SSH and HTTPS If you have disabled SNMP, SSH or HTTPS, and you want to re-enable it, all you need to do is re- move the rc file from the /boot/etc/rc.d directory using one or more of these commands: rm /boot/etc/rc.d/rc.snmpd rm /boot/etc/rc.d/rc.sshd rm /boot/etc/rc.d/rc.httpd...
  • Page 63: Configure Keys

    S E C U R I T Y Configure Keys On initial boot-up from out-of-the-box, the SSH start-up script, /etc/rc.d/rc.sshd, will detect that no keys are present in the /etc/ssh directory. It will call to generate a set of host keys and ssh-keygen then it will copy them to the /boot/etc/ssh directory.
  • Page 64: Configure Certificate And Key

    NTP Client Setup. You can also restrict NTP query access. See Restrict Query Access - NTP in this chapter. Network Security Vulnerabilities EndRun addresses major network security vulnerabilities that affect Sonoma at the top of this web- page: http://www.endruntechnologies.com/fsb.htm This Application Note describes best practices to secure your time server and mitigate many network security vulnerabilities: http://www.endruntechnologies.com/pdf/AppNoteSecurity.pdf...
  • Page 65: Chapter Six - Simple Network Management Protocol (Snmp)

    "Smarter Timing Solutions" Chapter Simple Network Management Protocol (SNMP) Your Sonoma includes the NET-SNMP version 5.5.1 implementation of an SNMP agent, , and snmpd a SNMP notification/trap generation utility, . It supports all versions of the protocol in snmptrap use today: SNMPv1 (the original Internet standard), SNMPv2c (never reached standard status, often called “community SNMP”) and SNMPv3 (the latest Internet standard).
  • Page 66: Enterprise Management Information Base (Mib)

    Enterprise Management Information Base (MIB) In addition to providing the SNMP variables contained in MIB-II as described in RFC-1213, EndRun Technologies has implemented an enterprise MIB using the syntax of the SMI version 2 (SMIv2) as described in RFC-2578. Your Sonoma will have one of the two MIBs listed below:...
  • Page 67: Change Default Community Strings (Passwords)

    S I M P L E N E T W O R K M A N A G E M E N T P R O T O C O L ( S N M P ) munity and “endrun_1” for the read-write community. This is all that is required for operation under v1 and v2c of SNMP.
  • Page 68: Configuration Of Snmpv3

    SMI object tree. The second line defines a SNMPv3 read-only user ntpuser whose minimum security level will be authenticated but not encrypted, and who will have read-only access to the entire iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).endRun- TechnologiesMIB(13827) branch of the SMI object tree. After adding the user lines to /etc/ snmpd.conf, copy it to the /boot/etc directory using...
  • Page 69: Disable Or Restrict Access

    S I M P L E N E T W O R K M A N A G E M E N T P R O T O C O L ( S N M P ) puser to be created who may be authenticated using the Secure Hash Algorithm (SHA) with password Sonoma_0.
  • Page 70 C H A P T E R S I X This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 71: Chapter Seven - Hyper Text Transport Protocol Secure (Https)

    "Smarter Timing Solutions" Seven Chapter Hyper Text Transport Protocol Secure (HTTPS) This chapter briefly describes the HTTPS interface that resides on the Sonoma GPS Time Server. The HTTPS interface to the Sonoma is a fast and easy-to-use graphical interface that is compatible with your standard web browser.
  • Page 72: Https Interface Description

    C H A P T E R S E V E N HTTPS Interface Description For security reasons the web pages on the Sonoma show status and configuration information only. You cannot change any operational settings, however you can perform upgrades to the Sonoma firm- ware, which is done with several security measures in place.
  • Page 73: Navigation

    H T T P S I N T E R F A C E Navigation The main menu tabs across the top of each webpage allow you to navigate through the status infor- mation in the Sonoma while links on the left side of each webpage provide subcategory navigation. For example, in the page below the main menu tabs are: Home, Receiver, Plots, Clock, I/O, Faults, Network, NTP, PTP and Firmware.
  • Page 74: Page Descriptions

    Model Sonoma N12 Serial Number Serial number of the Sonoma N12. This field will not be shown for units shipped before August 2015. UTC Time, The current UTC date and time is shown. This date will show year 1980 if UTC Date the time has not yet been acquired.
  • Page 75: Plots Page

    There are three types of data plots available for viewing: CPU, NTP, Oscillator and Receiver (for units shipped after May 2017, with the EndRun GPS Receiver). The large data plot shown on any of the plot pages is the last data plot viewed. This could be from any one of the three data types (CPU, NTP, Oscillator or Receiver).
  • Page 76: Receiver: Receiver Page

    C H A P T E R S E V E N Receiver: Receiver Page This page contains information related to the GPS Subsystem/Receiver. Data fields are described below. For units shipped after May 2017, with the EndRun GPS Receiver, there will be additional fields. GPS Receiver Status...
  • Page 77: Receiver: Oscillator Page

    H T T P S I N T E R F A C E WNLSF, DN These fields show the GPS week number and day number of week at the end of which the future leap second will take effect. This could be in the past if a leap second insertion has recently taken place.
  • Page 78: Clock Page

    C H A P T E R S E V E N Coast Duration This shows the number of seconds the GPS Subsystem has been in coast mode, while the Sonoma is unlocked to GPS. Coast mode is another term for holdover mode.
  • Page 79: Faults: Fault Mask Page

    H T T P S I N T E R F A C E Faults: Fault Mask Page This page shows the fault masks available. Fault Masks Signal Fault This field shows the current mask setting for the Signal Fault, either Masked or Enabled.
  • Page 80: Ntp Page

    C H A P T E R S E V E N NTP Page The NTP Status page shows all information related to NTP operation. NTP Status Status The stratum field has several possible values: Stratum 1: The server is fully synchronized and accurate. Stratum 2: The server is synchronized to a Stratum 1 server.
  • Page 81: Firmware: Linux Rfs Upgrade Page

    The latest released versions of Sonoma firmware are freely available on the EndRun Technologies website. For detailed information on how to perform the upgrade either via the network port, the serial port, or the HTTPS interface see Appendix B - Upgrading The Firmware.
  • Page 82 C H A P T E R S E V E N This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 83: Chapter Eight - Ipv6

    "Smarter Timing Solutions" Eight Chapter IPv6 The Sonoma Time Servers support IPv6 out-of-the-box with a modern version 3.2.2 Linux kernel. During network configuration, you have the option to disable IPv6 on either or both Ethernet ports. The IPv6 addressing scheme will see expanding deployment in the near future due to the fact that there are no longer any IPV4 addresses to be allocated in many regions of the world.
  • Page 84: Ntp

    C H A P T E R E I G H T By default, is factory-configured to listen on both IPv4 and IPv6 addresses on all interfaces. ntpd This may be changed by editing /etc/ntp.conf and adding the desired directives to interface achieve the desired behavior, and then copying it to /boot/etc.
  • Page 85: Chapter Nine - Console Port Control And Status

    Unix/Linux commands, see Appendix C - Helpful Linux Information. Console Ports Three interface ports are available on the Sonoma N12. Two are 10/100/1000Base-T ethernet ports and one is an RS-232 serial port. Network cables and a serial cable are provided with each Sonoma shipment.
  • Page 86: Available User Commands

    C H A P T E R N I N E Available User Commands COMMAND FUNCTION accessconfig Interactive script that guides you in configuring access to the Sonoma that is limited telnet snmpd to specific hosts. The resulting /etc/hosts.allow and /etc/hosts.deny files are saved to the non-volatile FLASH disk.
  • Page 87 C O N T R O L A N D S T A T U S C O M M A N D S ntpconfig Interactive script that guides you in configuring the NTP Subsystem. Allows configuration of MD5 authentication and broadcast/multicast mode.
  • Page 88 C H A P T E R N I N E serialnumber Prints the serial number of the Sonoma. The serial number is not available using this command in units shipped before August 2015. setantfltmask Command to enable or mask the Antenna Fault. See the command.
  • Page 89: Detailed Command Descriptions

    C O N T R O L A N D S T A T U S C O M M A N D S updatekernelflag Command to update the flag stored in FLASH that is read by the Linux bootloader at boot time to select operation with either the factory-installed or upgraded kernel.
  • Page 90: Antfltmask

    C H A P T E R N I N E antfltmask This command displays the current setting for the Antenna Fault Mask. Command: antfltmask Sonoma reply: Antenna Fault is ENABLED caldelay This command displays the current calibration delay setting. The allowable calibration delay range is ±500,000 nanoseconds.
  • Page 91: Faultstat

    C O N T R O L A N D S T A T U S C O M M A N D S faultstat This command returns the summary of all system fault states in a user-friendly format. It decodes the fault status word (FLTS) returned in the command and displays the result in a tabular form gpsstat...
  • Page 92: Gpsrefpos

    C H A P T E R N I N E gpsrefpos This command displays the current GPS Subsystem reference position. The source of the position, which is one of UNK (unknown), DYN (dynamic), USR (user entered) or AVG (24 hour average of GPS fixes) is displayed first.
  • Page 93 C O N T R O L A N D S T A T U S C O M M A N D S EFCDAC is the system oscillator Electronic Frequency Control 20-bit DAC value, 0 to 1048575 with larger numbers implying higher oscillator frequency. Typical range is 320000 to 680000.
  • Page 94: Gpstrkstat

    C H A P T E R N I N E Command: gpsstat Sonoma reply: LOCKED TFOM = 4 2001 092 04:48:56 13 13 2 7 328605 41.6 008A LOCKED TFOM = 4 2017 092 04:48:56 18 18 2 7 181 328605 41.6 0100 008A gpstrkstat This command displays the current GPS Subsystem satellite tracking status.
  • Page 95: Gpsversion

    C O N T R O L A N D S T A T U S C O M M A N D S gpsversion This command displays the firmware and hardware versions of the GPS Subsystem. Command: gpsversion Sonoma reply: F/W 6010-0071-000 Ver 1.00 - FPGA 6020-0012-000 Ver 01 - JAN 15 17:03:27 2013 help This command displays a list of the Sonoma commands (not Linux commands).
  • Page 96: Ntpconfig

    C H A P T E R N I N E This script creates or modifies these files: /etc/HOSTNAME, /etc/hosts, /etc/networks, /etc/resolv.conf and /etc/rc.d/rc.inet1.conf. All of these are non-volatilely stored in the FLASH disk /boot/etc direc- tory. You must reboot the Sonoma after running this script for the changes to take effect. Command: netconfig Sonoma reply:...
  • Page 97: Oscctrlstat

    C O N T R O L A N D S T A T U S C O M M A N D S SENT/sec is the current rate of NTP packets being sent per second. DROPCNT is a count of the number of NTP packets dropped since startup of the NTP daemon. This is a 32-bit counter so it will wrap back to zero after 4,294,967,295 packets.
  • Page 98: Passwd

    This command is not available in units shipped before June 2017. It shows the serial number of the EndRun GPS Receiver inside Sonoma. See Chapter 1 - Introduction, GPS Receivers for informa- tion on EndRun’s GPS Receiver. S o n o m a U s e r M a n u a l...
  • Page 99: Rcvrstat

    F/W 6010-0081-000 Ver 1.00 - FPGA 6020-0014-000 Ver 01 - MAR 24 15:05:36 2015 rcvrversion: command not found If the command is not found then your Sonoma does not have an EndRun GPS Receiver. resetlastgpswn This command is not available in units shipped before June 2017. It is for use with a GPS simulator.
  • Page 100: Setcaldelay

    C H A P T E R N I N E from creating an alarm condition. Some installations may need to mask this fault due to special antenna situations like splitters or DC blocks that confuse the antenna detection circuit. The factory default setting is ENABLED.
  • Page 101: Setsigfltmask

    C O N T R O L A N D S T A T U S C O M M A N D S Command: setgpsrefpos Sonoma reply: Interactive utility is started. setpwrfltmask (Optional) See Chapter 10 - Options, Masking Dual Power Supply Fault Alarms for information on this com- mand.
  • Page 102: Sysosctype

    C H A P T E R N I N E sysosctype This command displays the installed system oscillator type. It is either TCXO, OCXO or Rubidium. The standard oscillator type is the TCXO. Command: sysosctype Sonoma reply: Installed Oscillator is TCXO. sysrootfs This command returns the currently loaded Linux root file system, either 0 or 1, where 0 is the fac- tory-installed root file system and 1 is the upgraded root file system.
  • Page 103: Systemio (Optional)

    C O N T R O L A N D S T A T U S C O M M A N D S YEAR is the year of the UTC timestamp of the most recent update received from the GPS Sub system.
  • Page 104: Sysversion

    C H A P T E R N I N E Command: systimemodeconfig Sonoma reply: Interactive utility is started. sysversion This command displays the firmware version and build date of the Linux root file system. Command: sysversion Sonoma reply: Sonoma_N12 GPS 6010-0065-000 v 1.00 - Jan 16 22:38:21 2013 updaterootflag This command allows you to update the configuration of the Linux bootloader after a new root file system image has been written to the UPGRADE root file system partition of the Sonoma FLASH...
  • Page 105: Upgradercvr

    Sonoma reply: Shows progress indicator. upgradercvr This utility is not available in units shipped before June 2017. It allows you to upgrade the EndRun GPS Receiver firmware. See Chapter 1 - Introduction, GPS Receivers for information on EndRun’s GPS Receiver.
  • Page 106: Wrt_Sw_Opt

    C H A P T E R N I N E Command: upgradesubsys Sonoma reply: Upgrade progress is shown. wrt_sw_opt See Chapter 10 - Options, Software Options for information on this command. S o n o m a U s e r M a n u a l...
  • Page 107: Chapter Ten - Options

    Normally, EndRun products are configured from the factory with software options enabled. But software options are also field-installable. In other words, you can enable a software option yourself, after you have received your Sonoma. First you must obtain an 8-digit license key from EndRun Technologies, then you can enable it using the command.
  • Page 108: Software Option Bit Definitions

    C H A P T E R T E N Software Option Bit Definitions Bits are numbered from 0 to 31, from right to left. Currently, there are only two software options defined in the Sonoma. These are for PTP/IEEE-1588 enabled on port 0 (eth0) or port 1 (eth1). The table below shows the currently defined bits.
  • Page 109: Programmable Pulse Output (Ppo)

    O P T I O N S Programmable Pulse Output (PPO) The PPO Option provides user-selectable, on-time pulse rates from 1 PPS to 10 MPPS. Other selec- tions are 1PP60S (pulse per 60 seconds, on the minute), 1PP2S (pulse per 2 seconds, on the even second), and Inverted 1PPS (falling edge on-time).
  • Page 110: Time Code Output

    C H A P T E R T E N Command: systemioconfig Sonoma reply: Interactive script is started so you can change the pulse width. Time Code Output There are two different kinds of Time Code outputs. Either amplitude-modulated (AM) or DC-Shift. Connectors will be labeled as either AMCODE or DCCODE.
  • Page 111: Alarm Output

    O P T I O N S Alarm Output The Alarm Output provides an open-collector output that indicates when the GPS Subsystem has lost lock, or when serious hardware faults are detected. For a detailed description of the faults see Appen- dix G - System Faults.
  • Page 112: Serial Time Output

    There are several different formats for this ASCII string. The format, baud rate and parity can all be changed via the console port. Baud rate selections are 57600, 19200, 9600, and 4800. Parity selec- tions are odd, even, and none. Format selections are Sysplex, Truetime, EndRun, EndRunX, NENA and NMEA.
  • Page 113: Truetime Format

    Sonoma. For example, if you want an output with this string format that uses Local Time, then select the Truetime format. EndRun Format The time contained in this string depends on the time mode of the Sonoma. For example, if you want the time in this string to be UTC, then set the time mode of the Sonoma to UTC.
  • Page 114: Endrunx (Extended) Format

    C H A P T E R T E N EndRunX (Extended) Format The EndRunX format is identical to the EndRun format with the addition of two fields - the cur- rent leap second settings and the future leap second settings. The following string is sent once each second: T YYYY DDD HH:MM:SS zZZ m CC FF<CR><LF>...
  • Page 115 O P T I O N S <CR> is the ASCII carriage return character (0x0D). The first <CR> is the on-time character. <LF> is the ASCII line feed character (0x0A). NENA1 <CR><LF>Q^WWW^DDMMMYY^HH:MM:SS<CR><LF> is the time quality indicator and may be either: <space>...
  • Page 116: Nmea Format

    “on-time” character. Once the unit is locked to GPS, the “on-time” character starts transmitting within the first 20 microseconds of each second.. GGA (GPS Fix Data) The GGA sentence contains the time, position, and fix related data. (EndRun does not calculate mean sea level.) Examples are below: $GPGGA,,,,,,,0,00,,,M,,,*2B<CR><LF>...
  • Page 117 O P T I O N S Field 3 12244.020 Longitude in dddmm.mmm Field 4 Direction of longitude (W=west, E=east) Field 5 173423.00 UTC time of fix (hhmmss.ss) Field 6 A=data valid, V=data not valid Field 7 A=autonomous mode, N=data not valid Checksum *34 Msg End <CR><LF>...
  • Page 118 C H A P T E R T E N Field 3 3827.030 Latitude in ddmm.mmm Field 4 Direction of latitude (N=north, S=south) Field 5 12244.020 Longitude in dddmm.mmm Field 6 Direction of longitude (W=west, E=east) Field 7 0.08 Speed over ground, knots Field 8 158.14 Course made good, degrees True...
  • Page 119: Power Supply Options

    O P T I O N S Field 5 Local time zone hour, offset from UTC (- for east longitude) Field 6 Local time zone minutes, offset from UTC Checksum *69 Msg End <CR><LF> Power Supply Options Your Sonoma can be configured with several optional power supply inputs which are listed in Appen- dix H - Specifications.
  • Page 120: Masking Dual Power Supply Fault Alarms

    C H A P T E R T E N Masking Dual Power Supply Fault Alarms You can mask the Primary and Secondary Faults to prevent them from causing a system alarm. Masking a fault will prevent it from causing the Alarm LED and Alarm Output (if any) from going active.
  • Page 121: Appendix A - Time Figure Of Merit (Tfom)

    "Smarter Timing Solutions" Appendix A Time Figure of Merit (TFOM) This appendix describes the Time Figure of Merit number. The TFOM number indicates the level of accuracy that should be included in the interpretation of the time-of-day and ranges from 3 to 9: time error is <...
  • Page 122 A P P E N D I X A This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 123: Upgrade Via The Https Interface

    The following picture shows an example of the Linux RFS (root file system) Upgrade page. All fields are filled in with the default values needed to download the appropriate firmware image from the EndRun Technologies website. You can use these default values unless you want to point to a different FTP server.
  • Page 124 2. If your Sonoma does not have access to the Internet, you must first download the appropriate file(s) from the EndRun Technologies website to the computer that you will be using later to access the Sonoma via its HTTPS interface. Use this link to get the file(s) you want: http://www.endruntechnologies.com/upgradesonomaG.htm...
  • Page 125: Upgrade Via The Console Port

    First you need to download the Linux RFS firmware from the EndRun website to a place on your network which is accessible to the Sonoma. The link to the Sonoma upgrade page is shown above.
  • Page 126 It is possible that the file downloaded was corrupt or that you forgot to set your FTP down- load file mode to binary when downloading the file--either from the EndRun Technologies website or when transferring it to the Sonoma.
  • Page 127: Recovering From A Failed Rfs Upgrade

    Performing the Linux Kernel Upgrade First you need to download the Linux kernel firmware from the EndRun website to a place on your network which is accessible to the Sonoma. The link to the Sonoma upgrade page is shown above.
  • Page 128: Recovering From A Failed Kernel Upgrade

    EndRun Technologies website or when transfer- ring it to the Sonoma. Recovering from a Failed Kernel Upgrade To restore your Sonoma to a bootable state using the factory kernel, you must use the serial I/O port and reboot the Sonoma by cycling the power.
  • Page 129: Performing The Gps Subsystem Upgrade

    Performing the GPS Subsystem Upgrade First you need to download the GPS Subsystem firmware from the EndRun website to a place on your network which is accessible to the Sonoma. There are two different versions of the GPS Sub- system firmware.
  • Page 130: Problems With The Gps Subsystem Upgrade

    F/W 6010-0081-000 Ver 1.11 - FPGA 6020-0014-000 Ver 0004 - NOV 28 13:30:20 2016 rcvrversion: command not found If the command is not found then your Sonoma does not have an EndRun GPS Receiver. No firmware upgrade is possible. Otherwise, you do have an EndRun GPS Receiver and you may upgrade the firmware following the instructions below.
  • Page 131: Problems With The Gps Receiver Upgrade

    This section has instructions for upgrading the Field-Programmable Gate Array (FPGA) resident on the EndRun GPS Receiver. This is rarely, if ever, used so is not an option on the HTTPS interface. If you want to upgrade the EndRun GPS Receiver, see the section above called Performing the GPS Receiver Upgrade.
  • Page 132 Now issue the following command to the Sonoma console to initiate the upload: upgradercvrfpga This command performs the file transfer to the FPGA on the EndRun GPS Receiver. You will see a file transfer progress message while it is performing the transfer. Next, issue the following command...
  • Page 133: Linux Users

    "Smarter Timing Solutions" Appendix Helpful Linux Information You do not need knowledge of Linux commands in order to operate the Sonoma. All commands nec- essary for proper operation are described in Chapter 9 - Console Port Control and Status. However, the Sonoma does support a subset of the standard Linux commands and utilities and it uses the bash shell, which is the Linux standard, full-featured shell.
  • Page 134: Change Password

    A P P E N D I X C apropos ntp The relevant available man pages are shown: ntp [] - keygen - Create a NTP host key ntpd [] - NTP daemon program ntpdc [] - vendor-specific NTP query program ntpq [] - standard NTP query program ntpsnmpd []...
  • Page 135: Text Editors

    Linux appliances. When EndRun Technologies’ first generation Linux-based embedded network time servers were in- troduced, they fell into this category and the text editor was appropriate. Now it is included on...
  • Page 136: Query And Change Ethernet Ports

    A P P E N D I X C Query and Change Ethernet Ports is a Linux utility that allows you to query or change the settings for Port 0 ( ) and Port ethtool eth0 ). For example, to view current settings for Port 0 issue the following command: eth1 ethtool eth0 Here is an example of one way to set the speed on Port 0 to 1000Base-T:...
  • Page 137: Appendix D - Third-Party Software

    "Smarter Timing Solutions" Appendix D Third-Party Software The Sonoma is running several different software products created and/or maintained by open source projects. Open source software comes with its own license. These are printed out for your informa- tion below. The license for the GNU software project requires that we provide you with a copy of all source code covered under the GNU Public License (GPL) at your request.
  • Page 138 A P P E N D I X D For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code.
  • Page 139 T H I R D - P A R T Y S O F T W A R E a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is de- rived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
  • Page 140 A P P E N D I X D The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable.
  • Page 141 T H I R D - P A R T Y S O F T W A R E reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
  • Page 142: Ntp Software License

    A P P E N D I X D Software License Information about the NTP Project, led by Dr. David Mills, can be found at www.ntp.org. The distribution and usage of the NTP software is allowed, as long as the following copyright notice is included in our documentation: The following copyright notice applies to all files collectively called the Network Time Protocol Ver- sion 4 Distribution.
  • Page 143 T H I R D - P A R T Y S O F T W A R E * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2.
  • Page 144: Ptp Software License

    A P P E N D I X D PTP Software License The PTP/IEEE-1588 option as implemented in the Sonoma is covered by patents and copyrights. For patents that pertain to the Std No 1588, see the IEEE Standards Association at http://standards.ieee.org/db/patents/pat1390.html Information about the PTP Project, led by Kendall Correll, can be found at ptpd.sourceforge.net.
  • Page 145: Antenna Location

    "Smarter Timing Solutions" Appendix Installing the GPS Antenna This appendix contains guidelines for installing the GPS antenna. The majority of this appendix is devoted to rooftop installations. The last sections contains information on a window-mount installa- tion and on obtaining a GPS reference position. Antenna Location The location of the antenna must be chosen based on having as clear a view of the sky as possible.
  • Page 146: Gps Antenna Kit

    • 50 feet of RG-59U (Belden 9104) Cable/TNC Male In June 2017, EndRun changed the GPS antenna model that shipped with the time server. A drawing of the GPS roof-top installation for the two different antennas is shown at the end of this appendix in Figures 1A and 1B.
  • Page 147: Long Cable Runs

    Most GPS Time Servers are installed with only 50 feet (15 meters) of antenna cable. However, there are many circumstances where 50 feet is inadequate. EndRun can accommodate a cable length of up to 1000 feet using a combination of low-loss cable and preamplifiers.
  • Page 148: Using Three Preamplifiers

    Signal splitters are used when two time servers are sharing one antenna installation. The smart GPS Splitter supplied by EndRun is a one-input, two-output device. In the normal configuration, one of the splitter RF outputs (J1) passes DC from the connected GPS Receiver through the splitter to the antenna, allowing the GPS Receiver to power both the antenna and the splitter amplifier.
  • Page 149: Calibrate Your Receiver

    3. The signal splitter supplied by EndRun has a built-in preamplifier to compensate for signal loss through the splitter. If using a splitter other than the one supplied by EndRun you may need to com- pensate for splitter signal loss by using a separate GPS preamplifier.
  • Page 150: Mounting On A Rooftop

    Installations subject to lightning strikes should use a lightning arrestor installed at the building en- trance. A lightning arrestor suited for this purpose is available through EndRun Technologies. The arrestor must be installed according to the manufacturer’s instructions.
  • Page 151: Mounting Inside A Window

    Stratum 1 time. An OCXO upgrade will allow the time server to go for 35 days without receiving a GPS signal and is extra insurance for window-mount installations. A window-mount antenna kit is available from EndRun. Obtaining A...
  • Page 152: Using "Indirect Gps

    We call it “indirect GPS”. CDMA is not available worldwide, but if you work in an area with CDMA cell phone service then you will probably be able to mount your antenna on top of your equipment rack inside your data center. Contact EndRun Sales or Support for more information.
  • Page 153 I N S T A L L I N G T H E G P S A N T E N N A ����� ������ ��� ������� ��������� ��� ����� ������ ��� ��������� �������� ������� �� �������� ������ ������� ����� ��������...
  • Page 154 A P P E N D I X E ��� ������� ��� ��������� �������� ������� ������� ����� �������� ���� ���� ����� ���� ���� ���� ���� ����� FIG UR E 1B - G PS ANTEN NA RO OFTO P M OU N TING G U IDE LIN E S ( SHIPPED BEFOR E JUN E 2 01 7) S o n o m a U s e r M a n u a l...
  • Page 155 I N S T A L L I N G T H E G P S A N T E N N A ����������� ������������ ����������� ������������� ������������� ������������ ������������� ���������������� ���������������� ����������������� � ����������� ����������� ����������������������� ����������������������� ���������� ���������� ���������������������...
  • Page 156 A P P E N D I X E S o n o m a U s e r M a n u a l...
  • Page 157: Automatic Leap Second Insertion

    Bulletin C confirms whether a leap second will or will not be inserted at the next possible insertion point. The IERS website is: http://www.iers.org EndRun summarizes this information at this link: http://www.endruntechnologies.com/leap.htm S o n o m a U s e r M a n u a l...
  • Page 158 A P P E N D I X F This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 159: Overview

    If the condition persists indefinitely, and a problem with the antenna is not evident, then please contact EndRun Customer Support. S o n o m a U s e r M a n u a l...
  • Page 160 GPS Subsystem FLASH Writes (FLSH) This fault indicates that the GPS Subsystem is unable to verify a write to the FLASH non-volatile parameter storage area. This should not ever occur under normal operation.. Please contact EndRun Customer Support. GPS Receiver Communication (RCVC) This fault indicates that the GPS Subsystem is unable to establish communications with the GPS Receiver.
  • Page 161 Sonoma began shipping with these receivers in June 2017. When a fault on the EndRun GPS Receiver occurs, the system fault indicator RCVF will show fault and the Alarm LED will light. You can see which fault is the problem by using the...
  • Page 162 This fault indicates that there is an unlock condition between the receiver oscillator and the other system timebase clocks. This is a fatal fault. Please contact EndRun Customer Support. S o n o m a U s e r M a n u a l...
  • Page 163: Specifications

    "Smarter Timing Solutions" Appendix H Specifications GPS Receiver: EndRun GPS Timing Receiver (Started shipping in June 2017). L1 Band – 1575.42 MHz. 12 Channels, C/A Code. Single-satellite mode and dynamic-platform mode (shipboard only). 15 dB minimum gain at receiver input.
  • Page 164: System Status Leds

    A P P E N D I X H Server Platform: Operating System Kernel Version: 3.2.2 Slackware Linux Distribution: 13.1 Processor: 1.2 GHz. RAM: 512M FLASH: 512M Supported IPv4 Protocols: SNTP, NTP v2, v3, v4, SHA/MD5 authentication, broadcast/multicast mode and autokey. SSH client and server with “secure copy”...
  • Page 165 S P E C I F I C A T I O N S Serial Port I/O: Signal: I/O port at RS-232 levels for secure, local terminal access. Parameters: 19200 baud, 8 data bits, no parity, 1 stop bit. Connector: Rear-panel DB-9M connector labeled “RS-232”. To connect to a computer, a null-modem adapter must be used.
  • Page 166 A P P E N D I X H Options: See Chapter 10 - Options for more information. Optional PTP/IEEE-1588 specifications are listed above. DC Power Input: 12 VDC (10-20 VDC), 6.0A maximum. 24 VDC (19-36 VDC), 3.0A maximum. 48 VDC (37-76 VDC), 2.0A maximum. 125 VDC (70-160 VDC), 1.0A maximum.
  • Page 167 Baud Rate: User Selectable to 4800, 9600, 19200 or 57600. Parity: User Selectable to Odd, Even or None. ASCII Formats: User-Selectable to Sysplex, EndRun, EndRunX, Truetime, NENA or NMEA. Accuracy: The “on-time” characters starts transmitting within the first 20 microsecs of each second.
  • Page 168 A P P E N D I X H ����� ����� ����� ����� ����� ��� ���� � ���� ���� ���� ��������� ����� ����� �� ������ � � �� � �� ����� ��� ��� � ���� � ���� ��� ���� �� ������ ���...
  • Page 169 S P E C I F I C A T I O N S S o n o m a U s e r M a n u a l...
  • Page 170 A P P E N D I X H This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 171 "Smarter Timing Solutions" Special Modifications Changes for Customer Requirements From time to time EndRun Technologies will customize the standard Sonoma Time Server for special customer requirements. If your unit has been modified then this section will describe what those changes are.
  • Page 172 S P E C I A L M O D I F I C A T I O N S This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 174 2270 Northpoint Parkway Santa Rosa, CA 95407 TEL 1-877-749-3878 FAX 707-573-8619 "Smarter Timing Solutions" www.endruntechnologies.com...

Table of Contents

Save PDF