EndRun Sonoma D12 User Manual

EndRun Sonoma D12 User Manual

Network time server cdma-synchronized
Table of Contents

Advertisement

Sonoma D12
CDMA-Synchronized
User Manual
USM3026-0000-000 Revision 5
March 2016
Network Time Server
"Smarter Timing Solutions"

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for EndRun Sonoma D12

  • Page 1 "Smarter Timing Solutions" Sonoma D12 Network Time Server CDMA-Synchronized User Manual USM3026-0000-000 Revision 5 March 2016...
  • 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 ..........30 Configure NTP Client for Multicast .
  • Page 9 ..........48 Configure Certificate and Key .
  • Page 10 ............. 63 NTP Page .
  • Page 11 ............77 get_sw_opts .
  • Page 12 ............96 EndRun Format...
  • Page 13 ..........96 EndRunX (Extended) Format .
  • Page 14 ............107 Network Menu .
  • Page 15 Appendix C - Helpful Linux Information ........123 .
  • Page 16 Appendix H - Specifications ..........145 Special Modifications - Changes for Customer Requirements .
  • Page 17: Chapter One - Introduction

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

    C H A P T E R O N E CDMA Timing - How It Works The CDMA Subsystem in the Sonoma receives transmissions from base stations, also known as cell sites, that are operating in compliance with the TIA/EIA IS-95 standard for Code Division Multiple Access (CDMA) mobile telecommunications.
  • Page 19: Where To Use It

    Where to Use It First, the Sonoma must be deployed in a cellular or PCS IS-95 CDMA coverage area. Cellular is a commonly used term implying that the frequency band for the base station carrier transmissions is 824-895 MHz. This is in contrast to PCS, which implies operation in the 1850-1990 MHz frequency band.
  • 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 D12 Time Server (CDMA) shipment typically contains: • Sonoma D12 (part # 3026-0001-000 or #3026- 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

    B A S I C I N S T A L L A T I O N Performing a Site Survey Using the status LED indicators, it’s easy to find out if your Sonoma will work in your desired loca- tion: 1.
  • 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 D12 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 Front-Panel Keypad

    B A S I C I N S T A L L A T I O N If your network does use DHCP for host configuration, and you are in a hurry to get your Sonoma up and running, you may proceed to Verifying Network Configuration to make sure that the network parameters were set up correctly.
  • Page 26: Test The Serial Port

    C H A P T E R T W O 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 27: Using Netconfig To Set Up Your Ip

    “root” user. After correctly entering the password at this prompt, password: the sign on message is shown. It identifies the host system as Sonoma D12 CDMA and shows the software part number, version and build date. The out-of-the-box hostname is set to “Sonoma_D12”, and the domainname is set to “your.domain”.
  • 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 D12 CDMA(root@Sonoma_D12:~)-> 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 D12 CDMA(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_D12 CDMA 6010-0065-000 v 1.00 Sat Jan 19 14:17:44 UTC 2013 Sonoma_D12 CDMA (root@host:~)-> This last line is the standard Sonoma D12 CDMA 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: Configuring Ntp Using The Network Interface Or Serial Port

    C H A P T E R T H R E E Configuring NTP Using the Network Interface or Serial Port The following shows the question and answer configuration utility called . The user- ntpconfig entered responses are shown in a larger font size. Sonoma_D12 CDMA(root@Sonoma_D12:~)->...
  • Page 35 N E T W O R K T I M E P R O T O C O L ( N T P ) Enter a key number (1-65534) or 0 to quit: ---NTP Authentication Configuration Do you want authentication enabled using some or all of the keys in the ntp.keys file? ([y]es, [n]o) 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 ******************************************************************************* ******************************************************************************* The Sonoma_D12 CDMA Network Time Protocol configuration has been updated. Please re-boot now for the changes to take effect. ******************************************************************************* ******************************************************************************* ******************************************************************************* Configuring the Sonoma as a Stratum 2 Server Operating the Sonoma as a Stratum 1 Server is the recommended mode.
  • Page 37: Mask Alarm

    N E T W O R K T I M E P R O T O C O L ( N T P ) Mask Alarm In Stratum 1 operation an alarm will be indicated when there is a loss of signal. For Stratum 2 opera- tion you may not want to see this alarm.
  • Page 38: Unix-Like Platforms: Md5 Authenticated Ntp Client Setup

    C H A P T E R T H R E E This line tells to use the NTP server at address 192.168.1.120 in addition to any other servers ntpd which might also be configured in the client’s ntp.conf file. Restart to have it begin using the Sonoma server.
  • 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 ) IMPORTANT Handling of the /etc/ntp.keys file is the weak link in the MD5 authentication scheme. It is very impor- tant that it is owned by root and not readable by anyone other than root.
  • Page 40: Unix-Like Platforms: Broadcast/Multicast Ntp Client Setup

    C H A P T E R T H R E E problem.) It is also possible to have a typing error in the /etc/ntp.conf file that causes the needed key to not be included in the “trustedkey” list. Unix-like Platforms: Broadcast/Multicast NTP Client Setup Broadcast/multicast client setup is relatively simple, if: •...
  • 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 ) multicastclient ff05::101 If you are not using MD5 authentication, you would add these lines: disable auth multicastclient 224.0.1.1 or for IPv6: disable auth...
  • 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: Chapter Four - Precision Time Protocol (Ptp/Ieee-1588)

    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: Ptp Configuration Using The Network Or Serial Port

    P T P / I E E E - 1 5 8 8 PTP Configuration Using the Network or Serial Port command starts an interactive shell script that will allow you to ptpconfig0 ptpconfig1 configure the PTP Subsystem of the Sonoma. You will be prompted to set PTP parameters as fol- lows: ETH Port: 0 or 1...
  • Page 52: Ptp Status Using The Network Or Serial Port

    C H A P T E R F O U R Set the PTP Priority2 value (0-255) 128 ---PTP Delay Mechanism E2E or P2P Set the PTP Delay Mechanism (E2E or P2P) P2P ---PTP Domain Configuration Set the PTP Domain value (0-255) 0 ---PTP Time Mode Configuration Set the PTP Time Mode (UTC or PTP) PTP ---PTP TTL Configuration...
  • Page 53: Ptp Operation

    P T P / I E E E - 1 5 8 8 MODE is the PTP time mode, either UTC or PTP. is the PTP multicast time-to-live in a range from 1 to 255. CLASS is the PTP clock class one of SYNCHRONIZED, HOLDOVER, or UNLOCKED. SCALE is the PTP timescale either PTP or ARB.
  • Page 54 C H A P T E R F O U R NOTE If using a single Grandmaster, keep the default setting of 128 for Priority 1 and Priority 2. If using two redundant Grandmasters, then you can configure the preferred clock by setting Priority 1 to 127 and Prior- ity 2 to 128.
  • Page 55: About The Ptp Second And Utc Time

    P T P / I E E E - 1 5 8 8 10ms Clock is synchronized or in holdover, PTP clock < 10 milliseconds Unknown Clock is unsynchronized, TFOM = 9 The PTP Leap 59 second indicator is either TRUE or FALSE. The Leap 59 is TRUE if the PTP Tim- escale is PTP and the last minute of the current UTC day contains 59 seconds, otherwise it is FALSE.
  • 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)

    C H A P T E R S I X 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:...
  • 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 ) Change Default Community Strings (Passwords) You can, and should, change the default community names by editing /etc/snmpd.conf and modifying these two lines: rwcommunity...
  • 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 CDMA 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, Plots, Receiver, Clock, I/O, Faults, Network, NTP, PTP and Firmware.
  • Page 74: Page Descriptions

    Model Sonoma D12 Serial Number Serial number of the Sonoma D12. 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: Home: User Manual

    12% to 100%. Home: User Manual This link provides access to the Sonoma User Manual that is resident in the FLASH memory. The most recent version of the User Manual is on the EndRun website at: http://www.endruntechnologies.com/pdf/USM3026-0000-000.pdf Home: Logout Clicking on this link will immediately log you out of the Sonoma HTTPS Interface.
  • Page 76: Receiver: Receiver

    C H A P T E R S E V E N All plot files are kept in directories. There is one directory for each week. To choose a new plot to view, use the selections on the right side of the page. First, click to select a directory. Then you can either click to select one of the listed plot files, or you can use your mouse to hover over one of the plot files.
  • Page 77: Clock

    H T T P S I N T E R F A C E Channel Set This shows the current channelset being used by the CDMA Receiver. It could be North America Cellular, Korea Cellular, North American PCS, India Cellular and Japan Cellular.
  • Page 78: Faults: System Faults

    C H A P T E R S E V E N outputs. For example, if this field shows Local-Auto or Local-Manual, then the time shown on the front-panel display will be Local time but NTP will remain at UTC time. To change the time mode setting use the systimemodeconfig command via the console port.
  • Page 79: Faults: Fault Mask

    H T T P S I N T E R F A C E Faults: Fault Mask Page Fault Masks Signal Fault This field shows the current mask setting for the Signal Fault, either Masked or Enabled. When the signal fault is Masked it will prevent a Signal Loss Fault from occurring.
  • Page 80: Ptp: Status And Configuration Pages

    C H A P T E R S E V E N Source This field will show the source of time which is usually CDMA. If the Sonoma is configured as a Stratum 2 server then it will show the IP address of the upstream Stratum 1 server.
  • Page 81: Firmware: Linux Rfs Upgrade

    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 D12. 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 lockoutkp Command to lock out access to the front-panel keypad EDIT key. See the commands. kplockstat unlockkp netconfig Interactive script that allows you to configure the IP network...
  • Page 88 C H A P T E R N I N E syskernel Prints the currently booted linux kernel, either 0 or 1, where 0 is the factory-installed kernel and 1 is the upgraded kernel. sysosctype Prints the installed system oscillator type, which is one of TCXO, OCXO or Rubidium.
  • 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 Detailed Command Descriptions accessconfig This command starts an interactive script that will allow the root user to configure access limitation to the Sonoma.
  • Page 90: Cdmaleapmode

    C H A P T E R N I N E cdmaleapmode This command displays the current and future leap second settings. The leap second mode is always USER, meaning that the leap second information is user-entered. For more information on leap sec- onds see Appendix F - Leap Seconds.
  • Page 91 C O N T R O L A N D S T A T U S C O M M A N D S is the automatic gain control DAC byte, 0 to 255 with larger numbers implying higher RF gain. Typical range is 150 to 220. VCDAC is the upper 16 bits of the TCXO voltage control DAC word, 0 to 65535 with larger numbers implying higher TCXO frequency.
  • Page 92: Cdmaversion

    C H A P T E R N I N E Bit 3 Bit 2 Bit 1 Bit 0 Char 0 FLASH Writes FPGA CDMA Signal System Oscillator Configuration Char 1 CDMA Subsystem CDMA Reference CDMA Receiver Receiver Communication Time Communication Char 2 System...
  • Page 93: 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 MMDD is the month and day-of-month of the UTC timestamp of the most recent update. HH:MM:SS is the hour, minute and second of the UTC timestamp of the most recent update. LLL% is the percentage of maximum load as returned using the Linux command.
  • Page 94: Inetdconfig

    C H A P T E R N I N E Command: help cdmastat Sonoma reply: Information specific to the command is displayed. cdmastat inetdconfig This command starts an interactive script that allows you to configure the list of protocol servers which are started by the super-server daemon running in the Sonoma.
  • Page 95: Netconfig

    C O N T R O L A N D S T A T U S C O M M A N D S netconfig This command starts an interactive script that allows you to configure the IP network subsystem of the Sonoma.
  • Page 96: Oscctrlstat

    C H A P T E R N I N E +S.sssssssss is the offset in seconds between the NTP system clock and the CDMA Subsystem clock. Positive implies that the system clock is ahead of the CDMA Subsystem clock. RCVDCNT is a count of the number of NTP packets received since startup of the NTP daemon.
  • Page 97: Passwd

    C O N T R O L A N D S T A T U S C O M M A N D S MEASERR is the last measured time offset of the CDMA Subsystem to CDMA while locked, in seconds. TIMEDEV is the time deviation (TDEV) of the offset measurements in seconds.
  • Page 98: Pwrfltmask (Optional)

    C H A P T E R N I N E pwrfltmask (Optional) See Chapter 10 - Options, Masking Dual Power Supply Fault Alarms for information on this com- mand. rcvrversion This command displays the firmware and hardware versions of the CDMA Receiver. Command: rcvrversion Sonoma reply:...
  • Page 99: 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 setsigfltmask This command allows you to enable or mask the Signal Loss Fault. Parameter for this command is either MASKED or ENABLED.
  • Page 100: Sysrootfs

    C H A P T E R N I N E 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. Command: sysrootfs Sonoma reply:...
  • Page 101: 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 is the current number of leap seconds difference between the UTC and GPS timescales (16 at the time of this writing). Below is an example of a typical response to this command: Command: sysstat...
  • Page 102: Unlockkp

    C H A P T E R N I N E unlockkp This command unlocks access to the front-panel keypad EDIT key. When the EDIT key is locked, it will prevent unauthorized tampering with the unit. All other keys are still enabled so you may continue to read the status and current settings of the Sonoma.
  • Page 103: Upgraderootfs

    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: upgradekernel Sonoma reply: Shows progress indicator. upgraderootfs This utility allows you to upgrade the Linux Root File System. It is run after the rootfs.gz file has been copied to the /tmp directory on the system.
  • Page 104 C H A P T E R N I N E This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 105: 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 106: 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 107: View And Change The Ppo

    O P T I O N S View and Change the PPO On the front-panel display traverse to the Main Menu and then to CPU_I/O. This display lists any connector on the CPU Module that has an optional I/O signal. Connectors are identified as A, B or C. Select the particular connector (I/O-A, I/O-B or I/O-C) to see which signal is installed.
  • Page 108: Time Code Output

    C H A P T E R T E N Command: systemio Sonoma reply: System I/O Signal 1 PPS OUTPUT is Installed Current Setting = 1 Milliseconds Pulse Width 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.
  • Page 109: View The Fixed Rate Output Connector

    O P T I O N S PPS”, etc. This signal is specified by the customer when the order is placed, preset at the factory, and cannot be changed. For details on signal definition see Appendix H - Specifications. View the Fixed Rate Output Connector On the front-panel display traverse to the Main Menu and then to CPU_I/O.
  • Page 110: View The Dds Connector

    Baud rate selections are 57600, 19200, 9600, and 4800. Parity selections are odd, even, and none. Format selections are Sysplex, Truetime, EndRun, EndRunX, NENA and NMEA. View the Serial Time Connector On the front-panel display traverse to the Main Menu and then to CPU_I/O.
  • Page 111: Change The Serial Time Settings

    O P T I O N S Command: cpuio Sonoma reply: CPU I/O A - SERIAL TIME OUTPUT is Installed Current Setting = (See systemio command) Change the Serial Time Settings On the front-panel display traverse to the Main Menu and then to Sys_I/O. If a Serial Time output is installed in your unit, then there will be a selection for SerTimeOut.
  • Page 112: Truetime Format

    ASCII line feed character (0x0A) 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 113: Nena Format

    O P T I O N S is the sign of the offset to UTC, + implies time is ahead of UTC. is the magnitude of the offset to UTC in units of half-hours. Non-zero only when the Timemode is Local. is the Timemode character and is one of: G = GPS L = Local...
  • Page 114: Nmea Format

    C H A P T E R T E N is the colon character (0x3A) is the hour-of-the-day (00-23) is the minute-of-the-hour (00-59) is the second-of-the-minute (00-60) <CR> is the ASCII carriage return character (0x0D). The first <CR> is the on-time character. <LF>...
  • Page 115: Power Supply Options

    O P T I O N S ZDA (Time and Date) The ZDA sentence identifies the time associated with the current 1PPS pulse. Each sentence is transmitted within 500 milliseconds after the 1PPS pulse is output and tells the time of the pulse that just occurred.
  • Page 116: Dual-Redundant Power Supplies

    C H A P T E R T E N SHOCK/ENERGY HAZARD Install in Restricted Access Location. Use 10-14 AWG copper wire only. Terminal block screw torque: 9 lb-in (1 n•M). Branch circuit must have circuit breaker, 15A or less. Power must be sourced via two pole disconnect device.
  • Page 117: Display Description

    "Smarter Timing Solutions" Eleven Chapter Front-Panel Keypad and Display This section describes the Sonoma front-panel user interface which consists of a graphic vacuum- fluorescent display (VFD) and keypad. The keypad and display provide a convenient interface that allows you to quickly check the operation of the instrument and set up many control parameters. If desired, you can disable the keypad EDIT key to prevent unauthorized tampering.
  • Page 118: Display And Keypad Operation

    C H A P T E R E L E V E N Display and Keypad Operation The display menus are organized as shown below: Time / Status Display Main Menu CPU_Stat Receiver Faults Sys_I/O* CPU_I/O* Network PTP* Clock Display Firmware About Intensity &...
  • Page 119: Keypad Edit Lockout

    F R O N T - P A N E L K E Y P A D A N D D I S P L A Y Keypad EDIT Lockout As a security feature, you can disable all editing processes done through the front-panel keypad. Do this to prevent unauthorized modification of the instrument.
  • Page 120: Main Menu

    C H A P T E R E L E V E N Receiver Status: CDMA Subsystem/Receiver status as follows: WRM: Warmup period for units with oscillator upgrades. ACQ: Searching for a signal. LKG: Locking to the Pseudonoise (PN) Code. LKD: Locked.
  • Page 121: Receiver: Cdma Channelset (Channelset)

    F R O N T - P A N E L K E Y P A D A N D D I S P L A Y TFOM: This is a value between 6 and 9 and indicates clock accuracy. A detailed explanation of TFOM is in Appendix A - TFOM.
  • Page 122: Receiver: Calibrate

    C H A P T E R E L E V E N The oscillator type indicates the oscillator that is installed. Possible oscillator types are: Temperature-compensated crystal oscillator (TCXO) Oven-controlled oscillator (OCXO) Rubidium oscillator (Rb) Receiver: Calibrate Calibrate is used to set the antenna propagation delay. This will advance or retard the clock in order to correct for antenna cable length or to compensate for the inherent time offsets that may exist with external hardware such as distribution amplifiers, etc.
  • Page 123: Faults: Signal Loss Fault Mask (Sigfltmask)

    F R O N T - P A N E L K E Y P A D A N D D I S P L A Y FLSH CDMA Receiver FLASH Writes FPGA CDMA Receiver FPGA Configuration CDMA Signal Receiver Oscillator DAC Receiver Oscillator CDMA Reference Time SYN1...
  • Page 124: Network: Mac Address (Mac_Addr)

    C H A P T E R E L E V E N Network: MAC Address (MAC_Addr) This display provides the media access control (MAC) address for both network ports ( eth0 eth1 Network: REBOOT This is a way to reboot the Sonoma and is necessary after you’ve finished configuring the network parameters.
  • Page 125: Ntp: Setup

    F R O N T - P A N E L K E Y P A D A N D D I S P L A Y NTP: Setup This display provides access to the NTP broadcast and multicast settings and provides you with a convenient means of checking the current configuration and allows limited setup.
  • Page 126: Clock: Hour Mode

    Use UP and DOWN to toggle between the information windows. About The About display is selected from the Main Menu and provides contact information for EndRun Technologies. The website and toll-free phone number are listed. S o n o m a U s e r M a n u a l...
  • Page 127: 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 6 to 9: time error is <...
  • Page 128 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 129: Upgrade Via The Https Interface

    Appendix Upgrading the Firmware Periodically, EndRun Technologies will make bug fixes and enhancements to our products available for download from our website. All such downloads are freely available to our customers, without charge. You may securely upgrade your Sonoma firmware via the HTTPS interface or the console port (network/serial).
  • Page 130 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/upgradesonoma.htm...
  • Page 131: Upgrade Via The Console Port

    First you need to download the Linux Subsystem 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 132: Recovering From A Failed Rfs Upgrade

    It is possible that the file downloaded was corrupt or that you forgot to set your down- load file mode to binary when downloading the file--either from the EndRun Technologies website or when transferring it to the Sonoma. Recovering from a Failed RFS Upgrade To restore your Sonoma to a bootable state using the factory root file system, you must use the serial I/O port and reboot the Sonoma by cycling the power.
  • Page 133: Performing The Linux Subsystem Kernel Upgrade

    Performing the Linux Subsystem Kernel Upgrade First you need to download the Linux Subsystem 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 134: 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 135: Performing The Cdma Subsystem Upgrade

    CDMA Receiver see the section below called Performing the CDMA Receiver Upgrade. First you need to download the CDMA Subsystem 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 136: Problems With The Cdma Subsystem Upgrade

    Subsystem see the section above called Performing the CDMA Subsystem Upgrade. First you need to download the CDMA Receiver 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 137: Problems With The Cdma Receiver Upgrade

    If you are still unable to successfully perform the CDMA Receiver upgrade, you should contact Customer Support at EndRun Technologies. S o n o m a U s e r M a n u a l...
  • Page 138 A P P E N D I X B This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 139: 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 140: 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 141: 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 142: 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 143: 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 144 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 145 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 146 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 147 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 148: 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 149 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 150: 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 151: Antenna Location

    "Smarter Timing Solutions" Appendix Installing the CDMA Antenna Installing the CDMA Antenna is usually very easy, simply mount on top of your equipment rack inside your building. This appendix contains antenna mounting guidelines in case you encounter problems receiving a signal. Antenna Location Place the antenna on a flat, preferably metallic surface while the unit is searching for the signal.
  • Page 152: Changing The Channelset

    Please contact EndRun Customer Support for assistance. Using a CDMA Preamplifier EndRun produces a CDMA Preamplifier which is a very high-performance, low-noise, low-power drain, inline amplifier for difficult signal environments. Using the preamplifer you can use a longer cable and locate your antenna up to 100 feet (30 meters) away from the Sonoma.
  • Page 153 I N S T A L L I N G T H E C D M A A N T E N N A ��������������������������������� ������������������������� ���������������������� ������������������������������������������������������������� ��������������������������������������������������������������������� ������������������������������������������������������������� ����������������������������������������������������������������������� ��������������������������������������������������������������������� ������������������������������������������������������������������������� ���������������������������������������������������������������������� ������������������������������������������������������������������������� ���������������������������������������������������������������������� ��������������������������������������������������������������� ����������������������������������������������������������������������� ������������������������������������������������������������������� ������������������������� ������������������������...
  • Page 154 A P P E N D I X E ������������� �������������� �������������������������� ����������������� �������������������������������� ����������� ���������� ����������� ����������� ������������������ ���������������� ����� �������������� ������ � ���������� FIG UR E 1B - CD M A A N TEN NA M O UN TIN G G U IDE LI NE S WITH P RE AM PL IFI ER S o n o m a U s e r M a n u a l...
  • Page 155: Notification Of Leap Second Insertion

    Sonoma. The appropriate link is: http://www.endruntechnologies.com/leap.htm If you wish to be notified by EndRun Customer Support when a leap second is pending, then send an email request to support@endruntechnologies.com. Ask to be put on the leap second notification list.
  • Page 156: Background Information

    A P P E N D I X F Background Information Another way to get the leap second information is to go to the International Earth Rotation Service (IERS) website. If a leap second is pending it will be posted by the IERS approximately six months in advance of insertion.
  • Page 157: Overview

    If the condition persists indefinitely, and a prob- lem 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 158 CDMA Subsystem FLASH Writes (FLSH) This fault indicates that the CDMA 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. CDMA Receiver Communication (RCVC) This fault indicates that the CDMA Subsystem is unable to establish communications with the CDMA Receiver.
  • Page 159: Receiver Fault Definitions

    CDMA Receiver FLASH Writes (FLSH) This fault indicates that the CDMA Receiver 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. Local Oscillator Synthesizer Tuning (SYN1) This fault indicates that the local oscillator synthesizer has reached the alarm limit.
  • Page 160 A P P E N D I X G This page intentionally left blank. S o n o m a U s e r M a n u a l...
  • Page 161: Specifications

    "Smarter Timing Solutions" Appendix H Specifications CDMA Receiver: Cellular Mobile Receive Band - 869-894 MHz (Standard) North American PCS Mobile Receive Band – 1930-1990 MHz (Standard) Japanese Cellular Mobile Receive Band – 860-875 MHz (Optional Configuration) TIA/EIA IS-95 CDMA Pilot and Sync channels. Antenna: TNC jack on rear panel, Z = 50Ω.
  • Page 162 A P P E N D I X H Supported IPv4 Protocols: SNTP, NTP v2, v3, v4 and broadcast/multicast mode; MD5 authentication and autokey SSH client and server with “secure copy” utility, SCP SNMP v1, v2c, v3 with Enterprise MIB TIME and DAYTIME server TELNET client/server FTP client...
  • Page 163 S P E C I F I C A T I O N S Sonoma DB9M Pin Signal Name Not Connected Receive Data (RX) Transmit Data (TX) Not Connected Ground Not Connected Not Connected Not Connected Not Connected Size: Chassis: 1.75”H x 17.0”W x 10.75”D, 19”...
  • Page 164 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 165 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 166 A P P E N D I X H ����� ����� ����� ����� ����� ��� ���� � ���� ���� ���� ��������� ����� ����� �� ������ � � �� � �� ����� ��� ��� � ���� � ���� ��� ���� �� ������ ���...
  • Page 167 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 168 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 169 "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 170 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 172 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