User Reference Guide, NetClock 9400 Series Time

User Reference Guide, NetClock 9400 Series Time
NetClock® 9400 Series
Time Server
User Reference Guide
Document Part No.: 1209-5000-0050
Revision: 13
Date: 2-December-2016
spectracom.com
© 2009-2016 Spectracom Corp. All rights reserved.
The information in this document has been carefully reviewed and is
believed to be accurate and up-to-date. Spectracom assumes no respons
ibility for any errors or omissions that may be contained in this document,
and makes no commitment to keep current the information in this manual, or
to notify any person or organization of updates. This User Reference Guide
is subject to change without notice. For the most current version of this doc
umentation, please see our web site at spectracom.com.
Spectracom reserves the right to make changes to the product described in
this document at any time and without notice. Any software that may be
provided with the product described in this document is furnished under a
license agreement or nondisclosure agreement. The software may be used
or copied only in accordance with the terms of those agreements.
No part of this publication may be reproduced, stored in a retrieval sys
tem, or transmitted in any form or any means electronic or mechanical,
including photocopying and recording for any purpose other than the pur
chaser's personal use without the written permission of Spectracom Corp.
Other products and companies referred to herein are trademarks or
registered trademarks of their respective companies or mark holders.
Spectracom Corp., a Business of the Orolia Group
• 1565 Jefferson Road, Suite 460, Rochester, NY 14623 USA
• 3, Avenue du Canada, 91974 Les Ulis Cedex, France
• Room 208, No. 3 Zhong Guan Village South Road, Hai Dian District, Beijing 100081, China
Questions or comments regarding this User Reference Guide?
è E-mail: techpubs@spectracom.com
Warranty Information
For a copy of Spectracom's Limited Warranty policy, see the Spectracom
website: http://spectracom.com/support/warranty-information.
NetClock User Reference Guide
I
Blank page.
II
NetClock User Reference Guide
CONTENTS
CHAPTER 1
Product Description
1
1.1 Getting Started
2
1.2 Introduction
2
1.3 NetClock 9483 Overview
2
1.3.1 NENA Standards Compliance & Support
3
1.3.2 Security Enhancements
4
1.4 NetClock 9489 Overview
4
1.5 Inputs & Outputs
4
1.5.1 NetClock 9483: Standard Outputs
4
1.5.2 NetClock 9483: Optional Outputs
5
1.5.3 NetClock 9489 Standard Inputs and Outputs
5
1.6 NetClock 9400 Series Front Panels
5
1.6.1 NetClock 9483 Front Panel
5
1.6.2 NetClock 9489 Front Panel
6
1.6.3 Keypad and Information Display
6
1.6.3.1 Keypad Operation
7
1.6.3.2 Navigating the Information Display
7
1.6.4 Status LEDs
1.7 NetClock 9400 Series Rear Panels
8
10
1.7.1 NetClock 9483 Rear Panel
10
1.7.2 NetClock 9489 Rear Panel
12
1.8 NetClock 9483—Available Option Modules
12
1.8.1 T1 (1.544 MHz) and E1 (2.048 MHz) Module
13
1.8.2 Multi-Port Gigabit Ethernet Module
13
1.9 The NetClock Web UI
14
1.9.1 The Web UI HOME Screen
14
1.9.2 The INTERFACES Menu
15
1.9.3 The Configuration MANAGEMENT Menu
16
1.9.4 The TOOLS Menu
17
1.10 Specifications
NetClock User Reference Guide • TABLE OF CONTENTS
18
III
1.10.1 Input Power
18
1.10.1.1 Fuses
18
1.10.2 GNSS Receiver
19
1.10.3 RS-232 Serial Port (Front Panel)
20
1.10.4 RS-232 Serial Port (Rear Panel; NetClock 9483 Only)
20
1.10.5 RS-485 Serial Port
20
1.10.6 10/100 Ethernet Port
20
1.10.7 IRIG Output (NetClock 9483 Only)
20
1.10.8 Protocols Supported
20
1.10.9 1PPS Output
21
1.10.10 10 MHz Output (NetClock 9483 Only)
21
1.10.10.1 10 MHz output — Oscillator Phase Noise (dBc/Hz)
1.10.11 Mechanical and Environmental Specifications
23
23
24
1.11 Regulatory Compliance
CHAPTER 2
27
SETUP
28
2.1 Overview
2.1.1 Main Installation Steps
28
2.2 Unpacking and Inventory
29
2.3 Required Tools and Parts for Installation
30
2.4 Required GNSS Antenna Components
30
2.5 SAFETY
31
2.5.1 Safety: Symbols Used
31
2.5.2 SAFETY: Before You Begin Installation
31
2.5.3 SAFETY: User Responsibilities
33
2.5.4 SAFETY: Other Tips
34
2.6 Mounting the Unit
34
2.6.1 Rack Mounting
34
2.6.2 Desktop Operation
35
2.7 Connecting Supply Power
35
2.7.1 Power Source Selection
36
2.7.2 Using AC Input Power
36
2.7.3 Using DC Input Power (NetClock 9483 Only)
36
2.8 Connecting the GNSS Input
IV
39
NetClock User Reference Guide • TABLE OF CONTENTS
2.9 Connecting Network Cables
39
2.10 Connecting Inputs and Outputs
40
2.11 Powering Up the Unit
40
2.12 Setting up an IP Address
41
2.12.1 Dynamic vs. Static IP Address
42
2.12.2 Assigning a Static IP Address
43
2.12.2.1 Assigning a New Static IP Address
43
2.12.2.2 Setting Up an IP Address via the Front Panel
46
2.12.2.3 Setting Up a Static IP Address via a DHCP Network
48
2.12.2.4 Setting Up an IP Address via the Serial Port
48
2.12.2.5 Setting up a Static IP Address via Ethernet Cable
49
2.12.3 Setting Up a Temporary IP Address Remotely
50
2.12.4 Subnet Mask Values
52
2.13 Accessing the Web UI
52
2.14 Connecting Reference Inputs and Network Interface
54
2.15 Configuring Network Settings
55
2.15.1 General Network Settings
57
2.15.2 Network Ports
57
2.15.3 Network Services
59
2.15.4 Static Routes
60
2.15.5 Access Rules
61
2.15.6 HTTPS
62
2.15.6.1 Accessing the HTTPS Setup Window
63
2.15.6.2 About HTTPS
64
2.15.6.3 Supported Certificate Format Types
64
2.15.6.4 Creating an HTTPS Certificate Request
64
2.15.6.5 Requesting an HTTPS Certificate
67
2.15.6.6 Uploading an X.509 PEM Certificate Text
69
2.15.6.7 Uploading an HTTPS Certificate File
69
2.15.7 SSH
70
2.15.8 SNMP
79
2.15.8.1 SNMP V1/V2c
83
2.15.8.2 SNMP V3
84
2.15.8.3 SNMP Traps
86
2.15.9 System Time Message
2.15.9.1 System Time Message Format
NetClock User Reference Guide • TABLE OF CONTENTS
88
89
V
90
2.16 Configuring NTP
2.16.1 Checklist NTP Configuration
91
2.16.2 The NTP Setup Screen
91
2.16.3 Dis-/Enabling NTP
94
2.16.4 Viewing NTP Clients
95
2.16.5 Restoring the Default NTP Configuration
95
2.16.6 NTP Output Timescale
96
2.16.7 NTP Reference Configuration
98
2.16.7.1 The NTP Stratum Model
98
2.16.7.2 Configuring "NTP Stratum 1" Operation
98
2.16.7.3 Configuring "NTP Stratum Synchronization"
99
100
2.16.8 NTP Servers and Peers
2.16.8.1 The NTP Servers and NTP Peers Panels
102
2.16.8.2 NTP Servers: Adding, Configuring, Removing
103
2.16.8.3 NTP Peers: Adding, Configuring, Removing
105
107
2.16.9 NTP Authentication
2.16.9.1 NTP Autokey
107
2.16.9.2 NTP: Symmetric Keys (MD5)
113
2.16.10 NTP Access Restrictions
115
2.16.11 Enabling/Disabling NTP Broadcasting
117
2.16.12 NTP over Anycast
118
2.16.12.1 Configuring NTP over Anycast (General Settings)
119
2.16.12.2 Configuring NTP over Anycast (OSPF IPv4)
120
2.16.12.3 Configuring NTP over Anycast (OSPF IPv6)
121
2.16.12.4 Configuring NTP over Anycast (BGP)
122
2.16.12.5 Configuring Anycast via NTP Expert Mode
123
2.16.12.6 Testing NTP over Anycast
126
2.16.13 NTP Orphan Mode
126
2.16.14 Host Disciplining
127
2.16.14.1 Enabling Host Disciplining
VI
127
2.16.15 NTP Expert Mode
128
2.16.16 Spectracom Technical Support for NTP
131
2.17 Configuring Input References
132
2.18 Configuring Outputs
132
2.18.1 The Outputs Screen
133
2.18.2 The 1PPS and 10 MHz Outputs
134
2.18.2.1 Configuring a 1PPS Output
135
NetClock User Reference Guide • TABLE OF CONTENTS
2.18.2.2 Configuring the 10 MHz Output (NetClock 9483 Only)
136
2.18.3 Configuring Optional Outputs
136
2.18.4 Network Ports
136
2.18.5 Signature Control
136
2.18.5.1 Configuring Signature Control for an Output
137
CHAPTER 3
MANAGING TIME
139
3.1 The Time Management Screen
140
3.2 System Time
141
3.2.1 System Time
142
3.2.1.1 Configuring the System Time
142
3.2.1.2 Timescales
143
3.2.1.3 Manually Setting the Time
144
3.2.1.4 Using Battery Backed Time on Startup
146
3.2.2 Timescale Offset(s)
3.2.2.1 Configuring a Timescale Offset
3.2.3 Leap Seconds
148
148
149
3.2.3.1 Reasons for a Leap Second Correction
149
3.2.3.2 Leap Second Alert Notification
150
3.2.3.3 Leap Second Correction Sequence
150
3.2.3.4 Configuring a Leap Second
151
3.2.4 Local Clock(s), DST
152
3.2.4.1 Setting Up a Local Clock
152
3.2.4.2 DST Examples
154
3.2.4.3 DST and UTC, GMT
155
3.3 Managing References
155
3.3.1 Input Reference Priorities
155
3.3.1.1 Configuring Input Reference Priorities
157
3.3.1.2 The "Local System" Reference
160
3.3.1.3 The "User/User" Reference
161
3.3.1.4 Reference Priorities: EXAMPLES
163
3.3.2 The GNSS Reference
166
3.3.2.1 Reviewing the GNSS Reference Status
167
3.3.2.2 Determining Your GNSS Receiver Model
170
3.3.2.3 Selecting a GNSS Receiver Mode
172
3.3.2.4 Setting GNSS Receiver Dynamics
174
NetClock User Reference Guide • TABLE OF CONTENTS
VII
3.3.2.5 Performing a GNSS Receiver Survey
176
3.3.2.6 Configuring a GNSS Receiver Offset
178
3.3.2.7 Resetting the GNSS Receiver
179
3.3.2.8 Deleting the GNSS Receiver Position
180
3.3.2.9 Manually Setting the GNSS Position
181
3.3.2.10 GNSS Constellations
184
3.3.2.11 A-GPS
188
3.4 Holdover Mode
190
3.5 Managing the Oscillator
194
3.5.1 Oscillator Types
195
3.5.2 Configuring the Oscillator
195
3.5.2.1 About the "Time Figure of Merit (TFOM)"
195
3.5.2.2 About the "Phase Error Limit"
197
3.5.2.3 Configuring the Oscillator
197
3.5.3 Monitoring the Oscillator
198
3.5.4 Oscillator Logs
200
CHAPTER 4
SYSTEM ADMINISTRATION
4.1 Powering Up/Shutting Down
204
4.1.1 Powering Up the Unit
204
4.1.2 Shutting Down the Unit
205
4.1.3 Issuing the HALT Command Before Removing Power
205
4.1.4 Rebooting the System
206
207
4.2 Notifications
4.2.1 Configuring Notifications
208
4.2.2 Notification Event Types
210
4.2.2.1 Timing Tab: Events
210
4.2.2.2 GPS Tab: Events
210
4.2.2.3 System Tab: Events
211
4.2.3 Configuring GPS Notification Alarm Thresholds
211
4.2.4 Setting Up SNMP Notifications
212
4.2.5 Setting Up Email Notifications
213
4.3 Managing Users and Security
215
4.3.1 Managing User Accounts
VIII
203
215
4.3.1.1 Types of Accounts
215
4.3.1.2 Rules for Usernames
215
NetClock User Reference Guide • TABLE OF CONTENTS
4.3.1.3 Adding/Deleting/Changing User Accounts
4.3.2 "user" Account Permissions
216
218
4.3.2.1 Account Differences, General
218
4.3.2.2 Account Differences, by Menu
219
4.3.3 Configuring Password Policies
220
4.3.3.1 The Administrator Login Password
220
4.3.3.2 Resetting the Administrator Password When Forgotten/Lost
221
4.3.4 LDAP Authentication
224
4.3.5 RADIUS Authentication
230
4.3.6 TACACS+ Authentication
235
4.3.6.1 Adding/Deleting a TACACS+ Server
235
4.3.6.2 Enabling/Disabling TACACS+
236
4.3.7 HTTPS Security Levels
237
4.3.8 Unlocking the Keypad via Keypad
239
4.3.9 If a Secure Unit Becomes Inaccessible
239
4.4 Miscellanous Typical Configuration Tasks
239
4.4.1 Web UI Timeout
239
4.4.2 Configuring the Front Panel
240
4.4.3 Displaying Local Time
244
4.4.4 Creating a Login Banner
244
4.4.5 Show Clock
245
4.4.6 Configuring an External Display Clock
246
4.4.7 Product Registration
248
4.4.8 Synchronizing Network PCs
249
4.4.9 Selecting the UI Language
249
4.5 Quality Management
249
4.5.1 System Monitoring
249
4.5.1.1 Status Monitoring via Front Panel
249
4.5.1.2 Status Monitoring via the Web UI
250
4.5.1.3 Status Monitoring of Input References
253
4.5.1.4 Reference Monitoring
255
4.5.1.5 Ethernet Monitoring
256
4.5.1.6 Outputs Status Monitoring
257
4.5.1.7 Monitoring the Oscillator
260
4.5.1.8 Monitoring the Status of Option Modules
263
4.5.1.9 NTP Status Monitoring
265
4.5.1.10 Temperature Management
272
NetClock User Reference Guide • TABLE OF CONTENTS
IX
278
4.5.2 Logs
4.5.2.1 Types of Logs
279
4.5.2.2 Local and Remote Logs
283
4.5.2.3 The Logs Screen
283
4.5.2.4 Displaying Individual Logs
285
4.5.2.5 Saving and Downloading Logs
286
4.5.2.6 Configuring Logs
288
4.5.2.7 Setting up a Remote Log Server
290
4.5.2.8 Restoring Log Configurations
292
4.5.2.9 Clearing All Logs
292
4.5.2.10 Clearing Selected Logs
293
293
4.6 Updates and Licenses
4.6.1 Software Updates
293
4.6.2 Applying a License File
295
4.7 Resetting the Unit to Factory Configuration
296
4.7.1 Resetting All Configurations to their Factory Defaults
297
4.7.2 Backing-up and Restoring Configuration Files
297
4.7.2.1 Accessing the System Configuration Screen
298
4.7.2.2 Saving the System Configuration Files
299
4.7.2.3 Uploading Configuration Files
300
4.7.2.4 Restoring the System Configuration
301
4.7.2.5 Restoring the Factory Defaults
302
4.7.3 Cleaning the Configuration Files and Halting the System
302
4.7.4 Default and Recommended Configurations
302
4.7.5 Sanitizing the Unit
303
4.7.5.1 Physically Removing the CF Card
304
4.7.5.2 Cleaning/Restoring
304
4.7.5.3 Removing other files from the CF Card
305
4.7.5.4 Further Reading
305
APPENDIX
307
Appendix
308
5.1 Troubleshooting
5.1.1 Troubleshooting Using the Status LEDs
308
5.1.2 Minor and Major Alarms
309
5.1.3 Troubleshooting: System Configuration
310
5.1.3.1 System Troubleshooting: Browser Support
X
311
NetClock User Reference Guide • TABLE OF CONTENTS
5.1.4 Troubleshooting – Unable to Open Web UI
311
5.1.5 Troubleshooting via Web UI Status Page
312
5.1.6 Troubleshooting GNSS Reception
314
5.1.7 Troubleshooting – Keypad Is Locked
315
5.1.8 Troubleshooting – 1PPS, 10 MHz Outputs
315
5.1.9 Troubleshooting – Blank Information Display
316
5.1.10 Troubleshooting the Front Panel Serial Port
317
5.1.11 Troubleshooting the Front Panel Cooling Fan
317
5.1.12 Troubleshooting – Network PCs Cannot Sync
318
5.1.13 Troubleshooting Software Update
318
5.2 Option Modules
5.2.1 Accessing Option Module Settings via the Web UI
319
319
5.2.1.1 Web UI Navigation: Option Modules
320
5.2.1.2 Viewing Input/Output Configuration Settings
321
5.2.1.3 Configuring Option Module Inputs/Outputs
322
5.2.1.4 Viewing an Input/Output Signal State
324
5.2.1.5 Verifying the Validity of an Input Signal
325
5.2.2 NetClock 9483 Option Modules
326
5.2.3 NENA-Compliant Module
327
5.2.3.1 NENA-Compliant Module: Specifications
328
5.2.3.2 IRIG Output Specifications
328
5.2.3.3 ASCII RS-232 Specifications
329
5.2.3.4 ASCII RS-485 and Alarms/Relays Specifications
330
5.2.3.5 Configuring the IRIG Time Code Output
332
5.2.3.6 Configuring an ASCII Time Code Output (RS-232 or RS-485)
334
5.2.3.7 Configuring the Relay/Alarm Output
337
5.2.4 Gigabit Ethernet Module [Option 16]
338
5.2.4.1 Gigabit Ethernet Module: Specifications
338
5.2.4.2 Network Setup
339
5.2.4.3 Routing Tables
339
5.2.5 T1/E1 Out Module [Option 13]
340
5.2.5.1 Module Option 13 E1/T1 (120 Ω): Specifications
341
5.2.5.2 E1/T1 Output: Edit Window
342
5.2.5.3 E1/T1 Output: Status Window
344
5.2.6 NetClock 9489 Outputs
345
5.2.6.1 1PPS Output
345
5.2.6.2 ASCII RS-485 Outputs
345
NetClock User Reference Guide • TABLE OF CONTENTS
XI
5.2.7 PTP Grandmaster [1204-32]
5.2.7.1 PTP Grandmaster [-32]: Specifications
346
5.2.7.2 PTP Grandmaster [-32]: Edit Window
346
5.2.7.3 PTP Grandmaster [-32]: Status Window
352
5.2.7.4 Configuration — General Steps
356
5.2.7.5 Configuration — PTP-Specific Steps
357
361
5.3 Command-Line Interface
5.3.1 Setting up a Terminal Emulator
363
5.3.2 CLI Commands
364
5.4 ASCII Time Code Data Formats
369
5.4.1 NMEA GGA Message
369
5.4.2 NMEA RMC Message
370
5.4.3 NMEA ZDA Message
370
5.4.4 Spectracom Format 0
371
5.4.5 Spectracom Format 1
372
5.4.6 Spectracom Format 1S
374
5.4.7 Spectracom Format 2
375
5.4.8 Spectracom Format 3
377
5.4.9 Spectracom Format 4
379
5.4.10 Spectracom Format 7
380
5.4.11 Spectracom Format 8
382
5.4.12 Spectracom Format 9
383
384
5.4.12.1 Format 9S
5.4.13 Spectracom Epsilon Formats
385
5.4.13.1 Spectracom Epsilon TOD 1
385
5.4.13.2 Spectracom Epsilon TOD 3
386
387
5.4.14 BBC Message Formats
5.4.14.1 Format BBC-01
387
5.4.14.2 Format BBC-02
388
5.4.14.3 Format BBC-03 PSTN
389
5.4.14.4 Format BBC-04
391
5.4.14.5 Format BBC-05 (NMEA RMC Message)
392
5.4.15 GSSIP Message Format
392
5.4.16 EndRun Formats
393
5.4.16.1 EndRun Time Format
393
5.4.16.2 EndRunX (Extended) Time Format
394
5.5 IRIG Standards and Specifications
XII
345
395
NetClock User Reference Guide • TABLE OF CONTENTS
5.5.1 About the IRIG Output Resolution
395
5.5.2 IRIG Carrier Frequencies
396
5.5.3 IRIG B Output
400
5.5.3.1 FAA IRIG B Code Description
403
5.5.4 IRIG E Output
407
5.5.5 IRIG Output Accuracy Specifications
411
5.6 Technical Support
411
5.6.1 Regional Contact
412
5.7 Return Shipments
412
5.8 License Notices
413
5.8.1 NTPv4.2.6p5
413
5.8.2 OpenSSH
418
5.8.3 OpenSSL
421
5.9 List of Tables
425
5.10 List of Images
426
5.11 Document Revision History
427
INDEX
NetClock User Reference Guide • TABLE OF CONTENTS
XIII
BLANK PAGE.
XIV
NetClock User Reference Guide • TABLE OF CONTENTS
CHAPTER 1
Product Description
The Chapter presents an overview of the NetClock 9400 Series Time
Server, its capabilities, main technical features and specifications.
The following topics are included in this Chapter:
1.1 Getting Started
2
1.2 Introduction
2
1.3 NetClock 9483 Overview
2
1.4 NetClock 9489 Overview
4
1.5 Inputs & Outputs
4
1.6 NetClock 9400 Series Front Panels
5
1.7 NetClock 9400 Series Rear Panels
10
1.8 NetClock 9483—Available Option Modules
12
1.9 The NetClock Web UI
14
1.10 Specifications
18
1.11 Regulatory Compliance
24
CHAPTER 1 • NetClock User Reference Guide
1
1.1 Getting Started
1.1
Getting Started
Welcome to the NetClock User Reference Guide.
Where to start:
First-time users : "Introduction" below.
Users with some knowledge of Time and Frequency Servers: "Overview" on page 28.
If your unit is up and running and you want to change a setting: "MANAGING TIME"
on page 139, or "SYSTEM ADMINISTRATION" on page 203.
1.2
Introduction
The NetClock® 9400 Series combines Spectracom’s precision Time Server/Master Clock tech
nology and secure network- centric approach with a compact modular hardware design to
bring you a powerful time & frequency reference and synchronization system at the lowest cost
of ownership.
The NetClock 9400 product series is ideally suited for a variety of communications applic
ations such as Emergency Communications Centers that require extremely accurate timing and
frequency synchronization for their mission-critical systems, networks, and devices. The NetC
lock 9400 product series consists of two variants: The model 9483 is fully compliant with the
National Emergency Number Association (NENA) master clock standard, and the model 9489.
1.3
NetClock 9483 Overview
The NetClock 9483 has been designed specifically for these environments, and when using
GPS as its timing reference, the UTC (Coordinated Universal Time) time standard is employed,
thus allowing the NetClock 9483 to provide legally traceable time and frequency syn
chronization services for various related environments and equipment, such as the following:
2
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.3 NetClock 9483 Overview
9-1-1 and PSAP communication center telephony
Computer network synchronization
VOIP/voice and video recording
CAD
ANI/ALI controllers
Radio consoles and communications equipment
Display clocks
Security & building access systems, fire alarm systems
The NetClock 9483 also includes backwards-compatibility support with all previous generation
NetClock products; thus providing a bridge from legacy devices and equipment to networkbased systems.
The NetClock 9483 series is a truly flexible Time Server/Master Clock, which in addition to
providing highly accurate network time synchronization, also supports a variety of timecodes
(including all NENA formats) and signals to synchronize specific devices. The built-in network
port can be supplemented to include 3 additional Gigabit Ethernet (10/100/1000Base-T) ports
for synchronizing isolated networks, or for restricting administration to a specific management
network. Precise 10- MHz and 1- Pulse- per- second (1PPS) signals are standard features, and
additional optional features include support for T1/E1 signals are available for synchronizing
telecom systems and equipment, and Precision Timing Protocol (PTP) I/O support.
The unit is housed in a 19” rack unit chassis and offers an integrated power supply. DC power
is available as back-up to AC power, or as the primary input power source.
Note: All features described are not available on all NetClock 9400 Series vari
ants.
Initial setup of the NetClock 9483 can be done via its front panel serial port interface, and fur
ther management and configuration can be performed via NetClock’s Web-based user inter
face.
1.3.1
NENA Standards Compliance & Support
The NetClock Model 9483 is designed to meet or exceed the following NENA standards and
criteria:
NENA PSAP Master Clock Standard #04-002
NENA Security for Next-Generation 9-1-1 Standard (NG-SEC) #75-001
Note: Information regarding the configuration of the NetClock’s NENA module
can be found under "NENA-Compliant Module" on page 327.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
3
1.4 NetClock 9489 Overview
1.3.2
Security Enhancements
In addition to fully supporting the NENA Security Standard #75-001, the NetClock 9400 series
are security-hardened network appliances designed to meet rigorous network security stand
ards and best practices. They ensure accurate timing through multiple references, tamper-proof
management, and include extensive logging capabilities for auditing purposes. All features,
interfaces, ports, and protocols can be enabled or disabled based on your network policies.
1.4
NetClock 9489 Overview
Spectracom’s NetClock Model 9489 delivers the same high precision timing benefits of the
NetClock 9483, and is ideally suited for delivering highly precise NTP timing for syn
chronizing systems, devices, and other communications equipment and devices.
In addition to providing a secure, high precision NTP platform, NetClock 9489 also provides
one (1) 1PPS output, and two (2) RS-485 outputs.
There are a number of commonly shared features between both the NetClock 9483 and 9489
models. However, the NetClock Model 9489 is designed to function primarily as an NTP
server, and therefore is somewhat less complex than the NetClock Model 9483. Also, NetClock
9489 is not fully compliant to NENA master clock technical requirements. As such, a majority of
this document applies to the NetClock Model 9483, except where otherwise noted.
1.5
Inputs & Outputs
Spectracom NetClock provides multiple outputs for use in networked systems and devices. GPSequipped NetClocks can track up to thirty-two GPS satellites simultaneously and synchronize to
the satellite’s atomic clocks. This enables NetClock-equipped computer networks to synchronize
all elements of network hardware and software over LANs or WANs – anywhere on the planet.
1.5.1
NetClock 9483: Standard Outputs
Standard outputs are:
4
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.6 NetClock 9400 Series Front Panels
Type
Connector
(1) Ethernet 10/100Base-T
RJ-45 (auto-sensing)
(1) RS-232 Serial Connector
DB9 female
(1) RS-485 Once-per-Second
3.81 mm Terminal Block
(1) IRIG B/E, IEEE 1344/C37.118-2005 (AM/TTL) output BNC
1.5.2
(1) 1 Pulse Per Second (1PPS) output
BNC
(1) 10 MHz Frequency output
BNC
(2) Relay / Alarm Outputs
3.81 mm Terminal Block
NetClock 9483: Optional Outputs
Several Option Modules are available for NetClock 9483, providing additional outputs and
functionality:
Type
Connector
(3) 10/100/1000Base-T [Multi-Ethernet] RJ-45 (auto-sensing)
(1) 1.544 or 2.048 MHz
(2) 1.544 or 2.048 MHz
[T1/E1 Balanced]
3.81 mm Terminal Block
(1) PTP (IEEE 1588)
RJ-45
For more information, see "NetClock 9483 Option Modules" on page 326.
1.5.3
NetClock 9489 Standard Inputs and Outputs
I/O
Type
Connector
I/O
(1) Ethernet 10/100Base-T
Output
(1) 1 Pulse Per Second (1PPS) BNC
Outputs (2) RS-485 Once-per-Second
RJ-45 (auto-sensing)
3.81 mm Terminal Block
For more information, see "NetClock 9489 Outputs" on page 345.
1.6
NetClock 9400 Series Front Panels
1.6.1
NetClock 9483 Front Panel
CHAPTER 1 • NetClock User Reference Guide Rev. 13
5
1.6 NetClock 9400 Series Front Panels
Figure 1-1: NetClock 9483 Series Front Panel Display
The front panel of the NetClock 9483 unit consists of the following:
Three Status LED indicator lights (“Power”, “Sync” and “Fault”); see also "Status LEDs" on
page 8.
Keypad buttons, for performing operations from the front panel.
LCD display, showing status information or currently selected menu items (display
options are configurable via the product web interface, such as position information,
time and date, Day of Year, GPS information, network settings, etc.).
LED time display.
An RS-232 serial port interface for serial cable connections.
1.6.2
NetClock 9489 Front Panel
Figure 1-2: NetClock 9489 Front Panel
The front panel of the NetClock 9489 unit consists of the following:
Three Status LED indicator lights (“Power”, “Sync” and “Fault”). See also "Status LEDs"
on page 8.
An RS-232 serial port interface connection.
1.6.3
Keypad and Information Display
Note: This Section applies to NetClock 9483 only.
To simplify operation and to allow local access to NetClock, a keypad and LCD information
display are provided on the front panel of the unit.
Among other things, the keypad and information display can be used to carry out basic net
work configuration tasks, such as en-/disabling DHCP, or entering an IP address and subnet
mask.
Note: Should the keypad be locked, see "Troubleshooting – Keypad Is Locked"
on page 315.
6
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.6 NetClock 9400 Series Front Panels
1.6.3.1
Keypad Operation
The functions of the six keys are:
tu arrow keys : Navigate to a menu option (will be highlighted)
pq arrow keys : Scroll through parameter values in edit displays
ü ENTER key: Select a menu option, or load a parameter when editing
Ò BACK key: Return to previous display or abort an edit process
1.6.3.2
Navigating the Information Display
After power initialization, press any key to go to the “Home” display. As shown in the illus
tration "Keypad menu tree" on the next page, several status and setup displays are accessible
from the main “Home” menu. To navigate through the menus, use the arrow keys to highlight a
selection and then press the ENTER button.
The main menu options and their primary functions are as follows:
Display: Used to configure the information display
Clock : Displaying and setting of the current date and time
System : Displaying version info, system halt and reboot, reset spadmin password
Netv4: Network interface configuration
Lock : Locks the front panel keypad to prevent inadvertent operation.
Menu Tree
The front panel keypad and 4-line information display allow you to access the following func
tions:
CHAPTER 1 • NetClock User Reference Guide Rev. 13
7
1.6 NetClock 9400 Series Front Panels
Figure 1-3: Keypad menu tree
To modify a parameter, highlight the menu option and press the ENTER button. The “O” data is
the current old setting and the “N” data is the new setting. You can only change the “N” setting
in all menus. Use the UP and DOWN arrow keys to scroll through all possible parameter val
ues.
When editing a sequence of numbers, use the LEFT and RIGHT arrow keys to select other digits.
When the parameter is correct, press ENTER to load the new value. You will be asked to con
firm the setting change. Press ENTER to accept or BACK to cancel the parameter change. All
entered values are stored in memory and restored after a power cycle.
1.6.4
Status LEDs
Three Status LEDs, located on the unit's front panel, indicate NetClock's current operating status:
POWER: Green, always on while power is applied to the unit
SYNC : Tri-color LED indicates the time data accuracy
FAULT: Two-color, three-state LED, indicating if any alarms are present.
At power up, the unit automatically performs a brief LED test run during which all three LEDs
are temporarily lit.
8
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.6 NetClock 9400 Series Front Panels
Table 1-1: Front panel status indications
CHAPTER 1 • NetClock User Reference Guide Rev. 13
9
1.7 NetClock 9400 Series Rear Panels
LED Label
Activity/Color
Description
Off
Both AC, and DC input power are disconnected.
OR: The unit's AC input switch is turned OFF, and DC input is not
present.
On/solid green
AC and/or DC Power are supplied; the unit detects all power
inputs.
Red
The unit is configured for two power inputs, but detects only one
power input. OR: Detects a power configuration error.
Green & blinking
orange 1/sec.
Power Error — general power configuration fault.
Red
Time Sync Alarm:
1) The unit has powered up, but has not yet achieved syn
chronization with its inputs.
2) The unit was synchronized to its selected input references, but
has since lost all available inputs (or the inputs were declared
invalid) and the Holdover period has since expired.
Solid green
The unit has valid time and 1PPS reference inputs present and is syn
chronized to its reference.
Orange
The unit is in Holdover Mode: It was synchronized to its selected
input references, but has since lost all available inputs (or the inputs
are not declared valid).The time and frequency outputs will remain
useable until the Holdover period expires.
Off
No alarm conditions are currently active.
Blinking orange
A GNSS antenna alarm has been asserted and is currently active.
A short or open circuit has been detected in the GNSS antenna
cable. The light will automatically turn off once the alarm condition
clears.
To troubleshoot this condition, see "Troubleshooting via Web
UI Status Page" on page 312.
Solid orange
A Minor Alarm condition (other than an antenna problem alarm)
has been asserted and is currently active.
To troubleshoot this condition, see "Minor and Major Alarms"
on page 309.
Red
A Major Alarm condition has been asserted and is currently active.
To troubleshoot this condition, see "Minor and Major Alarms"
on page 309.
POWER
SYNC
FAULT
1.7
NetClock 9400 Series Rear Panels
1.7.1
NetClock 9483 Rear Panel
The NetClock 9483 rear panel provides several different outputs for interfacing the unit to vari
ous systems. The rear panel has an AC connection for power input (DC Power is optional), Eth
10
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.7 NetClock 9400 Series Rear Panels
ernet and USB connections, 1PPS and 10 MHz outputs, IRIG, ASCII, and Relay/Alarm outputs,
and GPS Antenna connector.
Figure 1-4: NetClock 9483 rear panel
AC power connector : Input for the AC power and provides and AC power ON/OFF
switch. This connector is only installed if NetClock was ordered with AC input power
option.
DC power port connector : Only installed if the NetClock was ordered with DC input
power option. Note: DC input power does not have an ON/OFF switch.
Ethernet connector : Provides an interface to the network for NTP synchronization and to
obtain access to the NetClock product web interface for system management. It has two
small indicator lamps, “Good Link” (green LED), and “Activity” (orange LED). The “Good
Link” link light indicates a connection to the network is present. The “Activity” link light
will illuminate when network traffic is detected.
Table 1-2: Status indicators, rear panel
Ethernet
Ethernet
Yellow
Green
ON
LAN activity detected.
OFF
No LAN activity detected
ON
LAN link established, 10 or 100 Mb/s.
OFF
No link established.
USB connector is reserved for future expansion.
1PPS output: Provides a once-per-second square-wave output via BNC output connector.
The 1PPS output can be configured to have either the rising or falling edge of the signal
to be coincident with the system’s on-time point.
10 MHz output: Provides a 10 MHz sine-wave output via BNC output connector.
IRIG output: Supports IRIG A/B/G/E, IEEE 1344/C37.118-2005 (AM/TTL).
RS-232 output: for serial connections.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
11
1.8 NetClock 9483—Available Option Modules
Relay/Alarm outputs.
GNSS antenna connector: GNSS input for GNSSS antenna and coax cabling (type “N”
connector).
RS-485 output for serial connection.
Note: The pin numbers for the RS-485 outputs are defined starting with
Pin 1 to Pin 10, arranged from left to right, as shown below:
Figure 1-5: Rear panel of NENA-compliant module (NetClock 9483)
1.7.2
NetClock 9489 Rear Panel
The NetClock 9489 rear panel provides:
an AC connection for power input,
an Ethernet port,
(1) 1PPS output,
(2) RS-485 outputs
a GNSS antenna connector.
Figure 1-6: Rear panel of NetClock model 9489
1.8
NetClock 9483—Available Option Modules
NetClock 9483 models can be customized and enhanced via the addition of up to two (2) addi
tional option modules, detailed in this section.
12
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.8 NetClock 9483—Available Option Modules
Note: In some cases, the number of option modules of any one type that can be
installed may be limited (see “Maximum number of cards” for each type of mod
ule).
For additional information on available option modules, including configuration and usage,
see also "NetClock 9483 Option Modules" on page 326.
1.8.1
T1 (1.544 MHz) and E1 (2.048 MHz) Module
Outputs :
T1 mode:
1.544 MHz (square wave) frequency output
(2) 1.544 Mb/sec data rate outputs:
Outputs are DS1 framed all ones.
Supports Super Frame (SF or D4) and Extended Super Frame (ESF).
SSM support.
E1 mode:
2.048 MHz (square wave) frequency output
(2) 2.048 Mb/sec data rate outputs:
Outputs are E1 frame all ones.
Supports CRC4 and CAS Multiframe.
SSM support.
Maximum Number of Cards : 1
Ordering Information:
Option 13: T1/E1 Balanced
(1) E1 (75 Ω) module
(2) T1 and E1 (100/120 Ω) module
1.8.2
Multi-Port Gigabit Ethernet Module
Inputs/Outputs : (3) Gigabit Ethernet (10/100/1000 Base-T)
Signal Type and Connector : RJ-45
Management: Enabled or Disabled (NTP server only)
Maximum Number of Cards : 4
Ordering Information: Option 16: Multi-port Ethernet (3X) Module
CHAPTER 1 • NetClock User Reference Guide Rev. 13
13
1.9 The NetClock Web UI
1.9
The NetClock Web UI
NetClock has an integrated web user interface (referred to as "Web UI" throughout this doc
umentation) that can be accessed from a computer over a network connection, using a standard
web browser. The Web UI is used to configure the unit, and for status monitoring during every
day operation.
Note: An integrated Command-Line Interpreter interface (CLI) allows the use of a
subset of commands that are integrated into the Web UI.
The minimum browser requirements for the Web UI are: Internet Explorer ® 9 or higher,
Firefox®, or Chrome®
Note: Should it ever be necessary, you can restore NetClock's configuration to
the factory settings at any time. See "Resetting the Unit to Factory Configuration"
on page 296.
1.9.1
The Web UI HOME Screen
Note: Screens displayed in this manual are for illustrative purposes. Actual
screens may vary depending upon the configuration of your product.
The HOME screen of the NetClock web user interface ("Web UI") provides comprehensive
status information at a glance, including:
vital system information
current status of the references
key performance/accuracy data
major log events .
The HOME screen can be accessed from anywhere in the Web UI, using the HOME button in
the Primary Navigation Bar :
14
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.9 The NetClock Web UI
The Primary Navigation Bar provides access to all menus:
HOME: Return to the HOME screen (see above)
INTERFACES : Access the configuration pages for …
… references (e.g., GPS, NTP)
… outputs (e.g. 10 MHz, PPS, NTP) and
… installed option cards (e.g., GPS, PPS).
MANAGEMENT : Access the NETWORK setup screens, and OTHER setup screens e.g., to
configure Reference Priorities, System Time, and the Oscillator.
TOOLS : Opens a drop-down menu for access to the system maintenance screens and sys
tem logs.
HELP/MONITORING: Opens a drop-down menu for access to system help and inform
ation on how to contact Spectracom for further help.
1.9.2
The INTERFACES Menu
The INTERFACES menu on the Main screen provides access to NetClock's:
External REFERENCES e.g., the GNSS reference input
Detected OUTPUTS, such as 10 MHz and 1PPS
Installed OPTIONS.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
15
1.9 The NetClock Web UI
Clicking on any of the line items will open a status screen, providing real-time information on
the selected interface e.g., availability, performance data and events history.
To configure settings for the selected interface, click the GEAR icons or buttons provided on
most of the status screens. Icons like the INFO symbol provide access to more detailed status
information and history data.
Note: Many of the interfaces can be accessed through different menu items e.g.,
an optional output will be available under the OPTION CARDS menu and the
OUTPUTS menu.
The headings of each of the INTERFACES drop-down menus ( white on orange ) open overview
status screens for the respective menu items.
1.9.3
The Configuration MANAGEMENT Menu
The MANAGEMENT menu on the Web UI's Main screen provides access to NetClock's con
figuration screens and settings:
16
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.9 The NetClock Web UI
On the left side, under NETWORK, the following standard setup screens can be found:
Network Setup
General Setup
HTTPS Setup
SSH Setup
SNMP Setup
NTP Setup
PeerD Setup.
Under OTHER, you can access non-network related screens:
Authentication: Manage user accounts, Security Policy, LDAP Setup, RADIUS setup,
Login Preference and Remote Servers. Change My Password is also available.
Reference Priority: Define the order of priority for timing inputs.
Notifications : Configure the notifications triggered by NetClock’s events. A notification
can be a combination of a mask alarm and/or SNMP Trap and/or email.
Time Management: Manage the Local Clock, UTC Offset, DST Definition and Leap
Second information.
Front Panel: Configure the appearance of the NetClock front panel display and keypad.
Log Configuration: Manage the system logs.
Disciplining: Manage oscillator disciplining.
Change My Password: Configure the admin password.
1.9.4
The TOOLS Menu
The TOOLS menu on the Web UI's Main screen provides access to:
System and network monitoring screens
Log screens
Miscellaneous system administration screens.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
17
1.10 Specifications
1.10
Specifications
The specifications listed below apply to the base NetClock 9483 model, i.e. not including any
option modules, and are based on “normal” operation, with NetClock synchronized to valid
Time and 1PPS input references (in the case of GNSS input, this is with the GNSS receiver oper
ating in Stationary mode).
Specifications for the available option modules are provided in their corresponding topics; see
"NetClock 9483 Option Modules" on page 326.
1.10.1 Input Power
AC power source:
100 to 240 VAC, 50/60 Hz, ±10 % and
100-120 VAC 400 Hz, ±10% via an IEC 60320 connector (power cord included)
DC input (option):
12-17 VDC -15%, +20%, or
21-60 VDC -15%, +20%, secure locking device
Note: The DC power option is available only for NetClock Model 9489.
Maximum power draw:
TCXO/OCXO oscillator installed: 40 W normal (50 W start-up)
Rubidium (Rb) oscillator installed: 50 W normal (80 W start-up)
1.10.1.1 Fuses
Type: T 2A L 250 V
18
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.10 Specifications
Model:
Spectracom recommends: LITTELFUSE 0213002.MXP
[Spectracom part number: F010R-0002-000 E FUSE,2A,SB,IEC SURGE,GLASS]
Number : 2 (two) per unit
NetClock label on rear panel of unit:
"AC POWER/F 2A T 250V (2)"
LEGEND:
F = Fuse
2A = Current Rating: 2 Ampères
T = Speed: Time Delay (Slow-Blow)
L = Breaking Capacity: Low (Glass)
250V = Voltage Rating
(2) = Fuses used: 2 (two)
Caution: Before testing fuses, remove AC power by disconnecting the AC power
cord.
Note: In the event that the unit does not power up with AC power, these fuses
should be tested.
1.10.2 GNSS Receiver
Compatible signals :
GPS L1 C/A Code transmissions at 1575.42 MHz
GLONASS L1 0F transmissions centered at 1602.0 MHz
QZSS L1-SAIF (1575.42 MHz)
BeiDou B1 (center frequency 1561.098 MHz)
Galileo-ready E1B/C (firmware upgrade required)
Satellites tracked: Up to 72 simultaneously
Update rate: up to 2Hz (concurrent)
Acquisition time: Typically < 27 seconds from cold start
Antenna requirements : Active antenna module, +5V, powered by NetClock, 16 dB gain min
imum
Antenna connector : Type N, female
CHAPTER 1 • NetClock User Reference Guide Rev. 13
19
1.10 Specifications
1.10.3 RS-232 Serial Port (Front Panel)
Function : Accepts commands to locally configure the IP network parameters via CLI for initial
unit configuration.
Connector : DB9 F, pin assignments conform to EIA/TIA-574, data communication equipment
Character structure: ASCII, 9600 baud, 1 start, 8 data, 1 stop, no parity
1.10.4 RS-232 Serial Port (Rear Panel; NetClock 9483 Only)
Outputs : RS-232, ASCII time code data input/output; 1PPS output.
Connector : DB9 F
Accuracy: ±100-1000 μs (format-dependent)
1.10.5 RS-485 Serial Port
Outputs : RS-485, and Alarm/Relay (NetClock 9483 only)
Signal Type and Connector : (1) RS-485 terminal block
Accuracy: ±100-1000 μs (format-dependent)
1.10.6 10/100 Ethernet Port
Function : 10/100 Base- T, auto- sensing LAN connection for NTP/SNTP and remote man
agement and configuration, monitoring, diagnostics and upgrade
Connector : RJ-45, Network IEEE 802.3
1.10.7 IRIG Output (NetClock 9483 Only)
Outputs : (1) IRIG Output
Signal Type and Connector : IRIG A, B, G, E, NASA 36, Amplitude Modulated (0V to
5VP-P into 50 Ω on BNC) or DC Level Shift (unmodulated), user selectable.
Accuracy: ±2 to 200 microseconds (IRIG Format-dependent)
1.10.8 Protocols Supported
NTP : NTP Version 4 (Installed: Version 4.2.8p8). Provides MD5, Stratum 1 through 15 (RFC
5905). Note that NTP Autokey is currently not supported, for more information, see
http://bugs.ntp.org/show_bug.cgi?id=3005.
NTP throughput: ETH0: 7000-7200 NTP requests per second; ETH1-ETH3 (NetClock 9483 only:
equipped with 1204- 06/Option 16 Gigabit Ethernet Option Module) : 8800- 9000 NTP
requests per second. For additional information, please contact Spectracom.
Clients supported: The number of users supported depends on the class of network and the sub
net mask for the network. A gateway greatly increases the number of users.
20
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.10 Specifications
TCP/IP application protocols for browser-based configuration and monitoring: HTTP, HTTPS
FTP/SFTP: For remote upload of system logs and (RFC 959)
Syslog: Provides remote log storage (RFCs 3164 and 5424)
SNMP: Supports v1, v2c, and v3
Telnet/SSH : For limited remote configuration
Security features : Up to 32-character password, Telnet Disable, FTP Disable, Secure SNMP,
SNMP Disable, HTTPS/HTTP Disable, SCP, SSH, SFTP.
Authentication: LDAP v2 and v3, RADIUS, MD5 Passwords, NTP Autokey protocol.
1.10.9 1PPS Output
Signal: One pulse-per-second square wave (ext. reference connected to GNSS receiver)
Signal level: TTL compatible, 4.3 V minimum, base-to-peak into 50 Ω
Pulse width: Configurable pulse width (200 ms by default)
Pulse width range: 20 ns to 900 ms
Rise time: <10 ns
Accuracy: Positive edge within ±50 ns of UTC when locked to a valid 1PPS input reference
Connector : BNC female
Table 1-3: 1PPS Output accuracies
Oscillator Type
Accuracy to UTC
(1 sigma locked to GPS)
Holdover (constant temp. after 2 weeks of GPS lock)
After 4 hours
After 24 hours
Rubidium
±25 ns
0.2 μs
1μs
Standard OCXO
±50 ns
1μs
25 μs
TCXO
±50 ns
12 μs
450 μs
1.10.10 10 MHz Output (NetClock 9483 Only)
Signal: 10 MHz sine wave
Signal Level: +13 dBm ±2dB into 50 Ω
Harmonics : ˗40 dBc minimum
Spurious : ˗70 dBc minimum TCXO
Connector : BNC female
Signature Control: This configurable feature removes the output signal whenever a
major alarm condition or loss of time synchronization condition is present. The output
will be restored once the fault condition is corrected.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
21
1.10 Specifications
Table 1-4: 10 MHz output — oscillator types and accuracies
Oscillator Type
Accuracy
1x10-12 typical 24-hour average locked to GPS
Rubidium
1x10-11 per day (5x10-11 per month) typical aging unlocked
Standard OCXO
2x10-12 typical 24-hour average locked to GPS
1x10-9 per day typical aging unlocked
TCXO
1x10-11 typical 24-hour average locked to GPS
1x10-8 per day typical aging unlocked
Note: Oscillator accuracies are stated as fractional frequency (i.e. the relative fre
quency departure of a frequency source), and as such are dimensionless.
See also "Configuring the Oscillator" on page 195.
22
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.10 Specifications
Table 1-5: 10 MHz output — oscillator stability
Short-Term Stability (Allan vari
ance)
Medium-Term Stability
(without GPS after 2 weeks of GPS
lock)
Oscillator Type
1 sec.
10 sec.
100 sec.
Temperature
Stability
(p˗p)
Rubidium
5x10-11/month (3x10-11/month typ
ical)
2x10-11
2x10-12
2x10-12
1x10-10
Standard
OCXO
5x10-10/day
5x10-10
5x10-11
1x10-11
5x10-9
TCXO
1x10-8/day
2x10-9
1x10-9
3x10-10
1x10-6
1.10.10.1 10 MHz output — Oscillator Phase Noise (dBc/Hz)
Oscillator Type
@ 1Hz
@ 10 Hz
@ 100 Hz
@ 1KHz
@ 10 KHz
Rubidium
˗80
˗98
˗120
˗140
˗140
Standard OCXO
˗95
˗123
˗140
˗145
˗150
TCXO
./.
./.
˗110
˗135
˗140
1.10.11 Mechanical and Environmental Specifications
Dimensions :
Designed for EIA 19” rack mount:
Housing w/o connectors and brackets:
16.75” W x 1.72” H [1U] x 14.33” D actual
(425 mm W x 44 mm H x 364 mm D)
Weight:
6.0 lbs (2.72 kg)
6.5 lbs. (2.95 kg) with Rubidium Oscillator option
Temperature:
Operating:
-20°C to +65°C (+55°C for Rubidium option [NetClock 9483 only])
Storage:
-40°C to +85°C
Humidity:
10% - 95% relative humidity, non-condensing @ 40°C
CHAPTER 1 • NetClock User Reference Guide Rev. 13
23
1.11 Regulatory Compliance
Altitude:
Operating:
100-240 VAC: up to 6560 ft (2000 m)
100-120 VAC: up to 13123 ft (4000 m)
12-17 VDC and 21-60 VDC: up to 13125 ft (4000 m)
Storage range:
up to 45000 ft (13700 m)
Shock :
Operating: 15 g/0.53 oz, 11 ms, half sine wave
Storage: 50 g/1.76 oz, 11 ms, half sine wave
Vibration:
Operating: 10-55 Hz @ 0.07 g²/Hz; 55-500 Hz @ 1.0 g²/Hz
Storage: 10-55 Hz @ 0.15 g²/Hz; 55-500 Hz @ 2.0 g²/Hz
MIL-STD-810F : 501.4, 502.4, 507.4, 500.4, 516.5, 514.5
1.11
Regulatory Compliance
This product has been found to be in conformance with the following regulatory publications.
FCC
This equipment has been tested and found to comply with the limits for a Class A digital
device, pursuant to Part 15 of the FCC Rules .
These limits are designed to provide reasonable protection against harmful interference when
the equipment is operated in a commercial environment. This equipment generates, uses, and
can radiate radio frequency energy and, if not installed and used in accordance with the user
documentation, may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause harmful interference in
which case the user will be required to correct the interference at his/her own expense.
Safety
EN 60950 - 1:2006/A11:2009: Safety of Information Technology Equipment, including Elec
trical Business Equipment
This product has been tested and meets the requirements specified in:
UL 60950-1, 1st Edition
CSA C22.2 No. 60950-1-07, 2nd Edition
UL Listing no. E311040
24
CHAPTER 1 • NetClock User Reference Guide Rev. 13
1.11 Regulatory Compliance
EMC, CE:
EN 55022:2006/A1:2007: Class A: EC Emissions Standard
EN 55024:1998/A2:2003: EC Generic Immunity Standard
EN 61000-3-2:2006: Harmonic Current Emissions
EN 61000-3-3:1995/A2:2005: Voltage Fluctuations and Flicker
The product complies with the requirements of the Low Voltage Directive 2006/95/EC
and the EMC Directive 2004/108/EC .
Note: This is a Class A product. In a domestic environment this product
may cause radio interference in which case the user may be required to
take adequate measures.
EMC, ICES-003 and AS/NZS CISPR 22:
This Class (A) digital apparatus complies with Canadian ICES-003, Issue 4.
This Class (A) digital apparatus complies with AS/NZS CISPR 22 for radiated and con
ducted Emissions.
CHAPTER 1 • NetClock User Reference Guide Rev. 13
25
1.11 Regulatory Compliance
BLANK PAGE.
26
CHAPTER 1 • NetClock User Reference Guide Rev. 13
CHAPTER 2
SETUP
The following topics are included in this Chapter:
2.1 Overview
28
2.2 Unpacking and Inventory
29
2.3 Required Tools and Parts for Installation
30
2.4 Required GNSS Antenna Components
30
2.5 SAFETY
31
2.6 Mounting the Unit
34
2.7 Connecting Supply Power
35
2.8 Connecting the GNSS Input
39
2.9 Connecting Network Cables
39
2.10 Connecting Inputs and Outputs
40
2.11 Powering Up the Unit
40
2.12 Setting up an IP Address
41
2.13 Accessing the Web UI
52
2.14 Connecting Reference Inputs and Network Interface54
2.15 Configuring Network Settings
55
2.16 Configuring NTP
90
2.17 Configuring Input References
132
2.18 Configuring Outputs
132
CHAPTER 2 • NetClock User Reference Guide
27
2.1 Overview
2.1
Overview
This section provides an outline of the steps that need to be performed prior to putting NetC
lock into service. This includes:
Installation: Hardware setup, mechanical installation, physical connections.
Setup: Establish basic access to the unit, so as to allow the use of the web user interface
("Web UI").
Configuration: Access the Web UI, configure the network, input and output references,
protocols (e.g., NTP), other settings.
The following factors determine which steps need to be taken:
a. The power source(s) your NetClock is configured for.
b. Your existing infrastructure and how you plan on integrating NetClock into it (for
example, integrating it into an existing Ethernet network, or setting-up a standalone
installation.)
c. How you would like to setup basic network configuration parameters:
Using the unit's front panel keypad and information display
Using a PC connected to NetClock via serial cable
Using a PC connected to NetClock via network cable.
You can connect your PC to NetClock either…
…directly by means of a dedicated Ethernet cable, or
…indirectly, using your existing Ethernet network (using a network hub).
d. The options configuration of your unit: Is your NetClock equipped with any options? If
so, they need to be configured separately via the NetClock Web UI, once the network
configuration is complete.
2.1.1
Main Installation Steps
The following list is a recommendation. Deviations are possible, depending on the actual
application and system configuration.
1. Unpack the unit, and take inventory: "Unpacking and Inventory" on the facing page.
2. Obtain required tools and parts: "Required Tools and Parts for Installation" on page 30.
3. Mount the unit: .
4. Read the Safety instructions: "SAFETY" on page 31.
5. Connect your power supply/-ies: "Connecting Supply Power" on page 35.
6. Connect Input References such as your GNSS antenna, and network cable(s): "Con
necting the GNSS Input" on page 39, and "Connecting Network Cables" on page 39.
28
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.2 Unpacking and Inventory
7. Power up the unit: "Powering Up the Unit" on page 204.
8. Setup basic network connectivity…
i. …via front panel keypad and information display (NetClock 9483 only): "Setting
Up an IP Address via the Front Panel" on page 46
ii. …or via serial port, using a PC with a CLI: "Setting Up an IP Address via the
Serial Port" on page 48
iii. …or via Ethernet, using a PC with a web browser, and the NetClock Web UI:
"Accessing the Web UI" on page 52.
9. Register your product: "Product Registration" on page 248.
2.2
Unpacking and Inventory
Caution: Electronic equipment is sensitive to Electrostatic Discharge (ESD).
Observe all ESD precautions and safeguards when handling the unit.
Unpack the equipment and inspect it for damage. If any equipment has been damaged in
transit, or you experience any problems during installation and configuration of your Spec
tracom product, please contact Spectracom (see "Technical Support" on page 411.)
Note: Retain all original packaging for use in return shipments if necessary.
The following items are included with your shipment:
NetClock unit
QuickStart Guide (printed version), and CD "Timing Product Manuals"
Ancillary items (except for rack mounting items, the contents of this kit may vary based
on equipment configuration and/or regional requirements)
Purchased optional equipment; note that option modules listed on the purchase order
will be pre-installed in the unit.
2.3
Required Tools and Parts for Installation
Phillips screwdrivers to install the rack-mount ears, and to mount the unit in a 19"-rack
Ethernet cables (see "Connecting Network Cables" on page 39)
If you plan on using DC power Spectracom recommends an external ON/OFF switch.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
29
2.4 Required GNSS Antenna Components
2.4
Required GNSS Antenna Components
Should you plan on using a GNSS reference with your NetClock, you will also need:
Spectracom LMR-400 antenna cable with N connectors
Spectracom outdoor GNSS antenna with mounting bracket
Spectracom GNSS antenna surge suppressor (recommended)
Spectracom GNSS antenna inline amplifier (optional for short cable lengths)
For antenna installation guidelines, see the separate documentation shipped with the antenna
components.
30
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.5 SAFETY
2.5
SAFETY
Caution: Do not ignore the Safety Instructions!
2.5.1
Safety: Symbols Used
Table 2-1: Safety symbols used in this document, or on the product
Symbol
Signal word
Definition
DANGER!
Potentially dangerous situation which may lead to personal
injury or death! Follow the instructions closely.
CAUTION!
Potential equipment damage or destruction!
Follow the instructions closely.
Tips and other useful or important information.
NOTE
ESD
CHASSIS GROUND
Analog Ground
Recycle
2.5.2
Risk of Electrostatic Discharge!
Avoid potential equipment damage by following ESD Best
Practices.
This symbol is used for identifying the functional ground of an
I/O signal. It is always connected to the instrument chassis.
Shows where the protective ground terminal is connected
inside the instrument. Never remove or loosen this screw!
Recycle the mentioned components at their end of life. Follow
local laws.
SAFETY: Before You Begin Installation
This product has been designed and built in accordance with state-of-the-art standards and the
recognized safety rules. Nevertheless, its use may constitute a risk to the operator or install
ation/maintenance personnel, if used under conditions that must be deemed unsafe, or for pur
poses other than the product's designated use, which is described in the introductory technical
chapters of this guide.
Before you begin installing and configuring your NetClock unit, carefully read the following
important safety statements. Always ensure that you adhere to any and all applicable safety
warnings, guidelines, or precautions during the installation, operation, and maintenance of
your product.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
31
2.5 SAFETY
DANGER! — INSTALLATION OF EQUIPMENT:
Installation of this product is to be done by authorized service personnel
only. This product is not to be installed by users/operators without legal author
isation.
Installation of the equipment must comply with local and national electrical codes.
DANGER! — DO NOT OPEN EQUIPMENT, UNLESS AUTHORIZED:
The interior of this equipment does not have any user serviceable parts. Contact
Spectracom Technical Support if this equipment needs to be serviced. Do not
open the equipment, except to retrofit option cards, or replacement of battery. Fol
low Spectracom Safety Instructions, and observe all local electrical regulatory
requirements.
IF THE EQUIPMENT MUST BE OPENED:
Never remove the cover or blank option card plates with power applied to this
equipment. Ensure all power sources are removed from the unit prior to installing
any option cards by removing both the AC and DC power cords connected to the
equipment.
This unit will contain more than one power source if both the AC and DC power
options are present. In this case, turning off the rear panel power switch will not
remove all power sources.
DANGER! — FUSING:
The equipment has Double Pole/Neutral Line Fusing on AC power.
For continued protection against risk of fire, replace fuses only with same type
and rating of fuse.
DANGER! — GROUNDING: This equipment must be EARTH GROUNDED. Never
defeat the ground connector or operate the equipment in the absence of a suit
ably installed earth ground connection. Contact the appropriate electrical inspec
tion authority or an electrician if you are uncertain that suitable grounding is
available.
32
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.5 SAFETY
The AC and DC power connectors of this equipment have a connection to the
earthed conductor of the AC and DC supply earthing conductor through the AC
and DC power cords. The AC source outlet must contain a protective earthing con
nection. This equipment shall be connected directly to the AC power outlet earth
ing
pin
or
DC
supply
system
earthing
electrode
conductor.
The DC supply source is to be located within the same premises as this equipment:
The equipment shall be located in the same immediate area (such as, adjacent
cabinets) as any other equipment that has a connection to the earthing conductor
of the same AC or DC supply circuit earthing conductor, and also the point of
earthing of the AC or DC system. The AC or DC system shall not be earthed else
where.
Switches or other disconnection devices shall not be in the earthed circuit con
ductor between the AC and DC source and the point of the connection of the
earthing electrode conductor to NetClock’s AC and DC input power connectors
earthing pin.
DANGER! — BATTERY: Replace the battery only with the same or equivalent type
recommended by the manufacturer. Follow Spectracom Instructions — there is a
danger of a new battery exploding if it is incorrectly installed. Discard used bat
teries according to the manufacturer's instructions.
Caution: Electronic equipment is sensitive to Electrostatic Discharge (ESD).
Observe all ESD precautions and safeguards when handling Spectracom equip
ment.
2.5.3
SAFETY: User Responsibilities
The equipment must only be used in technically perfect condition. Check components for
damage prior to installation. Also check for loose or scorched cables on other nearby
equipment.
Make sure you possess the professional skills, and have received the training necessary
for the type of work you are about to perform.
Do not modify the equipment.
Use only spare parts authorized by Spectracom.
Always follow the instructions set out in this User Reference Guide, or in other Spec
tracom documentation for this product.
Observe generally applicable legal and other local mandatory regulations.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
33
2.6 Mounting the Unit
2.5.4
SAFETY: Other Tips
Keep these instructions at hand, near the place of use.
Keep your workplace tidy.
Apply technical common sense: If you suspect that it is unsafe to use the product, do the
following:
Disconnect the supply voltage from the unit.
Clearly mark the equipment to prevent its further operation.
2.6
Mounting the Unit
2.6.1
Rack Mounting
If installing the unit in a rack, install the rack-mount ears on the two sides of the front panel and
mount the unit in a standard 19-inch rack cabinet. The unit is intended to be installed in one ori
entation only. The unit should be mounted so the front panel interface keys are to the left of the
display area.
The NetClock unit will install into any EIA standard 19-inch rack. NetClock occupies one rack
unit of space for installation, however, it is recommended to leave empty space of at least one
rack unit above and below the NetClock unit to allow for best ventilation.
Rack mounting requirements:
The maximum ambient operating temperature must be observed. See for the operating
temperature range specified for the type of oscillator installed in your NetClock unit.
If the NetClock unit is to be installed in a closed rack, or a rack with large amounts of
other equipment, a rack cooling fan or fans should be part of the rack mount install
ation.
Installation of the unit in a rack should be such that the amount of air flow required for
safe operation of the equipment is not compromised.
Follow the mounting directions described below to prevent uneven mechanical loading,
possibly resulting in a hazardous condition.
Do not overload power supply circuits . Use only supply circuits with adequate overload
protection. For power requirements, see "Input Power" on page 18.
Reliable grounding of rack-mounted equipment must be maintained. Particular attention
must be given to supply connections other than direct connections to the branch circuit
(e.g., use of power strips).
The NetClockancillary kit contains the following parts needed for rack mounting:
34
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.7 Connecting Supply Power
2 each 1165-1000-0714 rack mounting brackets
2 each MP09-0003-0030 equipment rack handles
4 each H020-0832-0406 #8-32 flat head Phillips screws
6 each HM20R-04R7-0010 M4 flat head Phillips screws
The following customer supplied items are also needed:
4 each #10-32 pan head rack mount screws
1 each #2 Phillips head screwdriver
1 each 3/32" straight screwdriver
To rack mount the NetClock unit:
1. Attach an MP09-0003-0030 equipment rack handle to the front of each 1165-10000714 rack mounting bracket, using the holes nearest the right angle bend of the 11651000-0714 rack mounting bracket, with the #2 size Phillips screwdriver, using 2 each of
the H020-0832-0406 #8-32 flat head Phillips screws.
2. Attach the 1165-1000-0714 rack mount brackets to the sides of the NetClock with the
rack mounts ears facing outward, aligned with the front edge of the NetClock front
panel. Use the #2 Phillips screwdrivers, using 3 each of the HM20R-04R7-0010 M4 flat
head Phillips screws.
3. Secure the rack mount brackets to the rack using the #10-32 rack mount screws and #2
Phillips head screwdriver, 2 each per side of the rack. Caution: For safety reasons, the NetClock unit is intended to be operated in a
HORIZONTAL POSITION, RIGHT-SIDE-UP, that is with the keypad to the left side
and the 4-line information display and the time display on the right side.
2.6.2
Desktop Operation
NetClock units can also be operated on a desktop in a HORIZONTAL, RIGHT-SIDE-UP position.
The location needs to be well-ventilated, clean and accessible.
2.7
Connecting Supply Power
This section includes details on the NetClock’s AC and/or DC power systems ( Note : The
DC power option is available with NetClock 9483 only).
Depending on the equipment configuration at time of purchase, NetClock can be powered
from an AC input, a DC input or with both AC, and DC input (DC input is an option for NetC
lock 9483 units only). Supplying both AC and DC input power provides redundant and auto
matic power switchover in case one or the other input power sources is lost.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
35
2.7 Connecting Supply Power
Before connecting power to the unit, be sure that you have read all safety information detailed
in section "SAFETY" on page 31.
2.7.1
Power Source Selection
Note: Applies to NetClock 9483 only.
If both an AC, and a DC power source are connected to the unit, the following rules apply:
If AC and DC power are both applied, AC power is used.
If DC power is applied, but AC power is not, then DC power will be used.
If AC and DC power are both present, but AC power is subsequently lost, NetClock will
automatically switch to using the DC power input.
DANGER! — This unit will contain more than one power source if both the AC
and DC power options are present. Turning off the rear panel power switch will
NOT remove all power sources.
The following sections discuss AC and DC power input. Connect AC and/or DC power, as
required.
2.7.2
Using AC Input Power
Connect the AC power cord supplied in the NetClock ancillary kit to the AC input on the rear
panel and the AC power source outlet. The AC input is fuse-protected with two fuses located in
the AC power entry module (line and neutral inputs are fused). The AC power entry module
also contains the main power switch for the AC power applied to the equipment.
Caution: This equipment has Double Pole/Neutral Line Fusing on AC power.
Note: Important! NetClock is earth grounded through the AC power connector.
Ensure NetClock is connected to an AC outlet that is connected to earth ground
via the grounding prong (do not use a two prong to three prong adapter to
apply AC power to NetClock).
2.7.3
Using DC Input Power (NetClock 9483 Only)
If the rear panel DC port is present, connect DC power, per the voltage and current as called
out on the label that resides above the DC power connector.
36
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.7 Connecting Supply Power
Note: DC power is an option chosen at time of purchase. The rear panel DC
input port connector is only installed if the DC input option is available. Different
DC power input options are available (12 VDC with a voltage range of 12 to 17 V
at 7 A maximum or 24/48 VDC input with a voltage range of 21 to 60 V at 3 A
maximum). Review the DC power requirement chosen, prior to connecting DC
power (when the DC port is installed, a label will be placed over the connector
indicating the allowable DC input voltage range and the required current).
DANGER! GROUNDING: NetClock is earth grounded through the DC power con
nector. Ensure that the unit is connected to a DC power source that is connected to
earth ground via the grounding pin C of the NetClock DC power plug supplied
in the ancillary kit.
Caution: The DC input port is both fuse and reverse polarity protected. Reversing
polarity with the 24/48 VDC option will not blow the fuse, but the equipment will
not power- up. Reversing polarity with the 12 V DC option will likely blow the
internal fuse.
A DC power connector to attach DC power to NetClock is included in the ancillary kit provided
with the equipment. A cable of 6 feet or less, using 16AWG wire, with adequate insulation for
the DC voltage source should be used with this connector. The cable clamp provided with the
DC power plug for strain relief of the DC power input cable should be used when DC power is
connected to NetClock.
Note: Spectracom recommends to use a dedicated DC power supply switch to
energize/de-energize NetClock externally.
DC power connector pin-out:
NetClock units can be ordered in a DC version that includes the following DC plug on the back
panel: DC Plug, 3-pin, chassis mount: Amphenol P/N DL3102A10SL-3P
CHAPTER 2 • NetClock User Reference Guide Rev. 13
37
2.7 Connecting Supply Power
The DC ancillary kit includes, among other things, the following connector parts:
Mating DC Connector , circular, 3-pin, solder socket, 16AWG,13A,300V: Amphenol
P/N DL3106A10SL-3S; (Spectracom part no. P240R-0032-002F)
Cable Clamp, circular: Amphenol part no. 97-3057-1004(621); (Spectracom part no.
Spectracom part no. MP06R-0004-0001)
Pinout description, DC connector
Pin B goes to the most positive DC voltage of the DC source. For +12 V or +24/48 V this would
be the positive output from the DC source. For a -12 V or -24/48 VDC source this would be the
ground or return of the DC source.
Pin A goes to the most negative voltage of the DC source. For +12 V or +24/48 V this would
be the ground or return output from the DC source. For a -12 V or -24/48 V DC source this
would be the negative output from the DC source.
Pin C goes to the Earth ground of the DC source.
38
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.8 Connecting the GNSS Input
2.8
Connecting the GNSS Input
1. Install the GNSS antenna, surge suppressor, antenna cabling, and GNSS preamplifier
(if required). Refer to the documentation included with the GNSS antenna for additional
information regarding GNSS antenna installation.
2. Connect the GNSS cable to the rear panel antenna input jack.
In the event that NO antenna is connected to the rear panel jack, NetClock will—once it
gets powered up (see "Powering Up the Unit" on page 204)—activate the Antenna Prob
lem alarm, causing the front panel “Fault” light to be blinking orange (the Antenna Prob
lem alarm indicates an open or short exists in the antenna cable.)
Unless there is an open or short in the antenna cable, the "Fault" light should stop flash
ing orange once the GNSS antenna and coax cable are connected to the rear panel. If
the "Fault" light does not stop flashing after connecting the antenna, refer to
"Troubleshooting GNSS Reception" on page 314.
Initial synchronization with GNSS input may take up to 5 minutes (approximately) when used
in the default stationary GNSS operating mode. If using GNSS, verify that GNSS is the syn
chronization source by navigating to MANAGEMENT > OTHER: Reference Priority : Confirm
that GNSS is Enabled, and its Status for TIME and 1PPS is valid (green).
2.9
Connecting Network Cables
NetClock provides a base 10/100 Ethernet port for full NTP functionality, as well as a com
prehensive web-based user interface ("Web UI") for configuration, monitoring and diagnostic
support. Additional network ports are available with the Gigabit Ethernet option module.
First, you need to decide how you want to configure basic network connectivity e.g., the IP
address:
a. Configure NetClock via the unit's front panel (NetClock 9483 only): See "Setting Up an
IP Address via the Front Panel" on page 46.
If your unit does not have a front panel, see "Setting Up a Temporary IP Address
Remotely" on page 50.
b. Configure NetClock by means of a PC connected to an existing network.
When connecting to a hub, router, or network computer, use a straight-through
wired, shielded CAT 5, Cat 5E or CAT 6 cable with RJ-45 connectors. Connect
one end to the Ethernet port on the NetClock rear panel, and the opposite end of
the cable to a network hub or switch.
c. Configure NetClock by connecting a stand-alone computer directly via a dedicated net
work cable (standard-wired, or crossover cable):
When connecting directly to a stand-alone PC, use a network cable. Connect the
cable to the NIC card of the computer.
Since no DHCP server is available in this configuration both NetClock, and the
PC must be configured with static IP addresses that are on the same subnet
CHAPTER 2 • NetClock User Reference Guide Rev. 13
39
2.10 Connecting Inputs and Outputs
(10.1.100.1 and 10.1.100.2 with a subnet value of 255.255.255.0 on both
devices, for example). For more information on configuring static IP addresses,
see "Assigning a Static IP Address" on page 43.
Once the unit is up and running, verify that the green link light on the Ethernet port is illu
minated. The amber “Activity” link light may periodically illuminate when network traffic is
present.
2.10
Connecting Inputs and Outputs
NetClock can synchronize not only to an external GNSS reference signal, but also to other
optional external references such as IRIG, HAVE QUICK and ASCII inputs (in addition to net
work based references such as NTP and/or PTP).
At the same time, NetClock can output timing and frequency signals for the consumption by
other devices via the same formats as listed above.
EX A MPLE:
With the available IRIG Input/Output option card module (Model 1204-05) installed in an option
bay, IRIG time code from an IRIG generator can also be applied as an external reference input (either
in addition to, or in lieu of GNSS, NTP, user set time and other available reference inputs).
To use e.g., an external IRIG reference, connect the IRIG time source to the BNC connector “J1”
on the optional IRIG Input/Output module. For additional information on optional connectivity,
such as pinout tables, signal levels and other specifications, see "Option Modules" on
page 319.
Note that some option cards offer both input and output functionality, while others offer only
one or the other.
2.11
Powering Up the Unit
1. After installing your NetClock unit, verify that power is connected, then turn ON the unit
using the switch on the rear panel, and wait for the device to boot up.
Note: NetClock 9483 only: DC input power is not switched, so NetClock
will be powered up with DC input connected, unless you installed an
external power switch.
2. Observe that all of the front panel LEDs momentarily illuminate (the Power LED will then
stay lit) and that the Information display LCD back light illuminates. The fan may or may
not run, depending on the model year of your NetClock unit. For more information, see
40
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
"Temperature Management" on page 272.
NetClock 9483 only:
The time display will reset and then start incrementing the time. About 10 seconds after
power-up, “Starting up NetClock” will be displayed in the information display. After
approximately 2 minutes, the information display will then show the current network set
tings.
By default, the 4-line information display shows the unit’s hostname, IPv4 address, mask,
and gateway.
The time display shows the current time: UTC (default), TAI, GPS or local timescale, as
configured.
Figure 2-1: NetClock front panel
3. Check the front panel status LED indicators:
The Power lamp should be solid green.
The Sync lamp will probably be red, since synchronization has not yet been
achieved.
The Fault lamp will be OFF, or solid orange, indicating a minor alarm, or solid
red, asserting a power-up frequency error alarm (until the disciplining state is
reached.)
For additional information, see "Status LEDs" on page 8 and "Status Monitoring via Front
Panel" on page 249.
2.12
Setting up an IP Address
In order for NetClock to be accessible via your network, you need to assign an IP address to
NetClock, as well as a subnet mask and gateway, unless you are using an address assigned by
a DHCP server.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
41
2.12 Setting up an IP Address
Note: The setup process for NetClock 9489 (which has no front panel display
and keyboard) is described in "Setting Up a Temporary IP Address Remotely" on
page 50.
There are several ways to setup an IP address , described below:
via the front panel keypad and information display
remotely …
… via serial cable
… via dedicated network cable
… via a DHCP network.
Before you continue …
… please obtain the following information from your network administrator:
Available static IP address
This is the unique address assigned to the NetClock unit by the network admin
istrator. Make sure the chosen address is outside of the DHCP range of your
DHCP server.
Note: The default static IP address of the NetClock unit is
10.10.201.x (x= dependent on ETH port).
Subnet mask (for the network)
The subnet mask defines the number of bits taken from the IP address that are used
in the network portion. The number of network bits used in the net mask can range
from 8 to 30 bits.
Gateway address
The gateway (default router) address is needed if communication to the NetClock
is made outside of the local network. By default, the gateway is disabled.
Note: Make sure you are assigning a static IP address to your NetClock unit that
is outside of the DHCP range defined for the DHCP server. Your system admin
istrator will be able to tell you what this range is.
2.12.1 Dynamic vs. Static IP Address
On a DHCP network (Dynamic Host Configuration Protocol), NetClock's IP address will be
assigned automatically once it is connected to the DHCP server. This negotiated address and
42
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
other network information are displayed on the unit front panel when the unit boots up.
If you plan on allowing your NetClock to use this negotiated DHCP Address on a permanent
basis, you can skip the following topics about setting up an IP address, and instead proceed to
"Accessing the Web UI" on page 52, in order to complete the NetClock configuration process.
Please note:
Unless you are using DNS in conjunction with DHCP (with the client configured using NetC
lock's hostname instead of IP address), Spectracom recommends to disable DHCP for NetC
lock, and instead use a static IP address. Failure to do this can result in a loss of time
synchronization, should the DHCP server assign a new IP address to NetClock.
2.12.2 Assigning a Static IP Address
Spectracom recommends assigning a static IP address to NetClock, even if the unit is connected
to a DHCP server.
This can be accomplished in several ways:
a. Via the keypad and information display on the front panel of the unit, see "Setting Up
an IP Address via the Front Panel" on page 46. (NetClock 9483 only; If you are setting
up a NetClock 9489 unit – which does not have a front panel information display and
keypad – see "Setting Up a Temporary IP Address Remotely" on page 50.)
b. By connecting the NetClock to an existing DHCP network , temporarily using the
assigned DHCP address, see "Setting Up a Static IP Address via a DHCP Network" on
page 48.
c. By connecting a Personal Computer to NetClock via a serial cable, see "Setting Up an
IP Address via the Serial Port" on page 48.
d. By connecting a Personal Computer directly to NetClock via a dedicated Ethernet cable,
see "Setting up a Static IP Address via Ethernet Cable" on page 49.
Note: For information on configuring routing tables, see "Static Routes" on
page 60.
2.12.2.1 Assigning a New Static IP Address
To configure a NetClock unit that has not yet been assigned a custom IP address (e.g., because
your network does not support DHCP), there are two ways to enter the desired static IP
address, subnet mask, and gateway address:
The front panel keypad and its 4-line information display (NetClock 9483 only), or
a personal computer, connected to the NetClock unit via a serial cable, or via a ded
icated Ethernet cable.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
43
2.12 Setting up an IP Address
Note: Units are shipped with the default IP address of 10.10.201.1 with subnet
mask 255.255.255.0.
IMPORTANT NOTES:
On the NetClock 9489 unit DHCP is disabled by default.
As the NetClock 9489 does not include a front panel LCD that can display status information, it
is important to read the following sections carefully in order to successfully determine or con
figure a NetClock 9489‘s network settings. This can be achieved via one of the following meth
ods:
Configuration via serial cable connection
Configuration via crossover cable
Configuring a temporary IP address remotely.
Setting Up an IP Address via Serial Cable
The serial port can be used to make configuration changes (such as the network settings),
retrieve operational data (e.g., GNSS receiver information) and log files, or to perform oper
ations such as resetting the admin password.
For this task, you will need a serial cable, and a Personal Computer (PC) with a command-line
user interface program (CLI) installed on it, such as TeraTerm®, PuTTY®, or similar.
To configure an IP address via the serial port:
1. Connect a pinned straight-thru standard DB9M to DB9F RS232 serial cable to a PC run
ning PuTTY, Tera Term, or HyperTerminal, and to your NetClock.
Use the following protocol parameters:
Bits per second: 9600
Data bits: 8
Parity: None
Stop bits: 1
Flow control: None
For more information on using the serial port connection, see "Setting up a Terminal
Emulator" on page 363.
2. The serial port is account and password protected. Login to NetClock with a user
account that has “admin” group rights, such as the default spadmin account (the
default password is admin123).
44
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
Note: Users with “administrative rights” can perform all available com
mands. Users with “user” permissions only can perform get commands to
retrieve data, but cannot perform any set commands or change/reset
any passwords.
3. Disable DHCP, type: dhcp4set 0 off <Enter>.
Note: If your NetClock is configured with an Ethernet option card, use 0,
1, 2, 3 for eth0 – eth3.
Note: For a list of CLI commands, type helpcli, or see "CLI Commands"
on page 364.
4. Configure the IP address, subnet mask, and gateway (if needed):
ip4set 0 x.x.x.x y.y.y.y <Enter>
(where 0 is the desired interface, “x.x.x.x” is the desired IP address for NetC
lock, and “y.y.y.y” is the full subnet mask for the network (For a list of subnet
mask values, see "Subnet Mask Values" on page 52.)
Enter gw4set 0 gw_address, using your gateway address gw_address.
5. Once you have configured NetClock's IP address, you can login to the Web UI by enter
ing the new address into a web browser‘s address bar.
Setting Up an IP Address via Ethernet Cable
Note: You may use an Ethernet crossover cable, but you do not have to.
Turn on the unit with NO cable plugged into the Ethernet port yet (Note: once you apply
power, it may take up to two minutes for the system to fully boot).
Configure your PC‘s network interface card (NIC) with an IP address on the same network as
the NetClock 9489‘s default IP address ( 10.10.201.1 ). For example, configure the IP
address of your PC‘s network interface card as 10.10.201.10 , with a subnet mask of
255.255.255.0.
Connect an Ethernet cable from your PC to the Ethernet port of the NetClock unit. Once con
nected via crossover cable, open a web browser and enter the NetClock‘s default IP address
( 10.10.201.1 ) into the browser‘s address bar and login to the NetClock‘s Web UI as an
administrator. Once logged in, network settings for the NetClock can be configured under
MANAGEMENT > Network Setup > Actions: General Settings and under Ports: GEAR button.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
45
2.12 Setting up an IP Address
2.12.2.2 Setting Up an IP Address via the Front Panel
Note: This topic applies only to NetClock 9483 units. If you are setting up a NetC
lock 9489 unit (which does not have a front panel information display and
keypad), see "Setting Up a Temporary IP Address Remotely" on page 50.
Assigning an IP address to NetClock, using the front panel keypad and information display is a
preferred way to provide network access to the unit, thus enabling you thereafter to complete
the setup process via the Web UI.
Keypad Operation
The functions of the six keys are:
t u arrow keys : Navigate to a menu option (will be highlighted)
pq arrow keys : Scroll through parameter values in edit displays
ü ENTER key: Select a menu option, or load a parameter when editing
Ò BACK key: Return to previous display or abort an edit process
Step-by-step instructions:
A. First, disable DHCP:
1. Press the ü key.
2. Using the arrow key, select Netv4 from the menu.
(To select a menu item, highlight it using the arrow keys, then press the ü key.)
3. Select the Ethernet interface for which DHCP is to be disabled, such as eth0.
4. Select DHCP from the next menu. The display will show State=Enabled and
Action=Disabled.
(The State is the current DHCP setting and the Action is the action to take. You can
only change the Action setting.)
5. Press the ü key once to select the action, then again to apply it.
46
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
B. Then, enter IP Address and Subnet Mask :
1. Still on the Home > Netv4 > eth[0-3] menu, select IP Address, and
change "N=010.010.201.001/16” to the value of the static IP address and
subnet mask/network bits to be assigned (for a list of subnet mask values refer to
the table "Subnet mask values" on page 52).
2. Press the ü key once to enter the setting, then again to apply the new setting.
C. Lastly, enter the Gateway Address (if required)
1. Still on the Home > Netv4 menu, select the Gateway option ( Home >
Netv4 > eth0 > Gateway).
2. Press the ü key once to enter the setting, then again to apply the new setting.
3. The
display will change, allowing you to input
N=000.000.000.001. Enter the gateway address here.
an
address
at
The address entered must correspond to the same network IP address assigned to
NetClock.
After all addresses are entered, press the x key three times to return to the main display. It
should now resemble the following example:
Note: Despite having entered an IP address, the information display will show
0.0.0.0 if NetClock could not detect an active link on the corresponding network
interface.
Note: About DNS: The Primary and Secondary DNS servers are set automatically
if using DHCP. If DHCP is not available, they can be configured manually in the
NetClock Web UI via the Network/General Setup screen.
The remainder of the configuration settings will be performed via the Web UI (accessed via an
external workstation with a web browser such as Firefox® or Chrome®). For more information,
see "The Web UI HOME Screen" on page 14.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
47
2.12 Setting up an IP Address
2.12.2.3 Setting Up a Static IP Address via a DHCP Network
To setup a permanent static IP address, after connecting NetClock to a DHCP network:
1. Enter the IP address shown on the front panel information display of your NetClock unit
(NetClock 9483 only) into the address field of your browser (on a computer connected
to the NetClock network). If the network supports DNS, the hostname may also be
entered instead (the default hostname is "Spectracom"). The start screen of the NetClock
Web UI will be displayed.
2. Log into the Web UI as an administrator. The factory-default user name and password
are:
Username: spadmin
Password: admin123
3. Disable DHCP by navigating to MANAGEMENT > Network Setup. In the Ports panel on
the right, click the GEAR icon next to the Ethernet Port you are using. In the Edit Ethernet
Port Settings window, uncheck the Enable DHCPv4 field. Do NOT click Submit or Apply
yet.
4. In the fields below the Enable DHCPv4 checkbox, enter the desired Static IP address, Net
mask, and Gateway address (if required). Click Submit.
For more information on network configuration, see: "Network Ports" on page 57.
For subnet mask values, see "Subnet Mask Values" on page 52.
5. Verify on the front panel information display that the settings have been accepted by
NetClock.
6. Enter the static IP address into the address field of the browser, and again log into the
Web UI in order to continue with the configuration; see: "The Web UI HOME Screen"
on page 14.
2.12.2.4 Setting Up an IP Address via the Serial Port
NetClock's front panel serial port connector is a standard DB9 female connector. Com
munication with the serial port can be performed using a PC with a terminal emulator program
(such as PuTTY or TeraTerm) using a pinned straight-thru standard DB9M to DB9F serial cable.
The serial port can be used to make configuration changes (such as the network settings),
retrieve operational data (e.g., GNSS receiver information) and log files, or to perform oper
ations such as resetting the admin password.
The serial port is account and password protected. You can login via the serial port using the
same user names and passwords as would be used to log into the NetClock Web UI. Users with
“administrative rights” can perform all available commands. Users with “user” permissions only
can perform “get” commands that retrieve data, but cannot perform any “set” commands or
change/reset any passwords.
To configure an IP address via the serial port:
48
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
1. Connect a serial cable to a PC running PuTTY, Tera Term, or HyperTerminal, and to
your NetClock. For detailed information on the serial port connection, see "Setting up a
Terminal Emulator" on page 363
2. Login to NetClock with a user account that has “admin” group rights, such as the default
spadmin account (the default password is admin123).
3. Disable DHCP, type: dhcp4set 0 off <Enter>.
Note: If your NetClock is configured with an Ethernet option card, use 0,
1, 2, 3 for eth0 – eth3.
Note: For a list of CLI commands, type helpcli, or see "CLI Commands"
on page 364.
4. Configure the IP address and subnet mask, type:
ip4set 0 x.x.x.x y.y.y.y <Enter>
(where 0 is the desired interface, “x.x.x.x” is the desired IP address for NetC
lock, and “y.y.y.y” is the full subnet mask for the network (For a list of subnet
mask values, see "Subnet Mask Values" on page 52.)
5. Configure the gateway by typing gw4set 0 z.z.z.z<Enter>
(where 0 indicates which interface routing table to add the default gateway for, and
“z.z.z.z” is the default gateway address).
Note: If your NetClock is configured with an Ethernet option card, use 0,
1, 2, 3 for eth0 – eth3.
6. Remove the serial cable, connect NetClock to the network, and access the Web UI, using
the newly configured IP address. (For assistance, see "Accessing the Web UI" on
page 52)
The remainder of the configuration settings will be performed via the Web UI (accessed via an
external workstation with a web browser such as Firefox® or Chrome®).
2.12.2.5 Setting up a Static IP Address via Ethernet Cable
This procedure will allow you to configure NetClock using the Web UI directly via the Ethernet
port, if for some reason you prefer not to (or cannot) use a DHCP network.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
49
2.12 Setting up an IP Address
1. First, disable DHCP using the front panel keypad and information display:
a. Press the ü key.
b. Using the arrow key, select Netv4 from the menu.
(To select a menu item, highlight it using the arrow keys, then press the ü key.)
c. Select the Ethernet interface for which DHCP is to be disabled, such as eth0.
d. Select DHCP from the next menu. The display will show State=Enabled and
Action=Disabled.
(The State is the current DHCP setting and the Action is the action to take. You can
only change the Action setting.)
e. Press the ü key once to select the action, then again to apply it.
2. The front panel will now display the default static IP address 10.10.201.1/16.
3. Change the workstation IP address to be on the same network as NetClock.
4. Connect workstation and NetClock with an Ethernet cable.
Note: You may use an Ethernet crossover cable, but you do not have to.
The remainder of the configuration settings will be performed via the Web UI (accessed via an
external workstation with a web browser such as Firefox® or Chrome®). For more information,
see "The Web UI HOME Screen" on page 14.
2.12.3 Setting Up a Temporary IP Address Remotely
f your network supports DHCP, your NetClock 9489 may have automatically been assigned an
IP address by a DHCP server (if DHCP had been enabled on the unit after initial setup and con
figuration). In this scenario, you can perform remote commands for initial network setup by
using the MAC address information of your NetClock 9489. This method also applies to stat
ically configured IP networks.
NOTE:
Before beginning, ensure the following prerequisites are met:
If it is desired to configure the NetClock 9489 with a static IP address, it must be a
unique IP address not already assigned to another device via DHCP, or that has not
already been statically assigned to another device.
Ensure that the operator or administrator‘s PC and the NetClock 9489 are on the same
subnet, and that the arp and ping commands can be issued from the workstation.
Complete the following steps:
50
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.12 Setting up an IP Address
1. From the rear panel of your NetClock 9489, locate the label displaying the MAC
address of your unit. Write down or record the MAC address information.
2. Login to the operator‘s workstation and open a command prompt window.
3. Install the NetClock 9489 on your network and the same subnet as the workstation.
4. Power on the NetClock 9489 (wait for 2 minutes for the system to fully boot).
5. From the command prompt, issue the following commands:
From a Windows Operating System
On Windows operating systems, you will need elevated privileges to execute these commands.
This can be accomplished using the runas command line program, or by holding CTRL +
Right-clicking the command prompt icon, and selecting Run as Administrator.
arp -s IP_ADDRESS MAC_ADDRESS
ping -l 408 IP_ADDRESS
Where IP_ADDRESS is the desired static IP address, and MAC_ADDRESS MAC address of
your NetClock 9489. For example:
arp -s 192.168.0.10 00-AA-11-BB-22-CC
ping -l 408 192.168.0.10
From a UNIX or GNU/Linux Operating System:
You must have administrative/root privileges to execute these commands.
sudo arp -s IP_ADDRESS MAC_ADDRESS
sudo ping -s 408 IP_ADDRESS
Where IP_ ADDRESS is the desired static IP address, and MAC_ ADDRESS is the MAC
address of your NetClock 9489. For example:
arp -s 192.168.0.10 00:AA:11:BB:22:CC
ping -s 408 192.168.0.10
Note: You must complete this process within 5 minutes of the system booting, or
else you will need to restart the NetClock system, and then restart from step 4. This
is also a temporary IP address that will not persist through power cycles.
6. Open a web browser and enter the NetClock‘s IP address into the browser‘s address
bar to access the NetClock Web UI. Login as an administrator. Navigate to
MANAGEMENT > Network Setup and set your permanent IP configuration and network
settings.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
51
2.13 Accessing the Web UI
2.12.4 Subnet Mask Values
Table 2-2: Subnet mask values
Network Bits Equivalent Netmask Network Bits Equivalent Netmask
2.13
30
255.255.255.252
18
255.255.192.0
29
255.255.255.248
17
255.255.128.0
28
255.255.255.240
16
255.255.0.0
27
255.255.255.224
15
255.254.0.0
26
255.255.255.192
14
255.252.0.0
25
255.255.255.128
13
255.248.0.0
24
255.255.255.0
12
255.240.0.0
23
255.255.254.0
11
255.224.0.0
22
255.255.252.0
10
255.192.0.0
21
255.255.248.0
9
255.128.0.0
20
255.255.240.0
8
255.0.0.0
19
255.255.224.0
Accessing the Web UI
NetClock's Web UI is the recommended tool to interact with the device, since it provides access
to nearly all configurable settings, and obtain comprehensive status information without having
to use the Command Line Interpreter (CLI).
You can access the Web UI either by using the automatically assigned DHCP IP address, or by
using a manually set static IP address (see "Assigning a Static IP Address" on page 43):
1. On a computer connected to the NetClock network, start a web browser, and enter the
IP address shown on the NetClock front panel, or setup manually beforehand into the
web browser address.
2. When first connecting to the Web UI, a warning about security certificates may be dis
played:
52
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.13 Accessing the Web UI
Select Continue....
Note: "Cookies" must be enabled. You will be notified if Cookies are dis
abled in your browser.
Note: HTTPS only: Depending on your browser, the certificate/security
pop- up window may continue to be displayed each time you open the
Web UI until you saved the certificate in your browser.
Note: Static IP address only: To prevent the security pop-up window from
opening each time, a new SSL Certificate needs to be created using the
assigned IP address of NetClock during the certificate generation. See
"HTTPS" on page 62 for more information on creating a new SSL cer
tificate.
3. Log into the Web UI as an administrator. The factory-default administrator user name
and password are:
Username: spadmin
Password: admin123
Note: For security reasons, it is advisable to change the default credentials,
see: "The Administrator Login Password" on page 220.
4. Upon initial login, you will be asked to register your product. Spectracom recommends
to register NetClock, so as to receive software updates and services notices. See also
"Product Registration" on page 248.
Number of login attempts
The number of failed login attempts for ssh is hard-set to (4) four. This value is not customer-con
figurable.
The number of failed login attempts for the Web UI (HTTP/HTTPS) is hard-set to (5) five failed
login attempts, with a 60 second lock. These two values are not customer- configurable.
To continue with the configuration, see e.g., "The Web UI HOME Screen" on page 14.
To learn more about setting up different types of user accounts, see "Managing User Accounts"
on page 215.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
53
2.14 Connecting Reference Inputs and Network Interface
2.14
Connecting Reference Inputs and Network Interface
NetClock 9400 can synchronize to various external inputs (such as GPS, NTP, PTP, and/or a
user set time). Depending on the desired operation and specific NetClock configuration, con
nect the GPS, or other external references (NTP input reference and “user set time” are software
configurations that require no additional physical connection to NetClock. These two reference
inputs are discussed later in this manual).
1. GPS Reference Input: Typical installations include GPS as an external reference input. If
the GPS receiver is not installed or if the GPS will not be used as a NetClock reference,
just disregard the steps to install the GPS antenna and associated cabling.
Install the GPS antenna, surge suppressor, antenna cabling, and GPS preamplifier (if
required). Refer to the documentation included with the Model 8225 GPS antenna for addi
tional information regarding GPS antenna installation.
Connect the GPS cable to the rear panel antenna input jack (refer to LINK). Until the GPS
antenna is connected to the rear panel jack, the Antenna Problem alarm is asserted, causing the
front panel “Fault” light to be blinking orange (the Antenna Problem alarm indicates an open
or short exists in the antenna cable). Unless there is an open or short in the antenna cable, the
Fault light should stop flashing orange once the GPS antenna and coax cable are connected to
the rear panel. If the Fault light does not stop flashing after connecting the antenna, see LINK
GPS troubleshooting reception issues
2. PTP Reference input: With the available PTP option card configured as a slave syn
chronizing via Ethernet/RJ-45 to a PTP master.
3. Network interface to LAN: Obtain the following network information from your network
administrator before continuing:
Available static IP
Address
This is the unique address assigned to the NetC
lock unit by the network administrator. The default
static IP address of the NetClock unit is
10.10.201.1.
Subnet mask (for the net
work)
The subnet mask defines the number of bits taken
from the IP address that are used in the network
portion. The number of network bits used in the net
mask can range from 8 to 30 bits.
Gateway address
The gateway (default router) address is needed if
communication to the NetClock is made outside of
the local network. By default, the gateway is dis
abled.
Table 2-3: Required Network information
If your network does not support DHCP, use the front panel LCD and keypad (see LINK
FrontPanel Key operation) to input the desired static IP, subnet mask, and gateway address.
54
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Network Bits Equivalent Netmask Network Bits Equivalent Netmask
30
255.255.255.252
18
255.255.192.0
29
255.255.255.248
17
255.255.128.0
28
255.255.255.240
16
255.255.0.0
27
255.255.255.224
15
255.254.0.0
26
255.255.255.192
14
255.252.0.0
25
255.255.255.128
13
255.248.0.0
24
255.255.255.0
12
255.240.0.0
23
255.255.254.0
11
255.224.0.0
22
255.255.252.0
10
255.192.0.0
21
255.255.248.0
9
255.128.0.0
20
255.255.240.0
8
255.0.0.0
19
255.255.224.0
Table 2-4: Subnet mask values
2.15
Configuring Network Settings
Before configuring the network settings, you need to setup access to NetClock web user inter
face ("Web UI"). This can be done by assigning a static IP address, or using a DHCP address.
For more information, see "Setting up an IP Address" on page 41.
Once you have assigned the IP address, login to the Web UI. For more information, see
"Accessing the Web UI" on page 52.
To configure network settings, or monitor your network, navigate to NetClock's Network Setup
screen.
To access the Network Setup screen:
Navigate to MANAGEMENT > Network Setup. The Network Setup screen is divided
into three panels:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
55
2.15 Configuring Network Settings
The Actions panel provides:
General Settings : Allows quick access to the primary network settings necessary to
connect NetClock to a network. See "General Network Settings" on the facing
page.
Web Interface Settings :
Web interface timeout : Determines how long a user can stay logged on.
For more information, see "Web UI Timeout" on page 239.
Access Control: Allows the configuration of access restrictions from assigned net
works/nodes.
Login Banner : Allows the administrator to configure a custom banner message to
be displayed on the NetClock Web UI login page and the CLI (Note: There is a
2000 character size limit).
SSH : This button takes you to the SSH Setup window. For details on setting up
SSH, see "SSH" on page 70.
HTTPS : This button takes you to the HTTPS Setup window. For details on setting
up HTTPS, see "HTTPS" on page 62.
System Time Message : Setup a once- per- second time message to be sent to
receivers via multicast. For details, see "System Time Message" on page 88.
The Network Services panel is used to enable (ON) and disable (OFF) network services,
as well as the Web UI display mode, details see: "Network Services" on page 59.
The Ports panel not only displays STATUS information, but is used also to set up and man
age NetClock’s network ports via three buttons:
56
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
INFO button: Displays the Ethernet port Status window for review purposes.
GEAR button: Displays the Ethernet port settings window for editing purposes.
TABLE button: Displays a window that allows adding, editing, and reviewing
Static Routes.
2.15.1 General Network Settings
To expedite network setup, NetClock provides the General Settings window, allowing quick
access to the primary network settings.
To access the General Settings window:
1. Navigate to MANAGEMENT > Network Setup. In the Actions Panel on the left, click
General Settings .
2. Populate the fields:
Hostname: This is the server’s identity on the network or IP address.
Default Port: Unless you specify a specific Port to be used as Default Port, the fact
ory default port eth0 will be used as the gateway (default gateway).
The General Settings window also displays the IPv4 Address and default IPv4 Gateway.
2.15.2 Network Ports
Ports act as communication endpoints in a network. The hardware configuration of your unit
will determine which ports (e.g., Eth0, Eth1, ...) are available for use. Before using a port, it
needs to be enabled and configured.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
57
2.15 Configuring Network Settings
To enable & configure, or view a network port:
1. Navigate to MANAGEMENT > Network Setup.
2. The Ports panel on the right side of the screen lists the available Ethernet ports, and their
connection status:
Green: CONNECTED (showing the connection speed)
Yellow: CABLE UNPLUGGED (the port is enabled but there is no cable attached)
Red: DISABLED.
Locate the port you want to configure and click the GEAR button to enable & con
figure the port, or the INFO button to view the port status.
Note: The eth0 port is the built-in NetClock Ethernet port.
3. If the port is not already enabled, in the Edit Ethernet Ports Settings window, click the
Enable check box. The Edit Ethernet Ports Settings window will expand to show the
options needed to complete the port setup.
Fill in the fields as required:
Domain: This is the domain name to be associated with this port.
Enable DHCPv4: Check this box to enable the delivery of IP addresses
from a DHCP Server using the DHCPv4 protocol. This box is checked by
default. Should you disable (uncheck) DHCPv4, the following fields will dis
play and must be completed:
Static IPv4 Address : This is the unique address assigned by the net
work administrator. The default static IP address of the NetClock unit
is 10.10.201.1. In the format “#.#.#.#” with no leading zeroes
or spaces, where each ‘#’ is a decimal integer from the range
[0,255].
58
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Table 2-5: Default IP addresses
ETH port
Default "static lease"
IP address
ETH0
10.10.201.1
ETH1
10.10.201.2
ETH2
10.10.201.3
ETH3
10.10.201.4
The default subnet is: 255.255.0.0
Netmask : This is the network subnet mask assigned by the network
administrator. In the form “xxx.xxx.xxx.xxx.” See "Subnet
Mask Values" on page 52 for a list of subnet mask values.
IPv4 Gateway: The gateway (default router) address is needed if
communication to the NetClock is made outside of the local net
work. By default, the gateway is disabled.
DNS Primary: This is the primary DNS address to be used for this
port.
Depending on how your DHCP server is configured, this is set auto
matically once DHCP is enabled. Alternatively, you may configure
your DHCP server to NOT use a DNS address.
When DHCP is disabled, DNS Primary is set manually, using the
format "#.#.#.#" with no leading zeroes or spaces, where each
‘#’ is a decimal integer from the range [0,255].
DNS Secondary: This is the secondary DNS address to be used for
this port. Depending on how your DHCP server is configured, this is
set automatically once DHCP is enabled, or your DHCP server may
be configured NOT to set a DNS address.
When DHCP is disabled, DNS Secondary is set manually, using the
format “#.#.#.#” with no leading zeroes or spaces, where each
‘#’ is a decimal integer from the range [0,255].
4. To apply your changes, click Submit (the window will close), or Apply.
2.15.3 Network Services
Several standard network services can be enabled or disabled via the easily accessible Net
work Services Panel under MANAGEMENT > Network Setup:
The Network Services panel has ON/OFF toggle switches for the following daemons and fea
tures:
System Time Message: A once-per second Time Message sent out via Multicast; for
details, see "System Time Message" on page 88.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
59
2.15 Configuring Network Settings
Daytime Protocol, RFC-867: A standard Internet service, featuring an ASCII daytime rep
resentation, often used for diagnostic purposes.
Time Protocol, RFC-868: This protocol is used to provide a machine-readable, site-inde
pendent date and time.
Telnet: Remote configuration
FTP server: Access to logs
SSH : Secure Shell cryptographic network protocol for secure data communication
HTTP: Hypertext Transfer Protocol
Note: A listing of recommended and default network settings can be found under
"Default and Recommended Configurations" on page 302.
2.15.4 Static Routes
Static routes are manually configured routes used by network data traffic, rather than solely
relying on routes chosen automatically by DHCP (Dynamic Host Configuration Protocol). With
statically configured networks, static routes are in fact the only possible way to route network
traffic.
To view, add, edit, or delete a static route:
1. Navigate to the MANAGEMENT > Network Setup screen.
2. The Ports panel displays the available Ethernet ports, and their connection status:
3. To view all configured Static Routes for all Ethernet Ports, or delete one or more Static
Routes, click the TABLE icon in the top-right corner.
4. To add a new Route, view or delete an existing Route for a specific Ethernet Port, locate
the Port listing you want to configure, and click the TABLE button next to it.
The Static Routes window for the chosen Port will open, displaying its Routing Table,
and an Add Route panel.
60
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
In the Add Route panel, populate these fields in order to assign a Static Route to
a Port:
Net Address : This is the address/subnet to route to.
Prefix : This is the subnet mask in prefix form e.g., "24". See also "Subnet
Mask Values" on page 52.
Router Address : This is where you will go through to get there.
Click the Add Route button at the bottom of the screen.
Note: To set up a static route, the Ethernet connector must be phys
ically connected to the network.
Note: Do not use the same route for different Ethernet ports; a route
that has been used elsewhere will be rejected.
Note: The eth0 port is the default port for static routing. If a port is
not given its own static route, all packets from that port will be sent
through the default.
2.15.5 Access Rules
Network access rules restrict access to only those assigned networks or nodes defined. If no
access rules are defined, access will be granted to all networks and nodes.
Note: In order to configure Access Rules, you need ADMINISTRATOR rights.
To configure a new, or delete an existing access rule:
1. Navigate to the MANAGEMENT > Network Setup screen.
2. In the Actions panel on the left, click on Access Control.
3. The Network Access Rules window displays:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
61
2.15 Configuring Network Settings
4. In the Allow From field, enter a valid IP address. It is not possible, however, to add dir
ect IP addresses, but instead they must be input as blocks, i.e. you need to add /32 at
the end of an IP address to ensure that only that address is allowed.
Example: 10.2.100.29/32 will allow only 10.2.100.29 access.
IP
addr es s
no m enc latur e:
IPv4— 10.10.0.0/16 , where
10.10.0.0 is the IP address and 16 is the subnet
mask in prefix form. See the table "Subnet Mask Values" on page 52 for a list of subnet
mask values.
5. Click the Add button in the Action column to add the new rule.
6. The established rule appears in the Network Access Rules window.
Click the Delete button next to an existing rule, if you want to delete it.
2.15.6 HTTPS
HTTPS stands for HyperText Transfer Protocol over SSL (Secure Socket Layer). This TCP/IP pro
tocol is used to transfer and display data securely by adding an encryption layer to protect the
integrity and privacy of data traffic. Certificates issued by trusted authorities are used for
sender/recipient authentication.
62
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Note: In order to configure HTTPS, you need ADMINISTRATOR rights.
Note that NetClock supports two different modes of HTTPS operation: The Standard HTTPS
Level (default), and a High-Security Level. For more information, see "HTTPS Security Levels" on
page 237.
2.15.6.1 Accessing the HTTPS Setup Window
1. Navigate to MANAGEMENT > NETWORK: HTTPS Setup (or, navigate to MANAGEMENT
> Network Setup, and click HTTPS in the Actions panel on the left):
The HTTPS Setup window has four tabs:
Create Certificate Request: This menu utilizes the OpenSSL library to generate cer
tificate Requests and self-signed certificates.
Certificate Request: A holder for the certificate request generated under the Create
Certificate Request tab. Copy and paste this Certificate text in order to send it to
your Certificate Authority.
Upload X509 PEM Certificate: Use the window under this tab to paste your X.509
certificate text and upload it to NetClock.
Upload Certificate File: Use this tab to upload your certificate file returned by the
Certificate Authority. For more information on format types, see "Supported Cer
tificate Format Types" on the next page.
Exit the HTTPS Setup window by clicking the X icon in the top right window corner, or by click
ing anywhere outside the window.
Should you exit the HTTPS Setup window while filling out the certificate request parameters
form before clicking the Submit button, any information you entered will be lost. When switch
ing between tabs within the HTTPS Setup window, the information you have entered will be
retained.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
63
2.15 Configuring Network Settings
2.15.6.2 About HTTPS
HTTPS provides secure/encrypted, web- based management and configuration of NetClock
from a PC. In order to establish a secure HTTPS connection, an SSL certificate must be stored
inside the NetClock unit.
NetClock uses the OpenSSL library to create certificate requests and self-signed certificates. The
OpenSSL library provides the encryption algorithms used for secure HTTP (HTTPS). The
OpenSSL package also provides tools and software for creating X.509 Certificate Requests,
Self Signed Certificates and Private/Public Keys. For more information on OpenSSL, please
see www.openssl.org .
Once you created a certificate request, submit the request to an external Certificate Authority
(CA) for the creation of a third party verifiable certificate. (It is also possible to use an internal
corporate Certificate Authority.)
If a Certificate Authority is not available, or while you are waiting for the certificate to be
issued, you can use the default Spectracom self-signed SSL certificate that comes with the unit
until it expires, or use your own self-signed certificate. The typical life span of a certificate (i.e.,
during which HTTPS is available for use) is about 10 years.
Note: If deleted, the HTTPS certificate cannot be restored. A new certificate will
need to be generated.
Note: If the IP Address or Common Name (Host Name) is changed, you may wish
to regenerate the certificate. Otherwise you may receive security warnings from
your web browser each time you login.
2.15.6.3 Supported Certificate Format Types
NetClock supports X.509 PEM and DER certificates, as well as PKCS#7 PEM and DER formatted
certificates.
You can create a unique X.509 self-signed certificate, an RSA private key and X.509 certificate
request using the Web UI. RSA private keys are supported because they are the most widely
accepted. At this time, DSA keys are not supported.
NetClock supports two different modes of HTTPS operation: The Standard HTTPS Level
(default), and a High- Security Level . For more information, see "HTTPS Security Levels" on
page 237.
2.15.6.4 Creating an HTTPS Certificate Request
To create an HTTPS Certificate Request:
64
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
1. Navigate to MANAGEMENT > NETWORK:HTTPS Setup, or in the MANAGEMENT >
NETWORK Setup, Actions panel, select HTTPS :
2. Click the Create Certificate Request tab (this is the default tab).
3. Fill in the available fields:
Create Self-Signed Certificate:
Caution: Spectracom recommends to check this box (if needed) after
you have filled out the form completely, before clicking Submit. This
will prevent inadvertent submission.
This checkbox serves as a security feature: Check this box before clicking Submit,
in order to confirm that you will be generating a new self- signed certificate,
thereby overwriting any previously generated (or the Spectracom default) cer
tificate. An invalid certificate may result in denial of access to NetClock via the
Web UI! (If this occurs, see "If a Secure Unit Becomes Inaccessible" on
page 239.)
Signature Algorithm : Choose the algorithm to be used from:
MD4
SHA1
SHA256
SHA512
Private Key Pass Phrase: This is the RSA decryption key. This must be at least
4 characters long.
RSA Private Key Bit Length: 2048 bits is the default. Using a lower number may
compromise security and is not recommended.
Two-Letter Country Code: This code should match the ISO-3166-1 value for the
country in question.
State Or Province Name: From the address of the organization creating up the
certificate.
Locality Name: Locale of the organization creating the certificate.
Organization Name: The name of the organization creating the certificate.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
65
2.15 Configuring Network Settings
Organization Unit Name: The applicable subdivision of the organization cre
ating the certificate.
Common Name (e.g. Hostname or IP): This is the name of the host being authen
ticated. The Common Name field in the X.509 certificate must match the host
name, IP address, or URL used to reach the host via HTTPS.
Email Address : This is the email address of the organization creating the cer
tificate.
Challenge Password: Valid response password to server challenge.
Optional Organization Name: An optional name for the organization creating
the certificate.
Self-Signed Certificate Expiration (Days): How many days before the certificate
expires. The default is 7200.
You are required to select a signature algorithm, a private key passphrase of at least
4 characters, a private key bit length, and the certificate expiration in days. The remain
ing fields are optional.
It is recommended that you consult your Certificate Authority for the required fields in
an X 509-certificate request. Spectracom recommends all fields be filled out and match
the information given to your Certificate Authority. For example, use all abbreviations,
spellings, URLs, and company departments recognized by the Certificate Authority. This
helps to avoid problems the Certificate Authority might otherwise have reconciling cer
tificate request and company record information.
If necessary, consult your web browser vendor’s documentation and Certificate Authority
to see which key bit lengths and signature algorithms your web browser supports.
Spectracom recommends that when completing the Common Name field, the user
provide a static IP address, because DHCP-generated IP addresses can change. If the
hostname or IP address changes, the X.509 certificate must be regenerated.
It is recommended that the RSA Private Key Bit Length be a power of 2 or multiple of 2.
The key bit length chosen is typically 1024, but can range from 512 to 4096. Long key
bit lengths of up to 4096 are not recommended because they can take several hours to
generate. The most common key bit length is the value 1024.
Note: The default key bit length value is 2048.
When using a self-signed certificate, choose values based on your company’s security
policy.
4. When the form is complete, check the box Create Self Signed Certificate at the top of
the window, then click Submit. Clicking the Submit button automatically generates the
Certificate Request in the proper format for subsequent submission to the Certificate
Authority.
66
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Note: It may take several minutes for NetClock to create the certificate
request and the private key (larger keys will require more time than small
keys). If the unit is rebooted during this time, the certificate will not be cre
ated.
To view the newly generated request, in the HTTPS Setup window, click the Certificate
Request tab.
When switching between tabs within the HTTPS Setup window, the information you
have entered will be retained. If you exit the HTTPS Setup window before clicking Sub
mit, the information will be lost.
2.15.6.5 Requesting an HTTPS Certificate
Before requesting an HTTPS Certificate from a third-party Certificate Authority, you need to cre
ate a Certificate Request:
1. Navigate to MANAGEMENT > HTTPS Setup, or to MANAGEMENT > Network Setup >
Actions panel: HTTPS .
2. In the HTTPS Setup window, under the Certificate Request Parameters tab, complete the
form as described under "Creating an HTTPS Certificate Request" on page 64.
3. Click Submit to generate your Certificate Request.
4. You have now created a Certificate Request. Navigate to the Certificate Request tab to
view it:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
67
2.15 Configuring Network Settings
5. Copy the generated Certificate Request from the Certificate Request window, and paste
and submit it per the guidelines of your Certificate Authority. The Certificate Authority
will issue a verifiable, authenticable third-party certificate.
6. OPTIONAL: While waiting for the certificate to be issued by the Certificate Authority,
you may use the certificate from the Certificate Request window as a self-signed cer
tificate (see below).
NOTE: Preventing accidental overwriting of an existing certificate:
If you plan on using a new Certificate Request, fill out a new form under the Certificate Request
Parameters tab. Be aware, though, that the newly generated Certificate Request will replace
the Certificate Request previously generated once you submit it. Therefore, if you wish to retain
your previously generated Certificate Request for any reason, copy its text, and paste it into a
separate text file. Save the file before generating a new request.
Using a Self-Signed Certificate
In the process of generating a Certificate Request, a self-signed certificate will automatically be
generated simultaneously. It will be displayed under the Certificate Request tab.
You may use your self-signed certificate (or the default Spectracom self-signed certificate that
comes with the unit) while waiting for the HTTPS certificate from the Certificate Authority, or – if
a Certificate Authority is not available – until it expires. The typical life span of a certificate is
about 10 years.
NOTE: When accessing the NetClock Web UI while using the self-signed certificate, your Win
dows® web browser will ask you to confirm that you want to access this site via https with only
a self-signed certificate in place. Other operating systems may vary in how they install and
accept certificates. External Internet access may be required by your Certificate Authority to
verify your certificate.
68
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
2.15.6.6 Uploading an X.509 PEM Certificate Text
Many certificate authorities simply issue a certificate in the form of a plain text file. If your cer
tificate was provided in this manner, and the certificate is in the X.509 PEM format, follow the
procedure below to upload the certificate text by copying and pasting it into the Web UI.
Note: Only X.509 PEM certificates can be loaded in this manner. Certificates
issued in other formats must be uploaded via the Upload Certificate tab.
To upload an X.509 PEM certificate text to NetClock:
1. Navigate to MANAGEMENT > NETWORK: HTTPS Setup.
2. Select the Upload X.509 PEM Certificate tab.
3. Copy the text of the certificate that was issued to you by your Certificate Authority, and
paste it into the text field.
4. Click Submit.to upload the certificate to NetClock.
NOTE: The text inside the text field under the Edit X.509 PEM Certificate tab is editable.
However, changes should not be made to a certificate once it is imported; instead, a new cer
tificate should be requested. An invalid certificate may result in denial of access to the NetClock
through the Web UI. If this occurs, see "If a Secure Unit Becomes Inaccessible" on page 239.
2.15.6.7 Uploading an HTTPS Certificate File
Once the HTTPS Certificate has been issued by your Certificate Authority, you have to upload
the certificate file to NetClock, unless it is a X.509 PEM-format certificate: in this case you may
also upload the certificate text directly, see "Uploading an X.509 PEM Certificate Text" above.
Note: For more information about certificate formats, see "Supported Certificate
Format Types" on page 64.
To upload an HTTPS certificate file to NetClock:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
69
2.15 Configuring Network Settings
1. Store the Public Keys File provided to you by the Certificate Authority in a location
accessible from the computer on which you are running the Web UI.
2. In the Web UI, navigate to MANAGEMENT > NETWORK: HTTPS Setup.
3. Select the tab Upload Certificate File.
4. Choose the Certificate Type for the HTTPS Certificate supplied by the Certificate Author
ity from the Certification Type drop-down menu:
PEM
DER
PKCS #7 PEM
PKCS #7 DER
5. Click the Browse… button and locate the Public Keys File provided by the Certificate
Authority in its location where you stored it in step 1.
6. Click Submit.
Note: NetClock will automatically format the certificate into the X.509 PEM
format.
2.15.7 SSH
The SSH, or Secure Shell, protocol is a cryptographic network protocol, allowing secure
remote login by establishing a secure channel between an SSH client and an SSH server. SSH
uses host keys to uniquely identify each SSH server. Host keys are used for server authen
tication and identification. A secure unit permits users to create or delete RSA or DSA keys for
the SSH2 protocol.
Note: Only SSH2 is supported due to vulnerabilities in the SSH1 protocol.
The SSH tools supported by NetClock are:
70
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
SSH : Secure Shell
SCP: Secure Copy
SFTP: Secure File Transfer Protocol
NetClock implements the server components of SSH, SCP, and SFTP.
For more information on OpenSSH, please refer to www.openssh.org .
To configure SSH:
1. Navigate to MANAGEMENT > NETWORK: SSH Setup. The SSH Setup window will dis
play.
The window contains two tabs:
Host Keys : SSH uses Host Keys to uniquely identify each SSH server. Host keys
are used for server authentication and identification.
Public Key : This is a text field interface that allows the user to edit the public key
files authorized_keys file.
Note: Should you exit the SSH Setup window (by clicking X in the top right
corner of the window, or by clicking anywhere outside of the window),
while filling out the Certificate Request Parameters form before clicking
Submit, any information you entered will be lost. When switching between
CHAPTER 2 • NetClock User Reference Guide Rev. 13
71
2.15 Configuring Network Settings
tabs within the SSH Setup window, however, the information you have
entered will be retained.
Host Keys
You may choose to delete individual RSA or DSA host keys. Should you decide to delete the
RSA or DSA key, the SSH will function, but that form of server authentication will not be avail
able. Should you delete both the RSA and DSA keys, SSH will not function. In addition, if SSH
host keys are being generated at the time of deletion, the key generation processes are
stopped, any keys created will be deleted, and all key bit sizes are set to 0.
You may choose to delete existing keys and request the creation of new keys, but it is often sim
pler to make these requests separately.
You can create individual RSA and DSA Host Public/Private Key pairs. Host keys must first be
deleted before new Host Keys can be created.
NetClock units have their initial host keys created at the factory. RSA host key sizes can vary
between 768 and 4096 bits. The recommended key size is 1024. Though many key sizes are
supported, it is recommended that users select key sizes that are powers of 2 or divisible by 2.
The most popular sizes are 768, 1024, and 2048. Large key sizes of up to 4096 are sup
ported, but may take 10 minutes or more to generate. DSA keys size support is limited to 1024
bits.
Host keys are generated in the background. Creating RSA and DSA keys, each with 1024 bits
length, typically takes about 30 seconds. Keys are created in the order of RSA, DSA, RSA.
When the keys are created you can successfully make SSH client connections. If the unit is
rebooted with host key creation in progress, or the unit is booted and no host keys exist the key
generation process is restarted. The key generation process uses either the previously specified
key sizes or if a key size is undefined, the default key bit length size used is 2048. A key with a
zero length or blank key size field is not created.
The SSH client utilities SSH, SCP, and SFTP allow for several modes of user authentication.
SSH allows you to remotely login or transfer files by identifying your account and the target
machine's IP address. As a user you can authenticate yourself by using your account password,
or by using a Public Private Key Pair.
It is advisable to keep your private key secret within your workstation or network user account,
and provide the NetClock a copy of your public key. The modes of authentication supported
include:
Either Public Key with Passphrase or Login Account Password
Login Account Password only
Public Key with Passphrase only
SSH using public/private key authentication is the most secure authenticating method for SSH,
SCP or SFTP sessions.
You are required to create private and public key pairs on your workstation or within a
private area in your network account. These keys may be RSA or DSA and may be any key bit
72
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
length as supported by the SSH client tool. These public keys are stored in a file in the .ssh
directory named authorized_keys. The file is to be formatted such that the key is followed
by the optional comment with only one key per line.
Note: The file format, line terminations, and other EOL or EOF characters should
correspond to UNIX conventions, not Windows.
Changing Key Length Values
You may change the key length of the RSA, DSA, ECDSA, and ED25519 type host keys.
To change the key length of a host key:
1. Navigate to MANAGEMENT > NETWORK: SSH Setup. The SSH Setup window will
open to the Host Keys tab by default.
2. Select the Key Length value for the key type you want to change.
Key sizes that are powers of 2 or divisible by 2 are recommended. The most popular
sizes are 768, 1024, and 2048. Large key sizes of up to 4096 are supported, but may
take 10 minutes or more to generate. DSA keys size support is limited to 1024 bits. The
key type ED25519 supports 256 bits.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
73
2.15 Configuring Network Settings
3. Check the Regenerate All Keys box.
4. Click Submit. The new values will be saved.
Note: Changing the values and submitting them in this manner DOES NOT gen
erate new host public/private key pairs. See "Creating Host Public/Private Key
Pairs" below for information on how to create new host public/private key pairs.
Deleting Host Keys
You can delete individual host keys. To delete a key:
1. Navigate to MANAGEMENT > NETWORK: SSH Setup. The window will open to the
Host Keys tab by default.
2. Select Delete in the field for the key you wish to delete, and click Submit.
Creating Host Public/Private Key Pairs
You may create individualHost Public/Private Key pairs. Host keys must first be deleted before
new Host Keys can be created. To create a new set of host keys:
1. To access the SSH setup screen, navigate to MANAGEMENT > NETWORK: SSH Setup.
The window will open to the Host Keys tab by default.
74
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
2. Should you want to change the key length of any host key, enter the desired length in the
text field corresponding to the length you wish to change.
3. Check the Regenerate All Keys box.
4. Click Submit.
The Key Type/Status/Action table will temporarily disappear while the NetClock regen
erates the keys. The Host keys are generated in the background. Creating RSA and DSA
keys, each with 1024 bits length, typically takes about 30 seconds. Keys are created in
the order of RSA, DSA, ECDSA, ED25519. NetClock will generate all 4 host keys, RSA,
DSA, ECDSA, and ED25519.
5. Delete any of the keys you do not want. See "Deleting Host Keys" on the previous page.
Note: If the unit is rebooted with host key creation in progress, or the unit
is booted and no host keys exist, the key generation process is restarted.
The key generation process uses the previously specified key sizes.
Note: If a key size is undefined, the default key bit length size used is
2048. A key with a zero length or blank key size field will not be created.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
75
2.15 Configuring Network Settings
When you delete a host key and recreate a new one, SSH client sessions will warn you that the
host key has changed for this particular IP address. The user will then either have to:
1. Override the warning and accept the new Public Host Key and start a new connection.
This is the default. This option allows users to login using either method. Whichever
mode works is allowed for logging in. If the Public Key is not correct or the Passphrase
is not valid the user is then prompted for the login account password.
2. Remove the old Host Public Key from their client system and accept the new Host Public
Key. This option simply skips public/private key authentication and immediately prompts
the user for password over a secure encrypted session avoiding sending passwords in
the clear.
3. Load a public key into NetClock. This public key must match the private key found in the
users account and be accessible to the SSH, SCP, or SFTP client program. The user must
then enter the Passphrase after authentication of the keys to provide the second factor for
2-factor authentication.
Please consult your specific SSH client’s software’s documentation.
Public Keys: Viewing, Editing, Loading
The authorized_keys file can be viewed and edited, so as to enable adding and delet
ing Public Keys. The user may also retrieve the authorized_keys file from the .ssh dir
ectory Using FTP, SCP, or SFTP.
If you want to completely control the public keys used for authentication, a correctly formatted
authorized_keys file formatted as indicated in the OpenSSH web site can be loaded
onto NetClock. You can transfer a new public key file using the Web UI.
To view and edit the authorized_keys file:
1. Navigate to MANAGEMENT > NETWORK: SSH Setup. The SSH Setup window will
open to the Host Keys tab by default.
2. Select the Public Key tab. The authorized_keys file appears in the Public Keys File
window:
76
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
3. Edit the authorized_keys file as desired.
4. Click the Submit button or Apply button.
The file is to be formatted such that the key is followed by an optional comment, with only one
key per line. The file format, line terminations, and other EOL or EOF characters should cor
respond to UNIX conventions, not Windows.
Note: If you delete ALL Public Keys, Public/Private Key authentication is disabled.
If you have selected SSH authentication using the Public Key with Passphrase
option, login and file transfers will be forbidden. You must select a method allow
ing the use of account password authentication to enable login or file transfers
using SCP or SFTP.
Editing the "authorized_key" File via CLI
Secure shell sessions using an SSH client can be performed using the admin or a user-defined
account. The user may use Account Password or Public Key with Passphrase authentication. The
OpenSSH tool SSH-KEYGEN may be used to create RSA and DSA keys used to identify and
authenticate user login or file transfers.
The following command lines for OpenSSH SSH client tool are given as examples of how to
create an SSH session.
Creating an SSH session with Password Authentication for the admin account
ssh spadmin@10.10.200.5
CHAPTER 2 • NetClock User Reference Guide Rev. 13
77
2.15 Configuring Network Settings
spadmin@10.10.200.5's password: admin123
You are now presented with boot up text and/or a “>” prompt which allows the use of the
Spectracom command line interface.
Creating an SSH session using Public Key with Passphrase Authentication for the
admin account
You must first provide the secure Spectracom product a RSA public key found typically in the
OpenSSH id_rsa.pub file. Then you may attempt to create an SSH session.
ssh -i ./id_rsa spadmin@10.10.200.5
Enter passphrase for key './id_rsa': mysecretpassphrase
Please consult the SSH client tool’s documentation for specifics on how to use the tool, select
SSH protocols, and provide user private keys.
Secure File Transfer Using SCP and SFTP
NetClock provides secure file transfer capabilities using the SSH client tools SCP and SFTP.
Authentication is performed using either Account Passwords or Public Key with Passphrase.
Example output from OpenSSH, SCP, and SFTP client commands are shown below.
Perform an SCP file transfer to the device using Account Password authentication
scp authorized_keys scp@10.10.200.5:.ssh
spadmin@10.10.200.135's password: admin123
publickeys
100%
|***************************************************| 5 00:00
Perform an SCP file transfer to the device using Public Key with Passphrase authen
tication.
scp -i ./id_rsa spadmin@10.10.200.5:.ssh
Enter passphrase for key './id_rsa': mysecretpassphrase
publickeys 100%
|***************************************************| 5 00:00
Perform an SFTP file transfer to the device using Account Password authentication.
sftp spadmin@10.10.200.5
spadmin@10.10.200.135's password: admin123
You will be presented with the SFTP prompt allowing interactive file transfer and directory nav
igation.
78
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Perform an SFTP file transfer to the device using Public Key with Passphrase authen
tication
sftp -i ./id_rsa spadmin@10.10.200.5
Enter passphrase for key './id_rsa': mysecretpassphrase
You will be presented with the SFTP prompt allowing interactive file transfer and directory nav
igation.
Recommended SSH Client Tools
Spectracom does not make any recommendations for specific SSH clients, SCP clients, or SFTP
client tools. However, there are many SSH based tools available to the user at low cost or free.
Two good, free examples of SSH tool suites are the command line based tool OpenSSH run
ning on a Linux or OpenBSD x86 platform and the SSH tool suite PuTTY.
The OpenSSH tool suite in source code form is freely available at www.openssh.org though
you must also provide an OpenSSL library, which can be found at www.openssl.org .
PuTTY can be found at: http://www.chiark.greenend.org.uk/~sgtatham/putty/.
SSH Timeout
The keep-SSH alive timeout is hard-set to 7200 seconds. This value is not configurable.
2.15.8 SNMP
SNMP (Simple Network Management Protocol) is a widely used application-layer protocol for
managing and monitoring network elements. It has been defined by the Internet Architecture
Board under RFC- 1157 for exchanging management information between network devices,
and is part of the TCP/IP protocol.
SNMP agents must be enabled and configured so that they can communicate with the network
management system (NMS). The agent is also responsible for controlling the database of con
trol variables defined in the Management Information Base (MIB).
NetClock’s SNMP functionality supports SNMP versions V1, V2c and V3 (with SNMP Version 3
being a secure SNMP protocol).
Note: In order to configure SNMP, you need ADMINISTRATOR rights.
To access the SNMP Setup screen:
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup. The SNMP screen will dis
play:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
79
2.15 Configuring Network Settings
The SNMP screen is divided into 3 panels:
1. The Main panel, which is subdivided into 3 displays:
SNMP V1/V2: This panel allows configuration of SNMP v1 and v2c com
munities (used to restrict or allow access to SNMP). This tab allows the con
figurations for SNMP v1 and v2c, including the protocols allowed,
permissions and Community names as well as the ability to permit or deny
access to portions of the network. Clicking on the “+” symbol in the topright corner opens the SNMP V1/V2c Settings for Access Screen. See
"SNMP V1/V2c" on page 83.
SNMP V3 : This panel allows configuration of SNMP v3 functionality,
including the user name, read/write permissions, authorization passwords
as well as privilege Types and Passphrases. Clicking on the “+” symbol in
the top- right corner opens the SNMP V3 Screen. See "SNMP V3" on
page 84.
SNMP Traps : This panel allows you to define different SNMP Managers
that SNMP traps can be sent to over the network. This allows for SNMP
Managers in different geographical areas to receive the same SNMP traps
that Managers in other areas also receive. Clicking the PLUS icon in the
top-right corner opens the SNMP Traps Settings Screen. See also "SNMP
Traps" on page 86 and "Setting Up SNMP Notifications" on page 212.
2. The Actions panel , which contains the Restore Default SNMP Configuration but
ton.
3. The SNMP Status panel, which offers:
An SNMP ON/OFF switch.
An Authentication Error Trap ON/OFF switch.
SysObjID —The System Object ID number. This is editable in the SNMP
Status panel (see "Configuring the SNMP Status" on the facing page).
80
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Contact Information —The email to contact for service. This is editable in
the SNMP Status panel (see "Configuring the SNMP Status" below).
Location —The system location. This is editable in the SNMP Status panel
(see "Configuring the SNMP Status" below).
Description — A simple product description. This is not editable in the
SNMP Status.
Restoring the Default SNMP Configuration
To restore the NetClock to its default SNMP configuration:
1. Navigate to the MANAGEMENT > NETWORK: SNMP Setup screen.
2. In the Actions panel, click the Restore Default SNMP Configuration button.
3. Confirm that you want to restore the default settings in the pop-up message.
Configuring the SNMP Status
The SNMP Status Settings are sysObjectID, sysContact, and sysLocation. To configure SNMP
Status Settings:
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. In the SNMP Status panel on the left, click the GEAR icon in the top-right corner of the
panel.
3. The SNMP Status pop-up window will display:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
81
2.15 Configuring Network Settings
The following settings can be configured in this window:
In the sysObjectID field, enter the SNMP system object ID.
In the sysContact field, enter the e-mail information for the system contact you
wish to use.
In the sysLocation field, enter the system location of your NetClock unit.
4. Click Submit, or cancel by clicking the X -icon in the top-right corner.
Accessing the SNMP Support MIB Files
Spectracom’s private enterprise MIB files can be extracted via File Transfer Protocol (FTP) from
NetClock, using an FTP client such as FileZilla or any other shareware/freeware FTP program.
To obtain the MIB files from NetClock via FTP/SFTP:
1. Using an FTP program, log in as an administrator.
2. Through the FTP program, locate the Spectracom MIB files in the /home/spectracom/mibs directory.
3. FTP the files to the desired location on your PC for later transfer to the SNMP Manager.
4. Compile the MIB files onto the SNMP Manager.
Note: When compiling the MIB files, some SNMP Manager programs may
require the MIB files to be named something other than the current names
for the files. The MIB file names may be changed or edited as necessary to
meet the requirements of the SNMP Manager. Refer to the SNMP Manager
documentation for more information on these requirements.
Note: In addition to the Spectracom MIB files, there are also some netsnmp MIB files provided. Net-snmp is the embedded SNMP agent that is
used in the NetClock and it provides traps to notify the user when it starts,
restarts, or shuts down. These MIB files may also be compiled into your
SNMP manager, if they are not already present.
Spectracom’s private enterprise MIB files can be requested and obtained from the Spec
tracom Customer Service department via email at techsupport@spectracom.com.
82
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Note: By default, techsupport@spectracom.com is the address in the
sysContact field of the SNMP Status panel of the SNMP Setup page.
2.15.8.1 SNMP V1/V2c
SNMP V1 is the first version of the SNMP protocol, as defined in the IETF (Internet Engineering
Task Force) RFCs (Request for Comments) number 1155 and 1157. SNMP V2c is the revised
protocol, but it also uses the V1 community based administration model.
Creating Communities
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. In the SNMP V1/V2 panel click the PLUS icon in the top-right corner.
3. The SNMP V1/V2c Settings for Access window will display:
4. Enter the required information in the fields provided
The IP Version field provides a choice of IPv4, IPV6 or both IPv4 and IPv6 (=
default).
The choices offered below will change in context with the choice made in the IP
Version field.
If no value is entered in the IPv4 and/or IPv6 field, NetClock uses the system
default address.
SNMP Community names should be between 4 and 32 characters in length.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
83
2.15 Configuring Network Settings
Permissions may be Read Only or Read/Write
The Version field provides a choice of V1 or V2c.
5. Click Submit. The created communities will appear in the SNMP V1/V2 panel:
Editing and Deleting Communities
To edit or delete a community you have created:
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. Click the row of the SNMP V1/V2 panel that displays the community you wish to edit or
delete. The cursor will change from an arrow icon to a pointing finger to indicate that
the entry is clickable.
3. The SNMP V1/V2c Settings for Access window will display.
Note: The options available for editing in the SNMP V1/V2c Settings for
Access window will vary contextually according to the information in the
entry chosen.
4. To edit the settings, enter the new details you want to edit and click Submit. OR: To
delete the entry, click Delete.
2.15.8.2 SNMP V3
SNMP V3 utilizes a user-based security model which, among other things, offer enhanced secur
ity over SNMP V1 and V2.
84
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
Creating Users
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. In the SNMP V3 panel, click the PLUS icon in the top-right corner.
3. The SNMP V3 Settings window will display.
4. Enter the required information in the fields provided.
SNMP User Names and passwords are independent of users that are configured
on the Tools/Users page.
User names are arbitrary. SNMP User Names should be between 1 and
31 characters in length.
The User Name must be the same on NetClock and on the management sta
tion.
The Auth Type field provides a choice between MD5 and SHA.
The Auth Password must be between 8 and 32 characters in length.
The Priv Type field provides a choice between AES and DES.
The Priv Passphrase must be between 8 and 32 characters in length.
The Permissions field provides a choice between Read/Write and Read Only.
5. Click Submit. The created user will appear in the SNMP V3 panel:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
85
2.15 Configuring Network Settings
Editing and Deleting Users
To edit or delete a user you have created:
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. Click the row of the SNMP V3 panel that displays the community you wish to edit or
delete. The cursor will change from an arrow icon to a pointing finger to indicate that
the entry is clickable.
3. The SNMP V3 Settings window will display:
4. Apply your changes and click Submit. OR: Click Delete to remove the User.
2.15.8.3 SNMP Traps
SNMP traps allow for automatic event notification, and as such are one way to remotely mon
itor NetClock's status.
SNMP traps indicate the status change that caused the trap to be sent and may also include one
or more objects, referred to as variable-bindings, or varbinds . A varbind provides a current
NetClock data object that is related to the specific trap that was sent. For example, when a Hol
dover trap is sent because NetClock either entered or exited the Holdover mode, the trap var
bind will indicate that NetClock is either currently in Holdover mode or not currently in
Holdover mode.
For testing purposes, a command line interface command is provided. This command,
testevent , allows one, several, or all of the traps defined in the NetClock MIB to be gen
erated. Refer to "CLI Commands" on page 364 for command details.
To define SNMP Traps (Notifications):
1. Navigate to MANAGEMENT > NETWORK: SNMP Setup.
2. In the SNMP Traps panel, click the PLUS icon in the top-right corner.
86
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
3. The SNMP Traps Settings window will display:
4. Enter the required information in the fields provided. (Note that the options will vary con
textually according to your Version.)
5.
The Version field provides a choice between v1, v2c, and v3 [= default]
The Community field for the SNMP Community string. [v1, v2c]
SNMP User names should be between 4 and 32 characters in length. [v3]
Destination IP Version is a choice between IPv4 and IPv6. [v1, v2c, v3]
Destination IP is destination address for the notification and password key to be
sent. The default port is 162. [v1, v2c, v3]
The UDP Port number used by SNMP Traps [default = 162]. [v1, v2c]
Engine Id must be a hexadecimal number (such as 0x1234). The Id originates
from the MIB Browser/SNMP Manager. [v3]
Auth Type provides a choice between MD5 (the default) and SHA. [v3]
The Auth Password must be between 8 and 32 characters in length. [v3]
The Priv Type field provides a choice between AES and DES. [v3]
The Priv Passphrase must be between 8 and 32 characters in length. [v3]
6. Click the Submit button at the bottom of the window. Cancel any changes by clicking the
X -icon in the top-right corner (any information entered will be lost).
CHAPTER 2 • NetClock User Reference Guide Rev. 13
87
2.15 Configuring Network Settings
7. The SNMP trap you created will appear in the SNMP Traps panel:
Each row of the SNMP Traps panel includes the version of the SNMP functionality, the
User/Community name for the trap, the IP address/Hostname of the SNMP Manager
and values applicable only to SNMP v3, which include the Engine ID, the Authorization
Type, the Privilege Type.
You may define different SNMP Managers to whom SNMP traps can be sent over the
network. This allows for SNMP Managers in different geographical areas to receive the
same SNMP traps.
Note: Spectracom has been assigned the enterprise identifier 18837 by
the IANA (Internet Assigned Numbers Authority). Spectracom’s product
MIBs reside under the enterprise identifier @18837.3.
For detailed descriptions of the objects and traps supported by the NetClock, please
refer to the Spectracom NetClock MIB files. See "Accessing the SNMP Support MIB
Files" on page 82.
2.15.9 System Time Message
The System Time Message is a feature used for special applications that require a once-persecond time message to be sent out by NetClock via multicast. This time message will be trans
mitted before every 1PPS signal, and can be used to evaluate accuracy and jitter.
To set up and enable a System Time Message:
1. Navigate to MANAGEMENT > Network Setup > Actions panel, and select System Time
Message. The Settings window will open.
2. Populate the fields Multicast Address , Port Number and Message ID, and click Submit.
88
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.15 Configuring Network Settings
3. In the Network Services panel, enable System Time Message.
2.15.9.1 System Time Message Format
This message contains the time when the next 1PPS discrete will occur. It is sent once per second
prior to the 1PPS discrete.
Table 2-6: System Time Message format
Word
Byte 3
1
Msg ID
2
Msg Size
3
Seconds
4
nSec
5
EOM
Byte 2
Byte 1
CHAPTER 2 • NetClock User Reference Guide Rev. 13
Byte 0
89
2.16 Configuring NTP
Table 2-7: System Time Message field descriptions
Data
Name
2.16
Data Description
Range
Resolution
Units
Message
ID
UID of the message; programmable
Unsigned 32 bit
integer
1
n/a
Message
Size
Total message size in bytes
Unsigned 32 bit
integer
1
Bytes
Seconds
Seconds since epoch (00:00:00 Jan 1,
1970 UTC)
Unsigned 32 bit
integer
1
Seconds
NSec
NSec within the current second
Unsigned 32 bit
integer
1
nsec
EOM
End-of-message
-1
1
n/a
Configuring NTP
Network Time Protocol (NTP) and Simple Network Time Protocol (SNTP) are client-server pro
tocols that are used to synchronize time on IP networks. NTP provides greater accuracy and bet
ter error checking capabilities than SNTP does, but requires more resources.
For many applications, it is not necessary to modify the NTP factory default configuration set
tings. It is possible, however, to change most of the settings in order to support specific NTP
applications which may require a non-standard configuration:
These features include the ability to use either MD5 authentication or NTP Autokey, to block
NTP access to parts of the network and to broadcast NTP data to the network’s broadcast
address. NTP and SNTP are used to synchronize time on any computer equipment compatible
with the Network Time Protocol. This includes Cisco routers and switches, UNIX machines, and
Windows machines with suitable clients. To synchronize a single workstation, several freeware
or shareware NTP clients are available on the Internet. The software running on the PC determ
ines whether NTP or SNTP is used.
When the NTP service is enabled, NetClock will “listen” for NTP request messages from NTP cli
ents on the network. When an NTP request packet is received, NetClock will send an NTP
response time packet to the requesting client. Under typical conditions, NetClock can service
several thousand NTP requests per second without MD5 authentication enabled, and at a some
what lower rate with MD5 authentication enabled.
You can either enable or completely disable the NTP Service. When NTP is disabled, no NTP
time packets will be sent out to the network. When enabled, by default, the NTP Service oper
ates in Unicast mode, i.e. the NTP Service responds to NTP requests only.
Note: In order to configure NTP, you need to access the NTP Setup screen which
requires ADMINISTRATOR rights.
90
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
2.16.1 Checklist NTP Configuration
The following is a list of configuration settings you may want to consider as you setup your NTP
Service. (Not all items may apply to your application, or there may be other considerations not
included in this list.)
1. Did you setup your NTP Service and have it use the right Reference(s)?
See "NTP Reference Configuration" on page 98.
2. Does your NTP Service use the right Timescale?
See "NTP Output Timescale" on page 96.
3. If required, have you setup other NTP Servers and Peers for fallback purposes?
See "NTP Servers and Peers" on page 100.
4. Have you configured NTP Authentication and Access Restrictions (as needed)?
See "NTP Autokey" on page 107, and .
2.16.2 The NTP Setup Screen
The NTP Setup screen provides access to all NTP configuration settings.
To open the NTP Setup screen, navigate to MANAGEMENT > NTP Setup . The NTP Setup
screen is divided into 5 panels:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
91
2.16 Configuring NTP
The NTP Servers and Peers panels
… are located on the right-hand side of the NTP screen:
NTP Servers : In this display you can view the NTP Servers that NetClock detects in your
network. It is through this display that you configure external NTP references. See "NTP
Servers: Adding, Configuring, Removing" on page 103.
NTP Peers : In this display you can view the NTP Peers that NetClock detects in your net
work. It is through this display that you configure NTP Peer reference inputs. See "NTP
Peers: Adding, Configuring, Removing" on page 105.
For more information on NTP servers, clients, and Stratums see "NTP Servers and Peers" on
page 100.
The NTP Throughput panel
… shows two graphs depicting the rate of NTP traffic from Clients and Server/Peers.
The INFO icon opens a window showing the maximum per second traffic rate from
each.
92
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
The graphs maybe saved and downloaded (> ARROW icon), or deleted (> TRASH CAN
icon).
Note that this data is currently only displayed for NTP, and not for TimeKeeper NTP.
The Actions panel
… is in the top left-hand corner of the NTP screen comprises the following buttons:
Symmetric Keys : Click here to set up your symmetric keys for MD5 authentication. For
more information on Symmetric Keys, see "Configuring NTP Symmetric Keys" on
page 113.
Access Restrictions : Click here to view, change or delete access restrictions to the NTP
network. (See also "NTP Access Restrictions" on page 115.)
Fields in the NTP Access Restrictions table include:
Type
IP Version
IP
IP Mask
Auth only
Enable Query
View NTP Clients : Click here to reveal a table of all the clients your NetClock is ser
vicing. (See also "Viewing NTP Clients" on page 95.)
Information for each client includes:
Client IP
Received Packets
Mode
Version
Restriction Flags
Avg Interval
Last Interval
Restore Default NTP Configuration: Click here to restore NetClock’s NTP settings to the
factory default. Any settings you have created previously will be lost. See "Restoring the
Default NTP Configuration" on page 95.
The NTP Services panel
… is the second panel on the left-hand side of the NTP screen. It has two switches:
NTP ON/OFF : This switch enables and disables NTP. See "Dis-/Enabling NTP" on the
next page.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
93
2.16 Configuring NTP
Note: When applying any changes NTP will usually restart automatically.
Use this switch only to force a restart.
Expert Mode: Turning this switch ON enables direct access to the NTP.conf file, thus
bypassing the NetClock Web UI. [Default =OFF] See "NTP Expert Mode" on page 128.
Note: Spectracom Tech Support does not support the editing of the NTP
configuration files in Expert Mode. For additional information on editing
the NTP.conf file, please refer to http://www.ntp.org .
Other NTP Services that can be configured via the NTP Services panel by clicking the GEAR
icon are:
Autokey (see "Configuring NTP Autokey" on page 109)
Stratum 1 (see "NTP Reference Configuration" on page 98)
The NTP Status Summary panel
… provides a real-time overview of your key NTP network parameters. For more information,
see "NTP Status Monitoring" on page 265.
2.16.3 Dis-/Enabling NTP
If you applied NTP configuration changes e.g., added a new NTP Server, NetClock usually will
stop and re-start the NTP Service automatically once you clicked Submit. Changes made to NTP
configurations will also take effect after NetClock is either rebooted or power-cycled.
You can, however, also disable or enable the NetClock NTP Service manually, e.g. with NTP
Autokey.
To disable and enable your NTP Service:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Services panel, set the ON/OFF toggle switch to OFF.
94
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
3. A notification window will confirm the status change.
4. In the NTP Services panel, set the ON/OFF toggle switch to ON again.
Changes made will now take effect and NTP operation will be restored shortly after this oper
ation is performed.
2.16.4 Viewing NTP Clients
To view the NTP clients being served by NetClock:
1. Navigate to MANAGEMENT> NETWORK: NTP Setup.
2. In the NTP Actions panel, click View NTP Clients :
3. The NTP Clients window will display, showing a table of the clients that are syn
chronizing to NetClock via NTP:
You can search any of the fields for specific information in the Search field at the
top of the window.
A limit of 10 entries will appear on the screen at any one time. If you have more
than 10 clients, you can move through the table using the First , Previous , Next
and Last navigation buttons at the bottom of the screen.
2.16.5 Restoring the Default NTP Configuration
The NetClock default NTP configuration can be restored at any time. It comprises basic settings
such as Stratum 1 operation with no other servers or peers, no broadcasting and no access
CHAPTER 2 • NetClock User Reference Guide Rev. 13
95
2.16 Configuring NTP
restrictions. External queries or modifications are not permitted, while generally all IPv4 and
IPv6 client connections are allowed.
To restore NetClock to its default NTP configuration:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Actions panel, click Restore Default NTP Configuration.
3. In the dialog window that displays, click OK.
2.16.6 NTP Output Timescale
You can choose the timescale NetClock will use for the time stamps it sends out to its NTP clients
and network nodes. This is done by setting NetClock System Time timescale. The options are
UTC, TAI and GPS. Typically, UTC is used for network synchronization.
Note that the System Time affects not only NTP output, but also all other aspects of time man
agement e.g., time distributed via channels other than NTP, logging, and time displayed on the
unit front panel and in the Web UI.
If NetClock is operated as a Stratum 2 server, i.e. as a client to a Stratum 1 server (see "Con
figuring "NTP Stratum Synchronization"" on page 99), the other server will override NetC
lock's System Timescale, should it be different.
Note: IMPORTANT: Make sure you select your desired timescale! Using the
wrong timescale will inevitably result in an undesired time error in your NTP cli
ents.
To change the system timescale NetClock will use for its NTP output (and other outputs):
96
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
1. Navigate to MANAGEMENT > OTHER: Time Management:
2. In the System Time panel, click the GEAR icon.
3. In the Edit System Time window, select the System Timescale NetClock will be in:
UTC : The network PCs will receive UTC time via NTP.
TAI: The network PCs will receive TAI time via NTP.
GPS : The network PCs will receive GPS time via NTP.
Note: When the Timescale is set to “GPS”, the GPS to UTC Offset
must be set correctly. As of July 2015, the offset between UTC and
GPS is 17 seconds.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
97
2.16 Configuring NTP
2.16.7 NTP Reference Configuration
NetClock's NTP Service needs to be setup such that it utilizes the time source ("input reference")
you want it to use. There are two options for an NTP Server to derive its time from:
a. The NTP Service uses NetClock's System Time, i.e. typically the GNSS reference (or IRIG,
ASCII data input, etc.), and distributes that time over the NTP network. This is called
Stratum 1 Operation, because NetClock will be the Stratum 1 (or primary) server. This is
the most common configuration.
b. It is, however, also possible for NTP to utilize the time provided by another NTP Server
as a reference. In this case the other server would be Stratum 1, and NetClock would be
Stratum 2 (or higher). This operating mode can be referred to as Stratum 2 operation,
secondary server operation, or NTP Stratum Synchronization.
With a GNSS-capable time server it is possible to combine these two configurations e.g., by
assigning a higher reference priority to (a.), and a lower "fallback" priority to (b.). For more
information on reference priority configuration, see "Configuring Input Reference Priorities" on
page 157.
2.16.7.1 The NTP Stratum Model
The NTP Stratum model is a representation of the hierarchy of time servers in an NTP network,
where the Stratum level (0-15) indicates the device's distance to the reference clock.
Stratum 0 means a device is directly connected to e.g., a GPS antenna. Stratum 0 devices can
not distribute time over a network directly, though, hence they must be linked to a Stratum 1
time server that will distribute time to Stratum 2 servers or clients, and so on. The higher the
Stratum number, the more the timing accuracy and stability degrades.
The NTP protocol does not allow clients to accept time from a Stratum 15 device, hence Stratum
15 is the lowest NTP Stratum.
A group of NTP servers at the same Stratum level (Stratum 2, for example) are considered NTP
Peers to each other. NTP Servers at a higher Stratum level, on the other hand, are referred to
as NTP Servers.
Note: Internet Time Servers should be configured as NTP Servers and not as NTP
Peers.
If NetClock has no valid Timing System Reference, NTP Server or NTP Peers, the NTP Stratum
value is automatically downgraded to Stratum 15 . This ensures that its NTP clients will no
longer use this NetClock unit as a time reference.
2.16.7.2 Configuring "NTP Stratum 1" Operation
When the Timing System references of your NetClock are normally available (rather than
being unavailable most of the time e.g., in areas with poor GNSS reception), it is advisable to
98
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
use the System Time as a reference to NTP, since this provides NTP with the most accurate ref
erences. This mode is called Stratum 1 operation, since NetClock operates as a Stratum 1 NTP
server.
To configure Stratum 1 operation for NetClock:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup:
2. Click the GEAR icon in the NTP Services panel.
3. The Edit NTP Services window will display. Click the Stratum 1 tab.
4. Check all of the three options:
Enable Stratum 1 Operation
Checking this option will cause the NTP Service to use the System Time provided
by the Timing System input.
Prefer Stratum 1
This option configures NTP to “weigh” the Timing System input heavier than input
from other NTP servers for its selection (The Timing System inputs are normally
more accurate than other NTP servers).
However, if the Timing System inputs are not normally available (such as with
intermittent GNSS reception or no other inputs are available), it may be desir
aable NOT to prefer the Timing System over an NTP reference, in which case this
box should not be checked.
Enable Stratum 1 1PPS
This option determines whether or not NTP uses the 1PPS input from the Timing
System. The 1PPS input to NTP needs to correlate with its “Time” input. If the Time
and PPS inputs are originating from the same source, they will be correlated.
However, if the time is originating from another NTP server, but the 1PPS is being
derived by the Timing System, the two inputs may not always correlate. Without
this correlation, NTP performance will be degraded. In such a scenario, it is best
NOT to use the System Time’s 1PPS as a reference.
5. Click the Submit button.
2.16.7.3 Configuring "NTP Stratum Synchronization"
NTP Stratum Synchronization refers to the concept of using a different NTP Server or Peer as
your primary reference (instead of e.g., GNSS). This will make the NetClock you are con
figuring a Stratum 2 server, since the other server is Stratum 1.
To configure Stratum 2 (or greater) operation for NetClock:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup:
2. Click the GEAR icon in the NTP Services panel.
3. The Edit NTP Services window will display. Click the Stratum 1 tab.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
99
2.16 Configuring NTP
4. Check the first of the three options, and uncheck the latter two:
Enable Stratum 1 Operation
When the checkbox Prefer Stratum 1 is unchecked, the input from a different NTP
Server or Peer will normally be used at all times.
Spectracom, however, recommends to check this box, thus allowing the NTP Ser
vice to use NetClock's System Time during Holdover , i.e. if the external NTP ref
erence has become unavailable.
Prefer Stratum 1
Uncheck this option to prevent NetClock's NTP service from “weighing” the Timing
System input heavier than input from other NTP servers. Thus, during normal oper
ation, the time provided by the external Stratum 1 NTP server will be used (unless
its quality is determined to be low).
Note: If enabled, this function would give GPS additional “weight”
for NTP to select the GNSS input over other NTP Servers.
Enable Stratum 1 1PPS
Uncheck this option to prevent NTP from using the 1PPS input from the Timing Sys
tem, but instead use the 1PPS signal from another NTP server. This will ensure the
time signal and the 1PPS signal to correlate, which tends to result in better NTP
performance.
5. Click the Submit button.
2.16.8 NTP Servers and Peers
NetClock can be configured to receive time from one or more available NTP Servers (NetC
locks or different models). This allows for NTP Servers on a timing network to be configured as
potential (fallback) input time references for NetClock System Time synchronization. In the event
that a current reference becomes unavailable, NetClock can fallback to the other NTP Servers
available on the network.
A group of NTP servers at the same Stratum level (Stratum 1 time servers, for example) are con
sidered as NTP Peers to each other.
NTP Servers at a higher Stratum level, on the other hand, are called NTP Servers (Note that Inter
net Time Servers should be configured as NTP Servers and not as NTP Peers).
Note: IMPORTANT: In order for other NTP servers to be a valid reference, you
must enable “NTP” in the Reference Priority table (see "Configuring Input Refer
ence Priorities" on page 157).
For mutual fallback purposes, it is recommended to use one or more NTP Peers. Each peer is
normally configured to operate from one or more time sources including reference clocks or
100
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
other higher stratum servers. If a peer loses all reference clocks or fails, the other peers continue
to provide time to other clients on the network.
NTP Servers at the same Stratum level
If NetClock is configured to obtain time from other NTP Servers at the same Stratum level (i.e.,
NTP Peers) but is currently using a different input reference as its selected reference, NetClock
will report to the network (via the NTP time stamps) that it is a Stratum 1 time server. Should,
however, all input references except the other NTP server(s) become unavailable, NetClock will
then drop to a Stratum 2 time server (with System Time being derived from the NTP time pack
ets being received from the other NTP Peers.
NTP Servers at a higher Stratum level
If NetClock is configured to obtain time from another NTP Server at a higher Stratum level (i.e.,
NTP Servers), and it is using that NTP Server as its selected reference, NetClock will report to
the network (via the NTP time stamps) that it is one less Stratum than its selected reference NTP
Server.
EX A MPLE:
If NetClock is configured to receive time from one or more Stratum 1 NTP Servers, with no other
higher priority input references available, NetClock will report to the network that it is a Stratum 2
Server.
In order for NetClock to use other NTP servers as a valid time reference to synchronize the Sys
tem Time, the input Reference Priority Setup table must be configured to allow NTP as an avail
able reference. For more information on the input Reference Priority table, refer to
"Configuring Input Reference Priorities" on page 157.
Holdover
If NetClock is synchronized to another NTP Server or reference, and that server or reference
subsequently loses sync or becomes unavailable (with no other higher priority input references
being present and valid), NetClock will then go into the Holdover mode. It will remain in Hol
dover mode until any enabled and valid input reference becomes available again, or until the
Holdover period expires, whichever occurs first.
During Holdover mode, NTP will remain at the same Stratum level it was before entering the
Holdover mode and can continue to be the reference to the network. However, if no input ref
erence becomes available before the Holdover period expires, Time Sync will be lost and
shortly thereafter, NTP will report to the network that it is now at Stratum 15. A status of
Stratum 15 will cause the network to ignore NetClock as an NTP time reference.
For more information about Holdover, see "Holdover Mode" on page 190.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
101
2.16 Configuring NTP
2.16.8.1 The NTP Servers and NTP Peers Panels
The NTP Servers and NTP Peers panels display which servers in the network are set up at
higher or equal Stratums (Servers or Peers, respectively), and their configurations. These panels
are also used to add, configure, or remove NTP Servers and Peers.
Note: For information on how to view NTP Clients, see "Viewing NTP Clients" on
page 95.
The NTP Servers and NTP Peers panels are part of the NTP Setup screen (see "The NTP Setup
Screen" on page 91), which can be accessed via MANAGEMENT > NETWORK: NTP Setup.
Information provided in the NTP Servers and NTP Peers panels
The following columns are used to break down the status information for recognized NTP Serv
ers and NTP Peers .
Note: Servers will be displayed in the Status view only if they can be resolved.
They will, however, always be displayed in the Setup view in order to recon
figure them, if necessary.
IP/HOST : Name and real-time status (color-coded)
REF ID: Identifies the type of Input REFerence e.g., GPS indicates the reference can use
GPS for its synchronization. Below is a list of potential REF IDs reported by the NetClock
Timing System (other NTP Servers and Peers may report different references):
GPS : GNSS reference
IRIG: IRIG reference
HVQ : HAVE QUICK reference
FREQ : Frequency reference
PPS : External 1PPS reference
PTP: PTP reference
102
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
ATC : ASCII time code reference
USER: User provided time
LOCL: Local reference (synced to itself)
INIT : NTP on server/peer is initializing
STEP: NTP on server/peer is performing initial synchronization step and restart
ing
AUTH STATUS : Indicates if the selected reference is using MD5 authentication. “None”
indicates authentication not being used.
LAST : The number of seconds that have expired since this reference was last polled for
its time.
POLL: The polling interval, i.e. how often NetClock is polling this NTP reference for its
time.
DELAY (ms): The measured one-way delay between NetClock and its selected reference.
2.16.8.2 NTP Servers: Adding, Configuring, Removing
To add, configure, or remove an NTP Server:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. The NTP Setup screen appears. The NTP Servers panel displays a list of recognized NTP
servers. Click the GEAR icon in the upper right-hand corner of the NTP Servers panel.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
103
2.16 Configuring NTP
3. The NTP Servers window opens. Should the list be empty, no servers have been added
yet. In the event that added servers are not displayed in the NTP Setup screen/NTP Serv
ers panel, they could not be resolved. Verify the IP address. Note that System servers can
not be edited or deleted.
To ADD a new server, click the PLUS icon in the upper right-hand corner, and pro
ceed to the next step.
Note: In order for other NTP Servers to be a valid reference, “NTP”
must be enabled as both the Time and 1PPS references in the Refer
ence Priority table. See "Configuring Input Reference Priorities" on
page 157.
To EDIT an existing server, click the corresponding ACTION GEAR button, and
proceed to the next step.
To REMOVE a server (and its associated configurations), click the X-button next to
it, then confirm by clicking OK.
4. The NTP Server Edit window displays. Enter the required information:
Host: The IP address for the server to be used as host.
Min Poll Interval: Select a value from the drop down (the default is 3 (8s)).
Max Poll Interval: Select a value from the drop down (the default is 3 (8s)).
For both NTP Peers, and NTP Servers the Minimum and Maximum Poll rate for
NTP packets can be configured. Both NTP Peers and NTP Servers support either
manually configured Symmetric Key-ID/Key string pairs or the use of Auto-Key.
However, these choices are mutually exclusive and must be identically configured
on both the NetClock and the NTP Peer or NTP Server. If the Symmetric KeyID/Key string pair method is selected the Key-ID must be first defined on the Sym
metric Key page.
Enable Symmetric Key: Click to enable Symmetric Key, and then select an option
from the drop down menu that displays.
Note: Before you can choose an option in the Key field, you must
first set up symmetric keys through the Actions panel. See "Con
figuring NTP Symmetric Keys" on page 113. Conversely, you may
check the Autokey box below the Key field.
Enable Autokey: Click here if you want to use Autokey with this server. See "NTP
Autokey" on page 107.
104
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Note: When you configure NTP Autokey, you must first disable the
NTP service in the NTP Services panel, and then re-enable it after the
Autokey configuration is completed.
Enable Burst: This tells NTP to send a burst to the remote server when the server is
reachable.
Enable Iburst: This tells NTP to send a burst to the remote server when the server is
not reachable.
Mark as Preferred: Click here to make this server the preferred server. For more
information, see "Configuring "NTP Stratum 1" Operation" on page 98.
Note: It is not normally recommended to select more than one NTP
Server in the NTP Servers table as being Preferred . Typically, only
one NTP server should be selected as Preferred.
5. Click Submit, or press Enter.
2.16.8.3 NTP Peers: Adding, Configuring, Removing
To add, configure, or remove an NTP Peer:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. The NTP Setup screen appears. The NTP Peers panel displays a list of recognized NTP
peers.
Note: Should the list be empty, no servers have been added yet. In the
event that added peers are not displayed, they could not be resolved.
Verify the IP address
To EDIT the settings of an NTP Peer, click the GEAR button next to it, and proceed
to Step 3 below.
To ADD a new NTP Peer, click the PLUS icon in the top right corner of the NTP
Peers panel.
To REMOVE an NTP Peer (and its associated configurations), click the X-button
next to it.
3. The NTP Peers edit window opens:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
105
2.16 Configuring NTP
4. Enter the required information into the fields:
Host: The IP address for the server to be used as host.
Min Poll Interval: Select a value from the drop down (the default is 3 (8s).
Max Poll Interval: Select a value from the drop down (the default is 3 (8s).
For both NTP Peers, and NTP Servers the Minimum and Maximum Poll rate for
NTP packets can be configured. Both NTP Peers and NTP Servers support either
manually configured Symmetric Key-ID/Key string pairs or the use of Auto-Key.
However, these choices are mutually exclusive and must be identically con
figured on both the NetClock and the NTP Peer or NTP Server. If the Symmetric
Key-ID/Key string pair method is selected the Key-ID must be first defined on the
Symmetric Key page.
Enable Symmetric Key: Click the checkbox to enable/disable Symmetric Key. See
also: "Configuring NTP Symmetric Keys" on page 113.
Note: Before you can edit the Key field, you must set up Symmetric
Keys through the Actions Panel. See "NTP: Symmetric Keys (MD5) "
on page 113. Conversely, you may check the Autokey box below
the Key field.
Enable Autokey: Click the check box to enable/disable Autokey. See "NTP
Autokey" on the facing page for more information on Autokey.
106
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Note: When you configure NTP Autokey, you must first disable the
NTP service in the NTP Services panel, then re- enable it after
Autokey configuration is completed.
Mark as Preferred: Check this box to prefer this NTP Peer over other NTP Peers
("NTP Peer Preference"). This will result in NetClock synchronizing more fre
quently with this Peer. For additional information on NTP Preferences, see "Con
figuring "NTP Stratum 1" Operation" on page 98.
Note: Please note that it is not advisable to mark more than one NTP
Peer as Preferred , even though NetClock will not prevent you from
doing so.
5. Click Submit, or press Enter.
2.16.9 NTP Authentication
Since NTP information is distributed across entire networks, NTP poses a security risk: Falsified
NTP time stamps or other NTP-related information can be exploited by an attacker. NTP authen
tication keys are used to authenticate time synchronization, thus detecting a fake time source
before it can do harm.
2.16.9.1 NTP Autokey
Note: Note that, as of spring 2016, NTP Autokey is currently not supported; for
more information, see http://bugs.ntp.org/show_bug.cgi?id=3005.
NTP Autokey: Support & Limitations
Currently, NetClock supports only the IFF (Identify Friend or Foe) Autokey Identity Scheme. The
NetClock product web interface automates the configuration of the IFF using the MD5 digests
and RSA keys and certificates. At this time the configuration of other key types or other digests
is not supported.
Note: When you configure NTP Autokey, you must disable the NTP service first,
and then re-enable it after Autokey configuration is completed.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
107
2.16 Configuring NTP
NTP Autokey: IFF Autokey Support
The IFF Autokey Support is demonstrated in the figure below. The IFF identity scheme is used
with Multiple Stratum NTP Time Servers. The example below shows 3 Stratum layers. Stratum 1
NTP Servers are close to the physical time references. All Stratum 1 servers can be Trusted
Hosts. One of them is the trusted route used to generate the IFF Group/Client Key. This defines
the IFF Group.
All other group members generate Group Certificate and RSA public/private keys using MD5
digest. Each group member must share the common IFF Group/Client Key. Stratum 2 NTP serv
ers are also members of the Group. All NTP Stratum 1 servers are Trusted Hosts. The NTP serv
ers closest to the actual time reference (Stratum 1) should be designated trusted. A single
Stratum 1 NTP server generates the IFF Group/Client Keys. There is NO group name feature
supported. The Group can use the same passphrase (password) or different passphrases for
each client.
An NTP Server Group member is configured by enabling Autokey and creating certificate and
public/private key pair while not enabling the Client Only selection. A Client Only NTP server
is configured by enabling Autokey and creating certificate and public/private key pair and
enabling the Client Only selection.
Note: Passphrases can be identical for all group members and Client NTP Serv
ers. Or passphrases can be the same for group members and a different pass
phrase shared between the Client Only NTP Servers.
108
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Figure 2-2: IFF Autokey configuration example
Configuring NTP Autokey
Note: As of spring 2016, NTP Autokey is currently not supported; for more inform
ation, see http://bugs.ntp.org/show_bug.cgi?id=3005.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
109
2.16 Configuring NTP
Note: When you configure NTP Autokey, you must disable the NTP Service first,
and then re- enable it after Autokey configuration is completed. See "Dis- /En
abling NTP" on page 94.
To configure NTP Autokey:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Services panel, click the GEAR icon in the top-right corner.
3. The Edit NTP Services window will display.
4. Click the Autokey tab.
5. Check the Autokey box.
6. Fill in the Passphrase field by creating a passphrase (for a Trusted server—see Cer
tificate Type below), or by using the existing passphrase of your trusted server (for
Server and Client certificates).
7. Select the Certificate Type for your server, by clicking the appropriate radio button for
Server , Client, or Trusted.
T RUS T ED
S er ver :
Before a server can be designated Client or Server status, one server must be designated as
Trusted. When designating a server as Trusted:
1. Choose the Trusted radio button.
2. Click the Submit button.
A Groupkey is then generated for the network. This Groupkey will be pasted into the Group
key box to designate another server on the network as Client or Server.
110
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
8. To designate a NetClock as Trusted, click the Submit button. This will generate a new
Groupkey.
9. To designate a NetClock as a Client or a Server , paste the generated Groupkey into the
Groupkey box, and click the Submit button.
Configuring a Stratum-1 Server as Trusted Host
To configure an NTP Stratum-1 Server as Trusted Host with IFF Group/Client key:
1. Define the Hostname of all NTP servers before proceeding. See "NTP Servers: Adding,
Configuring, Removing" on page 103.
2. Disable NTP.
Ensure the time is accurate to a few seconds. Use NTP or manually set the clocks to
set the system time.
3. Verify this NetClock is, in fact, NTP Stratum 1, and its Time, and 1PPS synchronization to
GNSS are valid.
4. Under the Autokey tab of the Edit NTP Services window:
Enable Autokey—Check the box.
Autokey Passphrase—Enter your Group members NTP Autokey password.
Select Certificate Type to Generate—Do NOT enable Client.
Select Trusted.
Click Submit.
5. Observe the IFF Group/Client Key appearing.
This is the common IFF Group/Client Key. This key is shared between all Group
members using this NTP Servers passphrase for ALL group members.
6. Configure NTP as requiring authentication.
7. Enable NTP in the NTP Services panel.
8. Verify that NTP reaches occur, and that NTP eventually reaches Stratum 1.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
111
2.16 Configuring NTP
Creating a Stratum-1 Group Member Server
To configure an NTP Stratum-1 Server, which is a Group Member, using a Client key:
1. Define the Hostname, making sure it is not the same as the trusted root server. See "NTP
Servers: Adding, Configuring, Removing" on page 103.
2. Disable NTP if enabled.
3. Manually set the time or use NTP to set the system time.
4. Under the Autokey tab of the Edit NTP Services window, enable:
Enable Autokey—Check the box.
Autokey Passphrase—Enter your Group members NTP Autokey password.
Select Certificate Type to Generate—Do NOT enable Server
5. Using the NTP Server containing the IFF Group/Common Key generate a Client Key
using this NTP Server’s passphrase.
6. Cut and paste the Client Key into the Autokey Groupkey text box.
7. For all NTP Stratum-2 servers and higher stratum numbers, disable the following items
under the Stratum-1 tab in the Edit NTP Services window:
Prefer Stratum 1.
Enable Stratum-1 1PPS.
8. In the NTP Servers panel of the main window, add an NTP server and enable the
Autokey option box. See "NTP Servers: Adding, Configuring, Removing" on page 103.
9. Enable NTP in the NTP Services panel.
10. Wait for NTP to synchronize to the NTP References provided.
Creating a Stratum-1 Client Only Server
To create an NTP Stratum-1 'Client Only' Server with a Client key:
1. Define the Hostname, making sure that it is different from its trusted group server. See
"NTP Servers: Adding, Configuring, Removing" on page 103.
2. Disable NTP if enabled.
3. Manually set the time or use NTP to set the system time.
4. Under the Autokey tab of the Edit NTP Services window, enable:
Enable Autokey—Check the box.
Autokey Passphrase—Enter your Group members NTP Autokey password.
Select Certificate Type to Generate—Select Client to enable Client only.
5. Using the NTP Server containing the IFF Group/Client Key, copy the Group/Client key.
6. Paste this Group/Client key into the Autokey Groupkey text box.
112
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
7. For all NTP Stratum-2 servers and higher stratum numbers, under the Stratum-1 tab in the
Edit NTP Services window configure the NTP Stratum-1 references:
Disable Enable Stratum 1 Operation.
Disable Enable Stratum 1 1PPS.
8. In the NTP Servers panel of the main window, add an NTP server and enable the
Autokey option box. See "NTP Servers: Adding, Configuring, Removing" on page 103.
9. Wait for NTP to synchronize to the NTP References provided.
2.16.9.2 NTP: Symmetric Keys (MD5)
Symmetric Keys are an encryption means that can be used with NTP for authentication pur
poses.
NetClock supports authenticated NTP packets using an MD5 authenticator. This feature does not
encrypt the time packets, but attaches an authenticator, which consists of a key identifier and an
MD5 message digest, to the end of each packet. This can be used to guarantee that NTP pack
ets came from a valid NTP client or server, and that they were not tampered with during trans
mission. The Symmetric Keys tab allows NTP to be configured to use MD5 authentication.
Configuring NTP Symmetric Keys
To create, edit, or delete Symmetric Keys (MD5 Authentication):
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the Actions panel, click the Symmetric Keys button:
3. The NTP Symmetric Keys window will display:
To CREATE a Symmetric Key , click the PLUS icon in the top-right corner, and pro
ceed to Step 4.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
113
2.16 Configuring NTP
To EDIT an existing key pair, click the corresponding Change button, and pro
ceed to Step 4.
To DELETE a key pair, click the corresponding Delete button, and click OK in the
dialog box to confirm and complete the procedure.
4. The NTP Symmetric Key window will display:
Fill in, or edit the fields:
Trusted (checkbox)—Check this box to use MD5 authentication with trusted key ID.
Note: To use the MD5 authentication with trusted key ID, both the
NTP client and the NetClock must contain the same key ID/key string
pair, the client must be set to use one of these MD5 pairs, and the
key must be trusted.
Key ID—The key ID must be a number between 1 and 65532.
Digest Scheme —Choose one of the options from the drop-down list. The avail
able options are:
MD5 (the default)
SHA1
SHA
MDC2
MDC2
RIPEMD160
MD4
Key Str —The key string must be readable ASCII and between 1 and 16 char
acters long.
5. Click the Submit button: The changes will be reflected in the table of the NTP Symmetric
Keys window, which is displayed after clicking the Submit button.
114
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
6. The key(s) you have set up will now appear as options in the Symmetric Key field in
both the NTP Server screen, and the NTP Peer screen.
NOTES:
Duplicate key IDs are not permitted. NTP requests received by that do not contain an authen
ticator containing a valid Key ID and MD5 message digest pair will be responded to, but no
authentication will be performed. An NTP request with valid authenticators results in a valid
NTP response with its own valid authenticator using the same Key ID provided in the NTP
request.
You may define the trusted Symmetric Keys that must be entered on both NetClock, and any net
work client with which NetClock is to communicate. Only those keys for which the “Trusted” box
has been checked will appear in the dropdown menus on the NTP References screen.
2.16.10 NTP Access Restrictions
Next to encrypted authentication by means of Symmetric Keys, NTP supports a list-based means
of access restriction, the use of which is also recommended to prevent fraudulent or inadvertent
CHAPTER 2 • NetClock User Reference Guide Rev. 13
115
2.16 Configuring NTP
manipulation of a time server.
To configure NTP Access Restrictions:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the Actions panel, click Access Restrictions :
3. The NTP Access Restrictions Status window will display:
To ADD or EDIT an access restriction, click the PLUS icon or the Change button,
respectively, and proceed to Step 4. below.
To DELETE an access restriction, click the corresponding Delete button, and con
firm by clicking OK.
4. The NTP Access Restrictions window will display:
116
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Fill in the fields:
Restriction Type—Choose either Allow or Deny.
If you select “Deny”, the configured portion of the network will not have
NTP access to NetClock, but the rest of the network will have access to
NetClock. If you select “allow”, the configured portion of the network will
have NTP access to NetClock, but the rest of the network will not have
access to NetClock. By default, NetClock allows all IPv4 and IPv6 con
nections.
IP Version—Choose IPv4 or IPv6
IP Address —Enter the appropriate hostname.
Subnet Mask —Enter the appropriate IP mask.
Require Authentication (checkbox)—Check this box if you want the addi
tional security of authorized access. NetClock to accept only authenticated
requests (MD5 or Autokey) from this user or network segment.
Allow NTP Queries (checkbox)—Check this box if you want to allow
external NTP queries into NetClock services.
5. Click the Submit button.
2.16.11 Enabling/Disabling NTP Broadcasting
The NTP Broadcast mode is intended for one or a few servers and many clients. NetClock
allows the NTP service to be configured to broadcast the NTP time only to the network’s broad
cast address at scheduled intervals.
NTP Broadcasting is used to limit the NTP service to only certain clients on the network. NTP
Broadcasting also reduces the amount of network traffic, but is therefore less accurate since
there is no compensation for cable delays, or other delays between NTP Server and Client.
Note that NTP Broadcasting is rarely used and typically limited to special applications.
To enable NTP Broadcasting:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
117
2.16 Configuring NTP
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. On the NTP Services panel, click the GEAR icon.
3. The Edit NTP Services window will display. Check the Broadcast box.
4. Select a Broadcast Interval. When NTP Broadcasting is selected, in addition to still
responding to NTP time requests sent from network appliances, NetClock will also send
unsolicited NTP time packets to the local broadcast address at the Broadcast Interval spe
cified by you.
5. To utilize MD5 Authentication, select a Symmetric Key (see "Configuring NTP Symmetric
Keys" on page 113.)
6. Click Submit, or press Enter.
To disable NTP broadcasting, simply uncheck the Broadcast box and click Submit.
2.16.12 NTP over Anycast
NTP (Network Time Protocol) is a packet network based synchronization protocol for syn
chronizing a client clock to a network master clock (see also "Configuring NTP" on page 90.)
Anycast is a network routing protocol in which messages are routed to one of a group of poten
tial receivers via a single Anycast address, thus avoiding the need to configure every client indi
vidually.
NTP over Anycast, as implemented in NetClock, is a combination of the two concepts, allowing
NetClock to:
I. Associate one of its network ports to an Anycast IP address, and
II. Remove itself as an available time source if its reference is lost or degraded, and vice
versa.
To learn more about NTP over Anycast, see also the respective Spectracom Technology Brief
(PDF).
118
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Please note that NetClock utilizes the OSPF (Open Shortest Path First) and BGP (Border Gate
way Protocol).
O S PF
Pr o to c o l
EX A MPLE:
If an active NetClock NTP server has removed itself as an available time source from the Anycast-cap
able network, the OSPF router will send a request for replacement to the next nearest NTP server,
serving under the same NTP over Anycast address.
As soon as the first NetClock server obtains a valid reference again, it will make itself available to
the OSPF router, which will then use it as a time source again, based on the principle of shortest path
available.
Figure 2-3: All NTP Servers are synchronized
Figure 2-4: NTP Server 1 is out of sync
2.16.12.1 Configuring NTP over Anycast (General Settings)
To setup the NTP over Anycast functionality:
1. Confirm that your existing network infrastructure is Anycast capable. Determine network
specifics, such as the Anycast address and port.
2. In the NetClock Web UI, navigate to MANAGEMENT > Network > NTP Setup.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
119
2.16 Configuring NTP
3. In the Actions Panel, click NTP over Anycast.
4. In the NTP Anycast window, select the General tab.
5. On the General tab, select the IP Version you will be running Anycast service for. The
options are IPv4, IPv6, or both.
6. Configure the Anycast Address to be used.
7. Select the port to associate the Anycast service with (depending on the option card con
figuration of your unit, there may be only ETH0 available). If you desire IPv6 func
tionality, you must also select the IPv6 port address since there may be multiple IPv6
addresses on a single port.
8. Click Submit.
Note: IMPORTANT: For Anycast to function, NetClock must be in sync to a valid
reference, or to itself.
2.16.12.2 Configuring NTP over Anycast (OSPF IPv4)
To setup the NTP over Anycast functionality, using OSPF IPv4:
1. Confirm that your existing network infrastructure is Anycast capable, and uses OSPF Ver
sion 2 (IPv4). Determine the OSPF area.
2. In the NetClock Web UI, navigate to MANAGEMENT > Network > NTP Setup.
3. In the Actions Panel, click NTP over Anycast.
4. In the NTP Anycast window, select the General tab.
5. On the General tab, select IPv4 as the IP Version.
6. Configure the Anycast Address to be used.
7. Select the port to associate the Anycast service with (depending on the option card con
figuration of your unit, there may be only ETH0 available).
8. In the NTP Anycast window, navigate to the OSPF tab.
9. On the OSPF tab, check Enable.
10. Setup the OSPF area.
11. Click Submit.
12. Select the port address to associate the Anycast service with (because there may be mul
tiple addresses on a single port), and click Submit. If no addresses appear, an IP
address must be added to the port (see "Network Ports" on page 57).
13. Next, specify the maximum TFOM Setting (Time Figure of Merit), and the Holdover
Timeout value. These two parameters determine NetClock's accuracy "tolerance win
dow": A small window will cause NetClock to deliver a more accurate time window, but
120
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
also will cause it to quickly withdraw from the Anycast server pool, i.e. declare itself an
invalid reference. (For more information about TFOM, see "Configuring the Oscillator"
on page 195.)
Navigate to Management > Disciplining, and click the GEAR icon in the top-right corner
of the Status panel.
14. Set the value Maximum TFOM for Sync to 4 (this will make NetClock to go out of sync if
the phase error is greater than 1μs).
15. Set the value for Holdover Timeout to 10 s, to allow NetClock to exit holdover quickly.
16. Leave the Phase Error Limit at 0, and do not check any of the checkboxes (or, for more
information, see "Configuring the Oscillator" on page 195).
2.16.12.3 Configuring NTP over Anycast (OSPF IPv6)
To setup the NTP over Anycast functionality, using OSPF IPv6:
1. Confirm that your existing network infrastructure is Anycast capable, and uses OSPF Ver
sion 3 (IPv6). Determine the OSPF area.
2. In the NetClock Web UI, navigate to MANAGEMENT > Network > NTP Setup.
3. In the Actions Panel, click NTP over Anycast.
4. In the NTP Anycast window, select the General tab.
5. On the General tab, select IPv6 as the IP Version.
6. Select the port to associate the Anycast service with (depending on the option card con
figuration of your unit, there may be only ETH0 available).
7. Select the port address to associate the Anycast service with (because there may be mul
tiple IPv6 addresses on a single port), and click Submit. If no addresses appear, an IPv6
address must be added to the port.
8. In the NTP Anycast window, navigate to the OSPF tab.
9. On the OSPF6 tab, check Enable.
10. Setup the OSPF6 area.
11. Click Submit.
12. Select the port address to associate the Anycast service with (because there may be mul
tiple addresses on a single port), and click Submit. If no addresses appear, an IP
address must be added to the port (see "Network Ports" on page 57).
13. Next, specify the maximum TFOM Setting (Time Figure of Merit), and the Holdover
Timeout value. These two parameters determine NetClock's accuracy "tolerance win
dow": A small window will cause NetClock to deliver a more accurate time window, but
also will cause it to quickly withdraw from the Anycast server pool, i.e. declare itself an
invalid reference. (For more information about TFOM, see "Configuring the Oscillator"
on page 195.)
CHAPTER 2 • NetClock User Reference Guide Rev. 13
121
2.16 Configuring NTP
Navigate to Management > Disciplining, and click the GEAR icon in the top-right corner
of the Status panel.
14. Set the value Maximum TFOM for Sync to 4 (this will make NetClock to go out of sync if
the phase error is greater than 1μs).
15. Set the value for Holdover Timeout to 10 s, to allow NetClock to exit holdover quickly.
16. Leave the Phase Error Limit at 0, and do not check any of the checkboxes (or, for more
information, see "Configuring the Oscillator" on page 195).
2.16.12.4 Configuring NTP over Anycast (BGP)
To configure NTP over Anycast, using BGP (Border Gateway Protocol):
1. Confirm that your existing network infrastructure is Anycast capable, and uses BGP.
Determine the network specifics, such as your Autonomous System (AS) number, Neigh
bor’s address and Neighbor’s AS number.
2. In the NetClock Web UI, navigate to MANAGEMENT > Network > NTP Setup.
3. In the Actions Panel, click NTP over Anycast.
4. In the NTP Anycast window, select the General tab.
5. On the General tab, select your desired IP Version. This selection automatically com
municates with the BGP tab and displays the neighbor address field based on your
needs.
6. Select the port to associate the Anycast service with (depending on the option card con
figuration of your unit, there may be only ETH0 available). If you desire IPv6 func
tionality, you must also select the IPv6 port address since there may be multiple IPv6
addresses on a single port.
7. In the NTP Anycast window, navigate to the BGP tab.
8. On the BGP tab, check Enable.
9. Input your AS number .
10. Input the neighbor's address.
11. Input the neighbor's AS number.
12. Click Submit.
13. Select the port address to associate the Anycast service with (because there may be mul
tiple addresses on a single port), and click Submit. If no addresses appear, an IP
address must be added to the port (see "Network Ports" on page 57).
14. Next, specify the maximum TFOM Setting (Time Figure of Merit), and the Holdover
Timeout value. These two parameters determine NetClock's accuracy "tolerance win
dow": A small window will cause NetClock to deliver a more accurate time window, but
also will cause it to quickly withdraw from the Anycast server pool, i.e. declare itself an
invalid reference. (For more information about TFOM, see "Configuring the Oscillator"
122
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
on page 195.)
Navigate to Management > Disciplining, and click the GEAR icon in the top-right corner
of the Status panel.
15. Set the value Maximum TFOM for Sync to 4 (this will make NetClock to go out of sync if
the phase error is greater than 1μs).
16. Set the value for Holdover Timeout to 10 s, to allow NetClock to exit holdover quickly.
17. Leave the Phase Error Limit at 0, and do not check any of the checkboxes (or, for more
information, see "Configuring the Oscillator" on page 195).
2.16.12.5 Configuring Anycast via NTP Expert Mode
Advanced Anycast configuration is possible via the NTP Expert Mode (see also "NTP Expert
Mode" on page 128), which allows you to write directly into the Anycast configuration files
(zebra.conf; ospfd.conf; ospf6d.conf and bgpd.conf).
The zebra.conf file is required for both IPv4, and IPv6 Anycast. The ospfd.conf file is
required for IPv4 OSPF only, the ospf6d.conf file is required for IPv6 OSPF only, and the
bgpd.conf file has multiprotocol functionality, hence it can be used for both IPv4, and IPv6
Anycast.
Caution: Expert Mode should only be utilized by advanced users, as incorrectly
altering the Anycast files can cause Anycast to stop working.
Caution: Any configurations made in Expert Mode will be lost as soon as Expert
Mode is disabled.
1. To access Expert Mode, navigate to MANAGEMENT > NTP Setup.
2. Enable the switch for Expert Mode in the panel NTP Services .
3. Once it is enabled, click NTP Anycast in the Actions Panel. The Expert mode window
will appear, with a separate tab for each of the three configuration files.
4. To enable OSPF IPv4 Anycast, check Enable under the OSPF tab. To enable OSPF IPv6
Anycast, check Enable under the OSPF6 tab. To enable BGP Anycast, check Enable
under the BGP tab. Then click Submit.
When the NTP Anycast Expert Mode window is opened, the files displayed are the con
figuration files in their current states. If no configuration was done outside of Expert Mode,
these will be the factory default files. If Anycast configuration was already done from the Web
UI, you will be able to edit the existing Anycast setup.
When editing zebra.conf in expert mode, you should ensure that the first line under an
interface line is an ip address line declaring an IPv4 address (if there is one for the
CHAPTER 2 • NetClock User Reference Guide Rev. 13
123
2.16 Configuring NTP
interface), and that the next line is an ipv6 address line declaring an IPv6 address (if there
is one for the interface). No other lines or variations in spacing should be inserted before or
between these lines. No editing restrictions exist on ospfd.conf or ospf6d.conf files.
Example zebra.conf file with both IPv4, and IPv6 configured on the same port:
(Interface eth0 line, followed by IPv4 line and then IPv6 line)
*****************************************************
!
interface eth0
ip address 10.2.100.157/16
ipv6 address 2000:10:2::157/64
!
interface lo
ip address 10.10.14.1/32
ipv6 address 2000:10:10::1/64
*****************************************************
Example zebra.conf file with IPv4, and IPv6 configured on different ports:
(Interface eth0 line, followed by only IPv4 line, because no IPv6 address is configured on that
port. Interface eth1 line, followed by only IPv6 line, because no IPv4 address is configured on
that port)
*****************************************************
!
interface eth0
ip address 10.2.100.157/16
interface eth1
ipv6 address 2000:10:2::157/64
!
interface lo
ip address 10.10.14.1/32
ipv6 address 2000:10:10::1/64
*****************************************************
Example zebra.conf file showing the default file with no addresses configured:
(Interface eth0 line, with no lines following it because no addresses are configured on the port)
*****************************************************
!
interface eth0
124
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
!
interface lo
*****************************************************
Example ospfd.conf file:
*****************************************************!
router ospf
ospf router-id 10.2.100.157
network 10.2.0.0/16 area 0.0.0.0
redistribute connected
distribute-list default out connected
!
access-list default permit 10.10.14.1/32
access-list default deny any
*****************************************************
Example ospf6d.conf file:
*****************************************************
!
interface eth0
!
router ospf6
router-id 10.2.100.157
interface eth0 area 0.0.0.0
redistribute connected
!
*****************************************************
Example bgpd.conf file:
*****************************************************!
router bgp 12
bgp router-id 172.17.1.12
network 172.17.0.0/16
neighbor 172.17.1.1 remote-as 3
!
redistribute connected
*****************************************************
CHAPTER 2 • NetClock User Reference Guide Rev. 13
125
2.16 Configuring NTP
2.16.12.6 Testing NTP over Anycast
Note: A detailed Anycast test procedure is available from Spectracom upon
request. Please contact techpubs@spectracom.com.
2.16.13 NTP Orphan Mode
The NTP Orphan Mode allows NetClock to remain a valid time server to its NTP clients even if
all its input references have become invalid and the Holdover period has expired.
Per default, NetClock will automatically downgrade itself to NTP Stratum 15 , should its input
references become invalid and after expiration of the Holdover period. By setting the NTP
Orphan Mode to an NTP Stratum level other than 15, NetClock will continue to be considered
a valid time server by its NTP clients.
Note, however, that the time served by NetClock after expiration of the Holdover period can
be of a low quality and therefore normally ought to be considered invalid. NTP Orphan Mode
exists as an option for timing networks that must stay intact even if the time distributed is invalid.
The other use case for Orphan Mode is to allow for NTP to be utilized in an isolated timing net
work that is designed to normally operate without any external references.
To configure NTP Orphan Mode:
1. Navigate to MANAGEMENT > NTP Setup.
2. In the NTP Services panel, click the GEAR icon in the top right corner. The Edit NTP Ser
vices window will open:
3. Click the Orphan Mode tab, and select an NTP Stratum other than 15. This will be the
Stratum level NetClock will transition to in the event its input references become invalid.
4. Click Submit. NetClock will automatically stop and re-start the NTP Service.
126
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Note: Per NTP protocol definition, for an NTP Orphan Mode Timing Network to
operate properly, ALL servers and clients must be set to the same Stratum level
(e.g., "5").
2.16.14 Host Disciplining
Host Disciplining allows an NTP input reference to discipline NetClock's oscillator. This may be
utilized e.g., with NetClock units that do not have a GPS receiver because they are operated
as Stratum 2 servers.
In general, it is advisable to enable Host Disciplining only if needed, and to use it only in
robust networks/NTP environments.
Note that Host Disciplining is NOT supported by NetClock units equipped with a Rubidium
oscillator.
ON: When Host Disciplining is ON, the NTP reference is used to discipline NetClock's
oscillator, thus providing more stable oscillator performance.
About system software updates:
When updating to System Software Version 5.4.5, Host Disciplining will fall to its
default setting. When updating to future System Software versions, the last setting will be
carried over to the new software.
In any case, after a system software update it is advisable to verify that Host Disciplining
is still enabled.
OFF [default setting]: When OFF, NTP synchronization is not disciplining the oscillator,
only a time transfer is made in regular intervals to manually correct the system time.
While disabled Host Disciplining does not offer the benefit of a disciplined oscillator
when transitioning into or out of holdover, NetClock on the other hand will not be sus
ceptible to disciplining errors caused by network traffic or NTP-related issues.
2.16.14.1 Enabling Host Disciplining
In order for Host Disciplining to work, you must have enabled NTP, and you must have con
figured an NTP Peer or Server, i.e. NetClock is running as an NTP Stratum 2 server.
To enable Host Disciplining:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Services panel, click the GEAR icon. The Edit NTP Services window will dis
play:
CHAPTER 2 • NetClock User Reference Guide Rev. 13
127
2.16 Configuring NTP
3. Under the Stratum 1 tab:
enable Stratum 1 Operation (this allows System holdover if GPS and the NTP serv
ers happen to become unavailable for a period of time)
disable Prefer Stratum 1
disable Stratum 1 1PPS , and click Submit.
(The NTP Status Summary panel in the NTP Setup screen should now display Stratum 2.
For additional information, see "Configuring "NTP Stratum Synchronization"" on
page 99.)
4. Under the Host Ref tab, enable Host Disciplining, and click Submit. You do NOT have
to stop and re-start the NTP Service; NetClock will do this for you.
2.16.15 NTP Expert Mode
Advanced NTP configuration is possible via the NTP Expert Mode, which allows you to write dir
ectly into the NTP.conf file (the syntax is similar to the one used with CISCO routers).
Caution: NTP Expert Mode should only be utilized by advanced users, as incor
rectly altering the NTP.conf file can cause NTP to stop working (if NTP is con
figured as an input reference, NetClock could lose synchronization).
To access the NTP Expert Mode, navigate to MANAGEMENT > NTP Setup . The switch for the
NTP Expert Mode is in the panel NTP Services .
Caution: Any configurations made in NTP Expert Mode will be lost as soon as
NTP Expert Mode is disabled.
NTP utilizes the NTP.conf file for its configuration. Normally, configuration of this file is
indirectly performed by a user via the integrated configuration pages of the NetClock Web UI.
However, it may be desired in certain circumstances to edit this file directly, instead of using
the web-based setup screens. When Expert Mode is enabled, the user has direct access to the
NTP.conf file.
128
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
Caution: Spectracom Tech Support does not support the editing of the NTP con
figuration files while in the Expert Mode. For additional information on editing
the NTP.conf file, please refer to http://www.ntp.org/.
Note: IMPORTANT: If an undesirable change is made to the NTP.conf file that
affects the NTP operation, the NTP.conf file can be manually changed back as
long as the previous configuration was known.
The NTP.conf file can be reset back to the factory default values by either
using the procedure to restore all of the NetClock factory default settings (see
"Restoring the Default NTP Configuration" on page 95) or editing the file back to
the original configuration as shown in the factory default configuration below.
Caution: If changes are made to the NTP.conf file while in the Expert mode,
Expert mode should remain enabled from that point forward. Disabling Expert
mode after changes being made to this file may result in loss of this configuration
information.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
129
2.16 Configuring NTP
Factory default NTP.conf file:
restrict 127.0.0.1
restrict ::1
restrict default noquery nomodify
restrict -6 default noquery nomodify
keys /etc/ntp/keys/ntp.keys
controlkey 65533
requestkey 65534
trustedkey 65533 65534
server 127.127.45.0 prefer minpoll 4
server 127.127.22.0 minpoll 4
fudge 127.127.22.0 stratum 0
peer 10.10.128.35 minpoll 3 maxpoll 3 autokey
keysdir /etc/ntp/keys/
crypto pw admin123 randfile /dev/urandom
driftfile /etc/ntp/ntp.drift
logfile /home/spectracom/log/ntp.log
statsdir /home/spectracom/log/ntpstats/
statistics loopstats peerstats clockstats
filegen loopstats file loopstats type day enable
filegen peerstats file peerstats type day enable
filegen clockstats file clockstats type day enable
Prior to Expert mode being enabled, the Network: NTP Setup page will contain various tabs
for configuring different options of the NTP Service. To prevent inadvertent changes from being
made to a user-edited NTP.conf file via the web pages, these NTP configuration tabs are
removed from the web browser view as long as the Expert mode remains enabled (only the
Expert Mode tab is visible in Expert Mode; all other tabs will no longer be present). Disabling
the Expert mode restores these tabs to the Edit NTP Services window.
To enable the Expert Mode, and edit the NTP.conf file:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Services panel locate the Expert Mode switch:
130
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.16 Configuring NTP
When enabled, the NTP Service operates in Unicast mode. In Unicast mode, the NTP Ser
vice responds to NTP requests only. The NTP Service supports a broadcast mode in
which it sends a NTP time packet to the network broadcast address.
3. Click the Expert Mode switch.
4. Confirm by clicking OK in the dialog box.
5. Click the GEAR icon.
6. In the Edit NTP Services window, edit the file as desired in the text box under the Expert
Mode tab.
7. Click the Submit button to save any changes that were made.
8. Disable and then re-enable the NTP service using the NTP ON/OFF switch in the NTP
Services panel. NetClock will now use the new NTP configuration per the manually
edited file.
Caution: Any configurations made in NTP Expert Mode will be lost as soon as
NTP Expert Mode is disabled.
2.16.16 Spectracom Technical Support for NTP
Spectracom does not provide technical assistance for configuring and installing NTP on Unixbased applications. Please refer to www.ntp.org for NTP information and FAQs. Another help
ful source is the Internet newsgroup at news://comp.protocols.time.ntp.
Spectracom can provide support for Microsoft ® Windows-based time synchronization. See
spectracom.com for additional information, or contact Spectracom Technical Support.
Spectracom also offers an alternate Windows NTP client software package called PresenTense.
PresenTense software provides many features and capabilities not included with the limited
functionality of the Windows W32Time program, including alert notification and audit trails
for the PC’s time.
For more information on PresenTense, please visit spectracom.com or contact your local Spec
tracom Sales Representative.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
131
2.17 Configuring Input References
2.17
Configuring Input References
Depending on the type of input reference, some of its settings may be user-editable. To access
these settings for a given input reference, choose one of the two methods described below.
Note: The illustrations shown below are examples. The windows displayed in
your Web UI may look differently.
There are two ways to access the settings Status window for an input reference:
Configuring input reference settings, method 1:
1. Under INTERFACES > REFERENCES , click the desired reference.
2. The Status window for the specific reference you selected will be displayed. Click the Edit but
ton in the bottom-left corner.
3. The settings window for the chosen reference will be displayed. Edit the field(s) as desired.
Configuring input reference settings, method 2:
1. In the INTERFACES > REFERENCES drop-down menu, click REFERENCES (white on orange), or
an input reference category ("GNSS reference", for example).
2. In the Status window, click the GEAR button next to the desired input reference.
3. The settings window for the chosen reference will be displayed. Edit the field(s) as desired.
2.18
Configuring Outputs
Depending on the type of output interface, some of its settings may be user-editable. To access
these settings for a given output, choose one of the two methods described below.
Note: The illustrations shown below are examples. The windows displayed in
your Web UI may look differently.
Editing output settings, method 1:
1. Under INTERFACES: OUTPUTS , click the desired output.
2. The Status window for the specific reference you selected will be displayed. Click the
Edit button in the bottom-left corner.
132
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.18 Configuring Outputs
3. The settings window for the chosen output will be displayed. Edit the field(s) as desired.
Editing output settings, method 2:
1. In the INTERFACES: OUTPUTS drop-down menu, click OUTPUTS, or one of the output
categories (not indented to the right)
2. In the Status window, click the GEAR button next to the desired output.
3. The settings window for the chosen output will be displayed. Edit the field(s) as desired.
2.18.1 The Outputs Screen
NetClock outputs deliver a time or frequency signal to a device that consumes this signal.
To access the Outputs screen in the Web UI:
1. Navigate to INTERFACES and click on OUTPUTS (white on orange).
2. The Outputs screen will display.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
133
2.18 Configuring Outputs
While System Status and logged Events are displayed on the left, the Outputs panel on
the right lists all the outputs detected.
If you hover with your mouse pointer over any of the connectors shown in the
rear panel illustration, a tooltip will be displayed, indicating the type of output..
If you have only one output of any type, NetClock will number that output 0. Addi
tional outputs will be numbered 1 or above.
If you click the INFO button next to an output, a Status window will open.
If you click the GEAR button next to an output, the Configuration window will
open.
2.18.2 The 1PPS and 10 MHz Outputs
Note: NetClock 9489 only has a 1PPS output; therefore, information pertaining
to the 10 MHz output only applies to NetClock 9483.
The NetClock 9483 includes one 1PPS output and one 10 MHz output. To configure these out
puts, navigate to:
INTERFACES > OUTPUTS
and select the 1PPS Output or 10 MHz Output you would like to see, or configure.
NetClock’s 1PPS output is generated from the oscillator’s 10 MHz output and is aligned to the
on-time point. The on-time point of the 1PPS output can be configured to be either the rising or
falling edge of the 1PPS signal (by default, the rising edge is the on-time point).
There is a fixed phase relationship between the 1PPS and the 10 MHz outputs, as described
below:
NetClock equipped with TCXO/OCXO/Low-Phase-Noise Rubidium oscillator : With
oscillator disciplining active (one or more 1PPS references available and valid) and
after the on-time point has been initially slewed into alignment with the selected ref
erence, there will always be exactly 10 million counts of the oscillator between each
1PPS output, even while in the Holdover mode (= input references are currently unavail
able) and even after input references have become available again.
NetClock equipped with Rubidium (Rb) oscillator : With oscillator disciplining active
(one or more 1PPS references available and valid), after the on-time point has been
slewed into alignment with the selected reference, with the exception of 1PPS input ref
erence changes occurring, there will always be exactly 10 million oscillator counts
between each PPS output pulse.
With the Rubidium oscillator installed, when a 1PPS input reference change occurs (such
as switching from IRIG input to GNSS input, or switching from a reference being valid to
no reference being present or valid—known as the Holdover mode), the oscillator counts
between two 1PPS outputs may momentarily not be exactly 10 million counts. Once the
134
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.18 Configuring Outputs
reference transition has occurred, however, the counts between each PPS output pulse
will return to exactly 10 million counts.
Like other types of NetClock's signal outputs, a 1PPS output can be configured in several ways:
Signature Control allows you to determine under which conditions an output signal shall
be present, i.e. what NetClock will do about a given output when an external reference
is lost. See also "Signature Control" on the next page.
The on-time point of the 1PPS signal: rising or falling edge
The pulse width
An offset can be entered to account for cable delays or other latencies.
2.18.2.1 Configuring a 1PPS Output
To configure a 1PPS output:
1. Navigate to INTERFACES > OUTPUTS ., or to INTERFACES > OPTION CARDS (white on
orange).
2. In the panel on the right, click the GEAR button next to the 1PPS Output you want to edit.
3. The 1PPS Output Edit window will display, allowing the following items to be configured:
Signature Control : Determines when the output is enabled. For more information, see
"Signature Control" on the next page.
Offset [ns]: Allows to offset the system's 1PPS on-time point, e.g. to compensate for
cable delays and other latencies [range = –500000000 to 500000000 ns = ±0.5 s]
Edge: Used to determine if the on-time point of the 1PPS output is the rising or the fall
ing edge of the signal.
Rising
Falling
Pulse Width [ns]: Configures the Pulse Width of the 1PPS output.
[range = 20 to 900000000 ns = 0.0 μs to 0.9 s]
[default = 200 ms]
CHAPTER 2 • NetClock User Reference Guide Rev. 13
135
2.18 Configuring Outputs
4. Click Submit.
2.18.2.2 Configuring the 10 MHz Output (NetClock 9483 Only)
To configure a10 MHz output:
1. Navigate to INTERFACES > OUTPUTS , or to INTERFACES > OPTION CARDS (white on
orange).
2. In the panel on the right, click the GEAR button next to the 10 MHz output that you want to
edit.
3. The 10 MHz edit window will display. Choose a value from the Signature Control field
drop-down list to determine what NetClock shall do with the output signal in the event its
input reference is lost. For more information, see "Signature Control" below.
4. Click Submit.
2.18.3 Configuring Optional Outputs
Next to the standard outputs, optional outputs e.g., ASCII or IRIG, are available through
Option Modules.
The functionality and configuration of these options are documented under "Option Modules"
on page 319.
2.18.4 Network Ports
The Network Ports can be configured under MANAGEMENT > Network Setup . For more
information, see "Configuring Network Settings" on page 55.
2.18.5 Signature Control
Signature Control is a user-set parameter that controls when a NetClock output (for example,
1PPS) will be present. This feature allows you to determine how closely you want to link an out
put to its input. This not only allows you to determine the quality of your output signal (e.g., by
deactivating it, when the holdover period expires), but also offers the capability to indirectly
send an input-reference-lost-alarm to a downstream recipient via the presence of the signal.
136
CHAPTER 2 • NetClock User Reference Guide Rev. 13
2.18 Configuring Outputs
EX A MPLES :
You can setup Signature Control such that NetClock's built in 1PPS output becomes disabled the
moment its input reference is lost (e.g., if a valid GNSS signal is lost).
Or, you can setup your output signal such that remains valid while NetClock in holdover mode, but
not in free run.
The available options are:
I. Output Always Enabled—The output is present, even if NetClock is not synchronized to
its references (NetClock is free running).
II. Output Enabled in Holdover —The output is present unless NetClock is not synchronized
to its references (NetClock is in Holdover mode).
III. Output Disabled in Holdover —The 1PPS output is present unless the NetClock references
are considered not qualified and invalid (the output is NOT present while NetClock is in
Holdover mode.)
IV. Output Always Disabled—The output is never present, even if NetClock references are
present and valid.
Table 2-8: Signature control output-presence states
Ref.
Out-of-sync,
no holdover
In holdover
In-sync with
external reference
I.
II.
III.
IV.
2.18.5.1 Configuring Signature Control for an Output
To review or configure the Signature Control setting for any Output:
1. Navigate to INTERFACES > OUTPUTS and click the Output you want to configure or
review.
CHAPTER 2 • NetClock User Reference Guide Rev. 13
137
2.18 Configuring Outputs
2. In the Output panel, click the GEAR button for the desired Output. A window will open
with the current Signature Control setting, and a drop-down list to change it.
To learn more about the different settings, see the previous topic "Signature Control" on
page 136.
138
CHAPTER 2 • NetClock User Reference Guide Rev. 13
CHAPTER 3
MANAGING TIME
In this document, the notion of Managing Time refers not only to the
concept of NetClock's System Time, but also to reference con
figuration, as well as distribution of time and frequency.
The following topics are included in this Chapter:
3.1 The Time Management Screen
140
3.2 System Time
141
3.3 Managing References
155
3.4 Holdover Mode
190
3.5 Managing the Oscillator
194
CHAPTER 3 • NetClock User Reference Guide
139
3.1 The Time Management Screen
3.1
The Time Management Screen
The Time Management screen is the point of entry for all System Time -related settings that are
user-configurable.
To access the Time Management screen:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. The Time Management screen opens. It is divided into 4 panels:
System Time panel
The System Time panel displays the time scale and the year, and allows access to the Edit Sys
tem Time window via the GEAR icon in the top-right corner. This window is used to select the
time scale, and to manually set a user- time, if so required.
See "System Time" on page 142.
Offsets panel
The Timescales UTC , TAI , and the GPS -supplied time are offset by several seconds, e.g. to
accommodate leap seconds. The GPS offset may change over time, and can be managed via
the GEAR icon in the top-right corner of this panel.
See .
Leap Second Info panel
From time to time, a leap second is applied to UTC, in order to adjust UTC to the actual pos
ition of the sun. Via the Leap Second Info panel, leap second corrections can be applied to
140
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
NetClock’s time keeping. It is also possible to enter the exact day and time when the leap
second is to be applied, and to delete a leap second.
See also: "Leap Seconds" on page 149
Local Clocks panel
You can create multiple different Local Clocks, as needed. The names of all Local Clocks that
have already been created are displayed in the Local Clocks panel.
See also "Local Clock(s), DST" on page 152.
3.2
System Time
The time that NetClock maintains is referred to as the System Time . The System Time is used to
supply time to all of the available time-of-day outputs (such as the front panel LED display, NTP
time stamps, time stamps in the log entries, ASCII data outputs, etc.)
By default, the System Time is synchronized to NetClock’s input references (such as GNSS,
IRIG, ASCII data, NTP, PTP, etc.).
If a UTC-based time is not required, however, it is also possible to manually set the System Time
to a desired time/date, or to use the unit's battery backed time (Real Time Clock) as System
Time (with an external 1PPS reference).
The flow chart below illustrates how NetClock obtains the highest available and valid ref
erence, depending on whether an external source is chosen as reference, or an internal ( User
[x], or Local System ).
Figure 3-1: How the System Time is derived
CHAPTER 3 • NetClock User Reference Guide Rev. 13
141
3.2 System Time
Note: User hand-set times can only be set in UTC (not Local time).
3.2.1
System Time
Several System Time parameters can be customized:
The System Timescale can be changed.
A user-defined time can be setup for e.g., for simulation purposes, or if no external ref
erence is available.
The battery-backed RTC time can be used as System Time, until an external reference
become available.
3.2.1.1
Configuring the System Time
To configure the System Time:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. In the System Time panel located in the top-left corner of the Time Management screen,
click the GEAR icon.
3. The Edit System Time pop-up window will display.
In the System Timescale field select a timescale from the drop-down list. The
options are:
UTC : Coordinated Universal Time (Temps Universel Coordonné); your
local time zone determines the difference between UTC and local time.
142
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
Note that UTC is not a time zone, but a time standard, i.e. it is not used
anywhere in the world as the official local time, whereas GMT (Greenwich
Mean Time) is a time zone that is used in several European and African
countries as the official local time.
TAI: International Atomic Time (Temps Atomique International)
The TAI time scale is based on the SI second and is not adjusted for leap
seconds. As of October 2017, TAI is ahead of UTC by 36 seconds. TAI is
always ahead of GPS by 19 seconds.
GPS : The Global Positioning System time is the timescale maintained by
the GPS satellites.
Global Positioning System time is the time scale maintained by the GPS
satellites. The time signal is provided by atomic clocks in the GPS ground
control stations. The UTC–GPS offset as of October 2017 is 17 seconds.
For more information on Timescales, see "Timescales" below.
4. If you want to override the system time with a manually set User Time, check the Manual
Time Set checkbox. For information, see "Manually Setting the Time" on the next page.
5. Click Submit to update the System Time and close the window.
3.2.1.2
Timescales
The System Time can be configured to operate in one of several timescales , such as UTC, GPS
and TAI (Temps Atomique International) . These timescales are based on international time
standards, and are offset from each other by varying numbers of seconds.
When configuring NetClock, in most cases, UTC will be the desired timescale to select.
Note: UTC timescale is also referred to as “ZULU” time. GPS timescale is the raw
GPS time as transmitted by the GNSS satellites (in 2017 the GPS time is currently
17 seconds ahead of UTC time. UTC timescale observes leap seconds while GPS
timescale does not).
Note: The TAI timescale also does not observe leap seconds. The TAI timescale is
fixed to always be 19 seconds ahead of GPS time. As of October, 2017 TAI time
is 36 seconds ahead of UTC.
NetClock's System timescale is configured via the MANAGEMENT > OTHER: Time Man
agement screen, see "System Time" on the previous page.
Input timescales
CHAPTER 3 • NetClock User Reference Guide Rev. 13
143
3.2 System Time
Some of the inputs may not necessarily provide time to NetClock in the same timescale selected
in the System Time’s timescale field. These inputs have internal conversions that allow the times
cale for the inputs to also be independently defined, so that they don’t have to be provided in
the same timescale. For example, the System timescale can be configured as “UTC”, but the IRIG
input data stream can provide NetClock with “local” time, with no time jumps occurring when
the reference is selected.
If an output reference is using the GPS or TAI timescale, and the System Time is set to “UTC”,
then the GPS Offset box in the Edit GPS Offset window must be populated with the proper
timescale offset value in order for the time on the output reference to be correct. Some ref
erences (like GNSS) provide the timescale offset to the system. In the event that the input ref
erence being used does not provide this information, it must be set in through the Offsets panel
of the Time Management page.
Since the GPS and TAI offsets have a fixed relationship, only the GPS offset can be set. If only
the TAI offset is known, subtract 19 from it to get the GPS offset.
Note: If the System Time is set to the UTC timescale, and all output references
either use the UTC or “local” timescale, then it is not necessary to set the GPS and
TAI timescale Offsets.
Caution: It is imperative to configure any input reference’s timescales appro
priately. Otherwise, a System Time error may occur!
Output timescales
Some of the available NetClock outputs (such as the front panel LED display, the IRIG option
module’s outputs, ASCII data module’s outputs, etc.) won’t necessarily output in the same times
cale selected in the System Time’s timescale field. These outputs have internal conversions that
allow the timescale for the outputs to also be independently defined, so that they don’t have to
be provided in the same timescale. For example, the System timescale can be configured as
“UTC”, but the front panel LED display can be configured to still show “local” time, if desired.
Other NetClock outputs will be provided in the same timescale that is selected in the System
timescale field. The NTP output for network synchronization and the time stamps included in all
log entries will be in the same timescale as the configured System timescale. For example, if
“GPS” is selected as the System timescale, the log entries and the time distributed to the network
will all be in GPS time (time broadcasted directly from the GNSS constellation). But, the LED dis
play can still be configured to show the current “local” time.
3.2.1.3
Manually Setting the Time
For some applications, it may not be necessary to synchronize NetClock to a UTC-based ref
erence. Or, a GPS reference is not available yet (e.g., because the antenna is not yet installed),
144
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
but the system has to be setup and tested.
In such cases, the System Time can be hand-set, and then used as a User [x]-set System Time. For
more information on when to use this functionality, see "The "User/User" Reference" on
page 161.
Note: TIP: If synchronization to UTC is NOT required, it is advisable to set a time
in the past or future, so as to avoid users inadvertently considering the distributed
time to be genuine.
Caution: Note that this mode of operation is intended for special use cases e.g.,
autonomous systems, where legally traceable time is not required: This time will
be inaccurate/not traceable, since it is not tied to any reference.
To hand-set the System Time, and configure this time to be a valid reference:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. In the System Time panel on the left, click the GEAR icon.
3. Select Manual Time Set. Set your time & date, as needed:
System Time [DATE; TIME]: If you do not select Set Year Only, this box will show
the current time in the format: Year-Month-Day Hour:Minute:Second.
To set the time manually, click anywhere in the System Time field. A drop-down
calendar with time-setting sliders will appear:
The time in the System Time field will default to the current date and time. To set
the time, use the sliders. The time will display between the calendar and the
sliders, and also next to the chosen date in the field directly above the calendar.
To close the calendar, click anywhere in the Edit System Time window.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
145
3.2 System Time
NOTE: Except for testing purposes, you should not choose a date other than the
current day.
Set Year Only: Some legacy time formats (e.g., IRIG) do not support years. Check
ing this box will open a data entry field to manually set the year. Spectracom
recommends not to utilize this feature, unless the IRIG format you are using does
not provide a YEAR field.
Synchronize to Battery Backed Time on Startup: See "Using Battery Backed Time
on Startup" below.
4. Click Submit at the precise moment desired.
5. Navigate to MANAGEMENT > OTHER: Reference Priority.
6. In order for the User time to be a considered a valid reference, verify that the Reference
Priority table includes an "Enabled" User [x] Time, and 1PPS reference ("User/User ").
For more information, see "Input Reference Priorities" on page 155 and "The "User
/User" Reference" on page 161.
7. Move (drag & drop) the User time to the top of table, and disable all other references.
8. Let Holdover expire. (Set it to a very short duration, if desired:
i. Navigate to MANGAGEMENT > OTHER: Disciplining.
ii. In the Status panel, click the GEAR icon.
iii. In the Oscillator Settings window, set the Holdover Timeout.)
9. Check on the HOME screen that User 0 is displayed, with a green STATUS. Note that the
Disciplining State will remain yellow, once Holdover has expired, since the system time
is not synchronized to a reference.
Note: Contrary to the User reference discussed above, the Local System reference
can be used for Time, or 1PPS (but not both). For more information, see "The
"Local System" Reference" on page 160.
3.2.1.4
Using Battery Backed Time on Startup
Upon system startup, by default NetClock will not declare synchronization until one of the
external references becomes available and valid.
This functionality can be overridden by enabling the Synchronize to Battery Backed Time on
Startup , thus allowing the battery backed time to be used as System Time upon system startup.
The Battery Backed Time is also referred to as the time maintained by the integrated Real Time
Clock (RTC )
This will result in NetClock providing a System Time before one of the external references
becomes available and valid. This will happen automatically, i.e. without user intervention. As
146
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
soon an external reference will become available, its time will take precedence over the battery
backed time: The System Clock will adjust the System Time for any time difference.
Note: The Battery Backed Time is also referred to as the time maintained by the
integrated Real-Time Clock (RTC).
Use Cases
Using the Battery Backed Time on Startup is typically used in these cases:
a. If the synchronization state is to be reached as quickly as possible, even if this means the
time distributed initially will most likely be less accurate than an external time reference.
b. A system is intended to operate autonomously (i.e. without any external references) and
the hand- set time entered manually during commissioning of the system is suf
ficiently accurate
the system needs to be able to completely recover from a temporary power loss,
or similar, without human intervention.
c. A system is used for simulation or testing purposes, and UTC traceability is not required.
The Accuracy of the Battery Backed Time …
… depends on the accuracy of the hand-set time if the time is set manually in an autonomous
system. In a non-autonomous system (i.e, when using external reference(s)) NetClock's System
Clock will regularly update the battery-backed time.
Another factor impacting the accuracy of the battery-backed time is how long a NetClock unit is
powered off: Any significant amount of time will cause the battery-backed RTC to drift, i.e. the
battery-backed time will become increasingly inaccurate.
The battery used for the RTC is designed to last for the lifetime of the product.
Distributing battery-backed time over NTP
When distributing a hand-set, battery backed time via NTP, please set the time relatively close
to UTC, so as to prevent NTP synchronization problems when transitioning from the hand-set
time to a UTC- based external input reference. See also "Input Reference Priorities" on
page 155.
To use the battery-backed time as the synchronized time at start-up:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. In the System Time panel click the GEAR icon.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
147
3.2 System Time
3. The Edit System Time window will display. Select the checkbox Synchronize to Battery
Backed Time on Startup:
4. Click the Submit button.
3.2.2
Timescale Offset(s)
Timescale offsets account for fixed differences between timescales, in seconds. Timescale offsets
may change because of leap seconds, see "Leap Seconds" on the facing page.
3.2.2.1
Configuring a Timescale Offset
To configure a timescale offset to the System Time:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. In the Offsets panel on the left, click the GEAR icon in the top-right corner.
3. The Edit GPS Offset window will display. Enter the desired GPS Offset in seconds, and
click Submit.
148
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
Note: Since the GPS Offset and the TAI Offset have a fixed relationship,
only the GPS Offset can be set. If only the TAI offset is known, subtract 19
from it, in order to obtain the GPS offset.
Note that the data stream of GPS and several other external references includes information
about a pending Leap Second, and as such automatically corrects for a Leap Second. Never
theless, it is advisable to perform some testing in advance to ensure all system components will
adjust flawlessly. For more information, see "Leap Seconds" below.
3.2.3
Leap Seconds
3.2.3.1
Reasons for a Leap Second Correction
A Leap Second is an intercalary 1 one-second adjustment that keeps broadcast standards for
time of day close to mean solar time. Leap Seconds are required to synchronize time standards
with civil calendars, thus keeping UTC time in sync with the earth’s rotation.
If it has been determined by the International Earth Rotation and Reference Systems Service
(IERS) that a Leap Second needs to applied, this time correction occurs only at the end of a UTC
month, and has only ever been inserted at the end of June 30 or December 31. A Leap Second
may be either added or removed, but in the past, the Leap Seconds have always been added
because the earth’s rotation is slowing down.
Historically, Leap Seconds have been inserted about every 18 months. However, the Earth's
rotation rate is unpredictable in the long term, so it is not possible to predict the need for them
more than six months in advance.
Note: Leap Seconds only apply to the UTC and Local timescales. Leap Seconds
do NOT affect the GPS and TAI timescales. However, a Leap Second event will
change the GPS to UTC, and TAI to UTC time offsets. When a Leap Second
occurs, NetClock will automatically change these offsets by the proper amount, no
matter which timescale is currently being used by the system.
As of 2016 the GPS to UTC Offset is 17 seconds. The last Leap Second occurred on June 30,
2015, and the next Leap Second is scheduled for December 31, 2016.
NetClock can be alerted of impending Leap Seconds by any of the following methods:
GNSS Receiver (if available as an input reference): The GNSS satellite system transmits
information regarding a Leap Second adjustment at a specific Time and Date an
1Intercalary: (of a day or a month) inserted in the calendar to harmonize it with the solar year, e.g., February 29 in
leap years.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
149
3.2 System Time
arbitrary number of months in advance.
Input references other than GNSS : Some of the other available input references (e.g.,
IRIG, ASCII, NTP) can also contain pending Leap Second notification in their data
streams (see chapter below).
Manual user input: NetClock can be manually configured with the date/time of the next
pending Leap Second. On this date/time, the System Time will automatically correct for
the Leap Second (unless the System Time’s timescale is configured as either GPS or TAI).
3.2.3.2
Leap Second Alert Notification
NetClock will announce a pending Leap Second adjustment by the following methods:
ASCII Data Formats 2 and 7 (among other formats) from the ASCII Data option modules
contain a Leap Second indicator. During the entire calendar month preceding a Leap
Second adjustment, these Formats indicate that at the end of the current month a Leap
Second Adjustment will be made by using the character ‘L’ rather than a ‘_ ‘ [space] in
the data stream. Note that this does not indicate the direction of the adjustment as
adding or removing seconds. These formats always assume that the Leap Second will be
added, not removed.
NTP Packets contain two Leap Indicator Bits. In the 24 hours preceding a Leap Second
Adjustment, the Leap Indicator Bits (2 bits) which normally are 00b for sync are 01b (1)
for Add a Leap Second and 10b (2) for Remove a Leap Second. The bit pattern 11b (3)
indicates out of sync and in this condition NTP does NOT indicate Leap Seconds. The
Sync state indicates Leap Seconds by indicating sync can be 00b, 01b, or 10b.
PTP Packets provide leap indication with a 12-hour notification window.
Some IRIG formats provide leap second notification indicators.
Note: It is the responsibility of the client software utilizing either the Data Formats
or NTP time stamps to correct for a Leap Second occurrence. NetClock will make
the correction at the right time. However, because computers and other systems
may not utilize the time every second, the Leap Second correction may be
delayed until the next scheduled interval, unless the software properly handles the
advance notice of a pending Leap Second and applies the correction at the right
time.
3.2.3.3
Leap Second Correction Sequence
The following is the time sequence pattern in seconds that NetClock will output at UTC midnight
on the scheduled day (Note: This is NOT local time midnight; the local time at which the adjust
ment is made will depend on which Time Zone you are located in).
150
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
A. Sequence of seconds output when adding a second ("positive Leap Second"):
56, 57, 58, 59, 60, 0, 1, 2, 3 …
B. Sequence of seconds output when subtracting a second ("negative Leap Second"):
56, 57, 58, 0, 1, 2, 3, 4 …
3.2.3.4
Configuring a Leap Second
To manually correct the System Time for a leap second:
1. Navigate to MANAGEMENT> OTHER: Time Management.
2. In the Leap Second Information panel, click the GEAR icon.on the left-hand side of the
Time Management screen:
3. The Edit Leap Second window will display:
4. In the Leap Second Offset field enter the desired GPS Offset.
5. In the Date and Time field, enter the date that the desired leap second should occur.
6. Click Submit.
To delete a leap second correction, click the Delete button.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
151
3.2 System Time
Note: The Delete button in the Edit Leap Second window will only be visible if a
leap second has been set beforehand.
3.2.4
Local Clock(s), DST
The Local Clock feature allows for maintaining one or several local times. These times will
reflect a time offset, thereby accounting for Time Zone, and DST (Daylight Savings Time) cor
rection.
3.2.4.1
Setting Up a Local Clock
To setup a Local Clock:
1. Navigate to MANAGEMENT > OTHER: Time Management.
2. Click the PLUS icon in the Local Clocks panel in the Time Management screen.
3. The Local Clock pop-up window will display.
4. Enter a Name for your local clock.
The name must be between 1 and 64 characters long; spaces are allowed.
The name can be any meaningful name that helps you know your point of ref
erence (for example: “NewYork”, “Paris” or “EasternHQ”, etc.).
This name will be used as cross-reference drop-down in the applicable Input or
Output port configuration. Please note the following limitations apply to this
option:
152
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.2 System Time
Note: Acceptable characters for the name include: A-Z, a-z, 0-9, (+_) and space.
5. In the UTC Offset field, choose a UTC Offset from the drop-down list.
All of the UTC Offset drop-down selections are configured as UTC plus or minus
a set number of hours.
Examples for the US: For Eastern , choose UTC–05:00; for Central , choose UTC06:00; for Mountain, choose UTC-07:00; and for Pacific , choose UTC-08:00.
If you wish to use DST (Daylight Savings Time ["Summer Time"]) rules, click the
Use DST Rules box. Otherwise the time for the local clock will always be standard
time.
DST options will appear in the Local Clock window:
6. Set DST Rules by Region: Check this box to apply regional DST rules. A regions dropdown menu with the following options will display:
EU (Europe): For locations complying with the European DST Rule. This rule differs
from all other rules because the DST changes occur based on UTC time, not local
time (all time zones in Europe change for DST at precisely the same time relative
to UTC, rather than offset by local time zone).
US-Canada : For locations complying with the USA’s DST Rule (as it was changed
to back in 2006, where the “DST into” date is the Second Sunday of March and
the “DST out” date is the first Sunday of November).
Australia.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
153
3.2 System Time
Note: If a pre-configured rule DST rule happens to be changed in
the future (like the change to the US DST rule in 2006), this option
allows the DST rules to be edited without the need to perform a soft
ware upgrade for a new DST rule to be defined. Select this dropdown and enter the DST parameters for the new rule.
7. DST Start Date and DST End Date: This option is provided for locations that do not fol
low any of the pre-configured DST rules. Click anywhere in either field to open a cal
endar, allowing you to enter any custom day & time rule.
8. Offset: In seconds. Use this field to manually define your local clock’s DST offset e.g.,
3600 seconds for a one hour offset.
9. DST Reference: When configuring a Local Clock that is synchronized to an input ref
erence (e.g., IRIG input), NetClock needs to know the timescale of the input time (Local
Timescale, or UTC Timescale), in order to provide proper internal conversion from one
Timescale to another.
Select Local or UTC , depending on the Timescale of the Input reference this Local Clock
is being used with.
Additional Local Clocks may need to be created if multiple input Timescales are being
submitted.
10. Click Submit. Your local clock will appear in the Local Clocks panel.
3.2.4.2
DST Examples
The following two examples illustrate the configuration of Daylight Savings Time (DST) for a
Local Clock:
Ex am ple
1:
To create a Local Clock to UTC+1 with no DST rule:
1. Navigate to MANAGEMENT > Time Management: Local Clocks > (+): Local Clock .
2. In the Local Clock Name field, assign a meaningful name to the new Local Clock.
3. From the UTC Offset pull down menu, select “UTC +01:00”.
4. Confirm that the Use DST Rules checkbox is not selected.
5. Review the changes made and click the Submit button.
The unit will display the status of the change.
154
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Ex am ple
2:
To create a Local Clock for a NetClock installed in the Eastern Time Zone of the US, and desiring the
Local Clock to automatically adjust for DST (using the post 2006 DST rules for the US).
1. In the MANAGEMENT > Time Management: Local Clocks > (+): Local Clock window:
2. Navigate to MANAGEMENT > Time Management: Local Clocks > (+): Local Clock .
3. From the UTC Offset pull-down menu, select “UTC -05:00”.
4. Select the Use DST Rules checkbox.
5. Select the Set DST Rules by Region checkbox.
6. From the DST Region drop-down list, select “US-Canada.”
7. Review the changes made and click the Submit button.
The unit will display the status of the change.
3.2.4.3
DST and UTC, GMT
Neither UTC, nor GMT ever change to Daylight Savings Time (DST). However, some of the
countries that use GMT switch to a different time zone offset during their DST period. The
United Kingdom is not on GMT all year, but uses British Summer Time (BST), which is one hour
ahead of GMT, during the summer months.
Additional information about regional time zones and DST can be found on the following web
sites: http://www.worldtimeserver.com/,
http://webexhibits.org/daylightsaving/b.html.
3.3
Managing References
3.3.1
Input Reference Priorities
NetClock can be synchronized to different time and frequency sources that are referred to as
Input References, or just References.
References can be a GNSS receiver, or other sources such as NTP, PTP, IRIG, ASCII or
HAVE QUICK time codes delivered into your NetClock unit via dedicated (mostly optional)
inputs. It is also possible to enter a system time manually, which NetClock then can synchronize
to.
Should you be installing new option cards, you will need to either manually set up the new
card in the Reference Priority Table, or use the Restore Factory Defaults option in the Reference Pri
ority Actions panel, in order to update the table with the new reference information.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
155
3.3 Managing References
In order for NetClock to declare synchronization, it needs both a valid 1PPS , and Time ref
erence.
The concept of Reference Priority allows the ranking of multiple references for redundancy. This
allows NetClock to gracefully fall back upon a lower ranking 1PPS or Time reference without
transitioning into Holdover, in case a reference becomes unavailable or invalid. The priority
order you assign to your available references typically is a function of their accuracy and reli
ability.
Note: The References shown on your screen may look different from the ones in
the illustration below, depending on your NetClock 9400 Series Time Server
model and hardware configuration.
Each available type of Time and 1PPS input reference is assigned a human-readable name or
“title” that is used in the Reference Priority table, indicating the type of reference. The reference
titles are listed in the following table:
156
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Table 3-1: Reference priority titles
Title
Reference
ASCII Timecode
ASCII serial timecode input
External 1PPS input
External 1PPS input
Frequency
External Frequency input
GNSS
GNSS input
PTP
PTP input
IRIG
IRIG timecode input
Local System
Built-in clock OR internal 1PPS generation
NTP
NTP input
User
Host (time is manually set by the user)
HAVEQUICK
HAVEQUICK input
The number displayed indicates the number of feature inputs of that type presently installed in
the NetClock– starting with “0” representing the first feature input. For example:
IRIG 0 = 1st IRIG input instance
Frequency 1 = 2nd frequency input instance
NTP 2 = 3rd NTP input instance
The columns of the Reference Priority table are defined as follows:
Priority—Defines the order or priority for each index (row). The range is 1 to 16, with 1
being the highest priority and 16 being the lowest priority. The highest priority ref
erence that is available and valid is the reference that is selected.
Time—The reference selected to provide the necessary “Time” reference.
1PPS —The reference selected to provide the necessary “1PPS” reference.
Enabled—The reference is enabled.
Delete—Removes the Index (row) from the Reference Priority table.
3.3.1.1
Configuring Input Reference Priorities
NetClock can use numerous external time sources, referred to as "references". As external time
sources may be subject to different degrees of accuracy and reliability, you can determine in
which order (= priority) NetClock calls upon its external time and 1PPS references.
For additional information, see also "Input Reference Priorities" on page 155.
Accessing the Reference Priority Screen
To access the Reference Priority Setup screen:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
157
3.3 Managing References
1. Navigate to MANAGEMENT > OTHER: Reference Priority.
OR:
1. On the HOME screen, click the GEAR icon in the Reference Status panel:
2. The Configure Reference Priorities screen will display.
The Reference Priority screen is divided into 3 areas:
a. The Actions panel, which provides a single action:
Restore Factory Defaults
b. The Configure Reference Priorities panel, which displays the priority of NetClock’s
references in a table form.
In this panel you can:
Add and configure new references
Delete references
Enable/disable references
Reorder the priority of NetClock’s references
c. The Reference Status panel
158
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
The Reference Status panel provides a real time indicator of the status of the
NetClock’s references. It is the same as the Reference Status panel on the
HOME screen of the Web UI.
Adding an Entry to the Reference Status Table
To add a new entry to the Reference Status table:
1. Navigate to the Configure Reference Priorities screen via MANAGEMENT > OTHER:
Reference Priority.
2. Click the PLUS icon in the top right-hand corner of the Configure Reference Priorities
table.
3. The Add Reference window will display:
4. In the Add Reference window, enter:
Priority Level: Assign a priority to the new reference.
Time: Select the time reference.
PPS : Select the PPS reference.
Enabled: Check this box to enable the new reference.
5. Click Apply or Submit. (Submit will close the window.)
Deleting a Reference Entry
To delete an entry from the Reference Status table:
1. Navigate to the Configure Reference Priorities screen via MANAGEMENT > OTHER:
Reference Priority.
2. In the Configure Reference Priorities table click the Delete button on the right-hand side
of the entry you wish to delete.
3. In the pop-up window that opens click OK to confirm.
Reordering Reference Entries
To reorder the priority of a reference entry:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
159
3.3 Managing References
1. Navigate to the Configure Reference Priorities screen via MANAGEMENT > OTHER:
Reference Priority.
2. Click and hold on the item whose priority you wish to reorder.
3. Drag the item up or down to the desired place.
4. Click Submit.
Resetting Reference Priorities to Factory Defaults
To reset all references in the Reference Priority table to their factory default priorities:
1. Navigate to the Configure Reference Priorities screen via MANAGEMENT > OTHER:
Reference Priority menu.
2. In the Actions panel, click the Restore Factory Defaults button.
3.3.1.2
The "Local System" Reference
The Local System reference is a "Self" reference, i.e. NetClock uses itself as an input reference
for Time, or as a 1PPS reference. The Local System is a unique input reference in that it can be
used as either the Time reference, or the 1PPS reference, but never both.
160
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Note: For NetClock to operate as a Local System reference, you must have either
a valid external Time reference, or a valid external 1PPS reference.
When the Time reference is configured as Local System , NetClock's System Time is con
sidered a valid reference, as long as the external 1PPS input reference is valid.
Vice versa, when the 1PPS reference is configured as Local System , NetClock's built-in
oscillator is considered a valid reference, as long as the external Time reference is valid.
Use case "Local System Time"
The Local System reference when used for Time allows NetClock to operate using its current
Time-of-Day (ToD) for Time, while synchronized to an external 1PPS reference.
While you may intentionally offset the time in this scenario, the second will be precisely aligned
to the external 1PPS reference. Therefore, this use case qualifies as a legitimate, traceable time
source.
Instead of an offset time, Local System can also be used as a backup Time reference (e.g., Pri
ority "2"): Should the external Time reference become invalid, the Local System Time will
become the valid backup reference, disciplined by the external 1PPS reference: NetClock will
transition to the Local System Time, without going into Holdover.
Use case "Local System 1PPS"
The Local System reference can also be used for 1PPS: This allows NetClock to operate using
an external ToD for time, while generating 1PPS from its own internal oscillator.
In this rare use case the 1PPS is NOT aligned to any standard, therefore the time may drift, and
must be considered untraceable.
3.3.1.3
The "User/User" Reference
While it is normally not required, it is possible for you as the "User" to override the System
Time (even if it is synchronized to a valid reference) with a manually set time, steered by an
undisciplined oscillator, and use this manually set Time as an output reference. This concept is
referred to as the User/User reference, because both the Time, and the 1PPS reference are not
linked to any UTC-based external reference, but hand-set by you.
Caution: Since the User/User reference is not traceable to a valid reference, it
does not qualify as a legitimate time source. Operating NetClock with a manually
set User time bears the risk of inadvertently outputting an illegitimate System Time
thought to be a valid reference time.
Use cases for the "User/User" reference
CHAPTER 3 • NetClock User Reference Guide Rev. 13
161
3.3 Managing References
The User/User reference is provided for the following use cases:
a. No external references are available (yet), but you need a reference for testing or setup
purposes. This may be the case e.g., while waiting for a GNSS antenna to be installed.
b. No external references are required e.g., if NetClock is used solely to synchronize com
puters on a network, with no need for traceable UTC-based timing.
c. To utilize a backup reference as soon as possible after a power cycle or reboot of NetC
lock, while waiting for the primary reference (e.g., GNSS) to become valid. To this end,
in the Edit System Time window, the checkbox Synchronize to Battery Backed Time on
Startup must be checked, AND the User/User reference is assigned a reference priority
number other than "1". Note that a Time jump and/or 1PPS jump are likely to happen
once the primary reference becomes valid.
Combining a User Time reference with a non-User 1PPS reference or vice versa is not a typical
use case. Use the Local System reference instead, see "The "Local System" Reference" on
page 160.
Built-in safety barrier
In order to "validate" (= green status lights) the User/User reference, the hand-set time must be
manually submitted every time after NetClock reboots or resets, or after the Holdover period
has expired: In the Edit System Time window, the checkbox Manual Time Set must be checked.
The System Time displayed in the field below will become valid the moment the Submit button is
clicked.
See also below, " How long will the User/User reference be valid? ": The notion of limiting the
validity of the User/User reference also serves as a safety feature.
How long will the User/User reference be valid?
Since the User/User reference does not qualify as a legitimate, traceable time, it becomes
invalid once NetClock is reset, or power-cycles, or after the Holdover Time expires (whichever
occurs first). It then needs to be set manually and submitted again (Edit System Time > Manual
Time Set).
162
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
The only workaround for this is "Using Battery Backed Time on Startup" on page 146. This will
allow NetClock to apply the User/User reference after a power-cycle without manual inter
vention.
How to setup the User/User Reference
See "Manually Setting the Time" on page 144.
Using the "User" Reference with Other References
If the User/User reference is used in conjunction with other, external references (such as GNSS
or IRIG), the System Time should be set as accurately as possible:
Otherwise, the large time correction that needs to be bridged when switching from a lost ref
erence to a valid reference, or from a valid reference to a higher-priority reference that has
become available again, will cause NTP to exit synchronization. If the difference is under
1 second, NTP will remain in sync and will "slew" (over a period of time) to the new reference
time.
3.3.1.4
Reference Priorities: EXAMPLES
Example 1 – GNSS as primary reference, IRIG as backup:
In this use case, the objective is to use:
GNSS as the primary Time, and 1PPS reference
IRIG as the backup Time, and 1PPS reference.
Step-by-step procedure:
1. Move the reference which has “GPS 0” in the Time column and “GPS 0” in the 1PPS
column to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
2. Move the reference which has “GPS 0” in the Time column and “GPS 0” in the 1PPS
column to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
3. Move the reference which has “GPS 0” in the Time column and “GPS 0” in the 1PPS
column to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
Since both of these references are default references, no additional references need to be
added to the Reference Priority table.
Example 2 – IRIG as primary reference, NTP input as backup
In this use case, the objective is to use:
IRIG as the primary reference input
Another NTP server as backup reference
CHAPTER 3 • NetClock User Reference Guide Rev. 13
163
3.3 Managing References
Step-by-step procedure:
1. Move the reference which has “IRIG 0” in both the Time column and “IRIG 0” in the 1PPS
column to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
2. Move the reference which has “NTP” in the Time column and “NTP” in the 1PPS column
to the second place in the table, with a Priority value of 2. Click the Enabled checkbox.
3. For all other references, uncheck the Enabled checkbox, so that they are all disabled.
Since both of these references are default references, no additional references need to be
added to the Reference Priority table.
Example 3 – NTP input as the only available input (“NTP Stratum 2 operation”)
In this use case, the objective is to have NTP provided by another NTP server as the only avail
able reference input, i.e. the unit to be configured is operated as a Stratum 2 server. For more
information, see "Configuring "NTP Stratum Synchronization"" on page 99.
Step-by-step procedure:
1. Move the reference which has “NTP” in the Time column and “NTP” in the 1PPS column
to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
2. For all other references, uncheck the Enabled checkbox, so that they are all disabled.
3. Configure the NTP Service as described under "Configuring "NTP Stratum Syn
chronization"" on page 99.
Note: When selecting NTP as an input reference, do not select another reference
(such as GNSS, IRIG, etc.) to work with NTP as a reference. NTP should always
be selected as both the Time and 1PPS input when it is desired to use NTP as an
input reference.
Example 4 – Time set manually by the User. Other references may or may not be
available
Note: In order for a manually set time to be considered valid and used to syn
chronize NetClock, a “User” needs to be created and enabled in the Reference
Priority table. "The "User/User" Reference" on page 161.
In this use case, the objective is to use a hand-set time, in combination with NetClock's oscillator
as a 1PPS source as valid references.
Step-by-step procedure:
164
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
1. If necessary (see NOTE above), create a “User.”
2. Move the reference which has “User 0” in the Time column and “User 0” in the 1PPS
column to the top of the table, with a Priority value of 1. Click the Enabled checkbox.
3. For all other references, uncheck the Enabled checkbox, so that they are all disabled.
If the objective is to use a manually set time as a backup to other references (such as GNSS or
IRIG):
1. Move the "User/User" reference to a place in the table that has a priority lower than the
references the "User/User" reference will be backing up. Make sure the Enabled check
box is selected.
2. With “User/User” enabled, if no other higher priority references are enabled or avail
able (or if the higher priority references have since been lost), you can now manually set
the System time to the desired value (MANAGEMENT > OTHER: Time Management >
System Time > Manual Time Set). See "System Time" on page 142 for more inform
ation. NetClock will go into synchronization using this set time once you click the Submit
button, and the front panel sync light will turn green.
Note: You will need to repeat this procedure each time NetClock is power-cycled
(with no other references available), unless you enabled the feature Synchronize
to Battery Backed Time on Startup.
Example 5—Time at power-up ("Local System Time") to be considered "Valid".
GNSS input to serve as 1PPS reference
The objective of this use case is to allow NetClock to use itself as a valid reference. This is
referred to as “Local System” time.
In order for this to happen, NetClock requires an external Time, or 1PPS reference. In other
words, "Local System" cannot be both Time, and 1PPS. This makes "Local System" a legitimate,
traceable reference.
Therefore the "Local System" does not have to be manually set ("validated") by the User after
NetClock was power cycled (as would be the case with a “User/User” reference).
Since “Local System” cannot be both Time, and 1PPS input together, in this example the GNSS
input will be set as the 1PPS reference (other use cases may require using different references,
e.g. IRIG.)
As there is no default entry for “Local System” and “GPS”, a new entry needs to be added to
the Reference Priorities table in order to use this combination of references.
Step-by-step procedure:
1. Add a reference to the Reference Priority by clicking the PLUS icon. Use the following set
tings, then click Submit:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
165
3.3 Managing References
In the Priority Level text box, enter 1. This will give this reference the highest pri
ority.
In the Time field, select “Local System”.
In the PPS field, select “GPS”.
Check the Enabled checkbox.
2. Confirm that the first reference in the Reference Priority table has “Local System” as the
Time input and "GNSS" as the 1PPS input.
3. After a power cycle or reboot, as soon as GNSS is declared valid, the System Time will
automatically be used as-is, with no manual intervention required.
3.3.2
The GNSS Reference
With most applications, NetClock will be setup such that it utilizes a GNSS signal as the
primary (if not the only) timing reference, because the time derived from a GNSS signal is
likely to be by far the most accurate time reference available. GNSS satellites (GNSS = Global
Navigation Satellite System e.g., GPS, GLONASS, Beidou, Galileo, QZSS) transmit a time sig
nal as part of their data stream, because a very precise time is required to accurately determ
ine your position on earth.
NetClock's GNSS receiver uses the GNSS signal provided by the antenna.
The GNSS receiver analyzes the incoming GNSS data stream and supplies the GNSS time and
1PPS (Pulse-Per-Second) signal to NetClock's timing system. The timing system uses the data to
control the System Time and discipline the oscillator.
While NetClock’s default GNSS receiver configuration will likely be adequate for most install
ations, it is advisable that you familiarize yourself with the basic configuration features so as to
achieve the best possible results. This is particularly true if you have poor GNSS reception.
To access the GNSS Receiver settings:
1. Navigate to INTERFACES > REFERENCES: GNSS 0.
Note: Typically, there will be only one GNSS reference, numbered "0".
2. The GNSS 0 status window will open. To open the configuration window, click Edit in
the bottom-left corner.
OR:
1. Navigate to INTERFACES > REFERENCES: GNSS Reference.
2. Click on the INFO button, or the GEAR button to configure the GNSS settings, or review
GNSS reference status information.
Note that the configurable settings displayed in the configuration window are highly
dependent on superordinate settings, as well as receiver manufacturer and type in your
NetClock unit:
166
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Trimble Resolution-T®
Trimble Res–SMT GG®
u-blox M8T®.
3.3.2.1
Reviewing the GNSS Reference Status
To view the current status of your GNSS reference:
1. Navigate to INTERFACES > REFERENCES: GNSS Reference.
2. Click the INFO button next to GNSS 0. The GNSS 0 status window will display; it con
tains two tabs, explained in detail below: Main [= default], and Satellite Data.
The "Main" tab
CHAPTER 3 • NetClock User Reference Guide Rev. 13
167
3.3 Managing References
Under the Main tab, the following information will display:
Note: Detailed information on the different parameters can be found in the sub
sequent GNSS topics.
Manufacturer/Model: The manufacturer and/or model of the GNSS receiver in your
NetClock unit.
Validity: Status indicator lights for TIME and 1PPS signals: “On” (green) indicates a
valid signal, “Off” (red) indicates that no valid signal is available.
Receiver Mode:
Single Satellite: Used in areas with poor GNSS reception.
Standard: Default operating mode for the GNSS receiver.
Mobile: For non-stationary applications.
Receiver Dynamics : (u-blox receivers only); see "Select a setting and click Submit." on
page 176.
Survey Progress : Real-time status:
ACQUIRING (x Satellites)—red
SURVEYING (x %)—yellow; remains at 1% if no satellites are in view
COMPLETE—green
Number of Tracked Satellites : The number of satellites currently being tracked.
Offset: As set by the user, in nanoseconds.
Antenna Sense:
OK (green)
Open: Check the antenna for the presence of an open.
Short:Check the antenna for the presence of a short.
Position: NetClock’s geographic position by:
Latitude: In degrees, minutes, seconds
Longitude: In degrees, minutes, seconds
Altitude: In meters MSL (Mean Sea Level)
Receiver Constellation: (If equipped for Multi-GNSS reception) GPS/GLONASS/Ga
lileo/BeiDou/QZSS
Client A-GPS Status : A-GPS is ENABLED and running, or DISABLED
Client A-GPS Data: External A-GPS data is AVAILABLE, or UNAVAILABLE
Identified Satellite Signal Strengths : Bar graphs for all satellites detected. Color indic
ates signal strength.
168
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
With your mouse pointer, hover over a bar graph to display tool tip information about
satellite constellation (if equipped for Multi-GNSS reception), satellite number, and sig
nal strength.
Letter Symbol
GNSS Constellation
G
GPS
R
GLONASS
E
Galileo
J
QZSS
C
BeiDou
I
IRNSS
The "Satellite Data" tab
Under the Satellite Data tab, there are two graphs:
Number of Satellites over Time: A graphical track of how many satellites were being
tracked over time.
SNR over Time: A graphical track of maximum SNR, and minimum SNR.
In both graphs, to see a legend of the graphical data, and time-specific status data, click
inside the graph, choosing the desired point in time. If necessary, increase the time res
CHAPTER 3 • NetClock User Reference Guide Rev. 13
169
3.3 Managing References
olution by dragging the time sliders. A pop-up window will display the legend for that
graph, and the status information for the selected time.
3.3.2.2
Determining Your GNSS Receiver Model
To determine which GNSS receiver model is installed in a NetClock unit:
Note: If a NetClock unit is used exclusively as a Stratum 2 server, it may not be
equipped with a GNSS receiver at all.
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the System Configuration panel, locate the line item GNSS Receiver :
GNSS Receiver Models
Spectracom strives to equip NetClock with current technology. Depending on the production
date of your NetClock unit, one of the following GNSS receiver models will be installed in
your unit (if any):
Trimble Res-T®
170
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Production dates: up to 2014
Constellations: GPS
Other characteristics:
A-GPS option: No
Resurvey: Automatic, when moved.
Trimble Res-SMT™ GG
Production dates: 2014, 2015, 2016
Constellations: GPS, GLONASS, QZSS
Other characteristics:
A-GPS option: Yes
Resurvey: Automatic, when moved (software-version dependent).
u-blox® M8T
Production dates: 2016
Constellations: GPS, GLONASS, BeiDou, Galileo (Receiver SW V. ≥ 3.0.1), QZSS
Other characteristics:
A-GPS option: Yes
Resurvey: Per default, always when rebooted — can be changed, see "Setting GNSS
Receiver Dynamics" on page 174.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
171
3.3 Managing References
Multi-GNSS option: Yes, within these permissible settings:
GPS
Galileo
GLONASS
Beidou
X
X
–
–
X
X
X
–
X
X
–
X
X
–
X
–
X
–
–
X
–
X
X
–
–
X
–
X
–
–
X
X
Note: The augmentation systems SBAS and QZSS can be enabled only if
GPS operation is configured.
3.3.2.3
Selecting a GNSS Receiver Mode
When connected to a GNSS antenna that receives a GNSS signal, NetClock can use GNSS as
an input reference. The factory default configuration allows GNSS satellites to be
received/tracked with no additional user intervention required.
However, there are several user-configurable GNSS settings:
The Receiver Mode function allows the GNSS receiver to operate in either a stationary
mode (“Standard” or “Single Satellite” modes), or in a mobile mode environment e.g.,
in a vehicle, ship or aircraft.
Offset [ns]: to account for antenna cable delays and other latencies
Receiver dynamics (supported only by u-blox M8T and Trimble Res-T receivers): to optim
ize performance for land, sea or air operation
The ability to delete the stored GNSS position information (latitude, longitude and
antenna height).
The option to determine when a resurvey is to be performed (supported only by newer
GNSS receivers).
To configure the GNSS Receiver Mode for your NetClock unit:
1. Navigate to INTERFACES > REFERENCES : GNSS 0. The GNSS 0 Status Panel will
open.
2. Click Edit in the bottom-left corner. The GNSS 0 configuration window will open:
172
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
3. Select the desired Receiver Mode, and click Submit.
GNSS Receiver Modes
The receiver modes are:
Standard GNSS Receiver Mode
The default GNSS receiver mode is the Standard Mode : It is the most accurate, and hence the
preferred GNSS receiver mode.
The Standard Mode can be used only for stationary applications , i.e. the NetClock unit will
not be moved. Also, it must be able to track initially at last four satellites in order to complete
the survey. (Once the survey is completed, less than four satellites will provide a valid Time and
1PPS.)
About the GNSS Survey
In the Standard Mode the so-called GNSS survey will initially be performed, once at least four
GNSS satellites become available. The GNSS survey is used to determine the exact position
and time; it takes 2000 seconds (33 minutes) to complete a survey. During the survey, the
GNSS receiver must continue to track at least four satellites, otherwise the GNSS survey will not
complete.
Upon completion of the GNSS survey the GNSS receiver will lock-in the calculated GNSS pos
ition and will enter Standard Mode . Once in Standard Mode , the GNSS survey will only be
performed again if:
the equipment will be relocated to another location and the receiver detects this (applies
to most Trimble receivers)
the Receiver Dynamics is set to resurvey automatically after every reboot (this feature is
available only with u-blox receivers; it can be turned off, see "Setting GNSS Receiver
Dynamics" on the next page.)
you manually delete the GNSS position, see "Deleting the GNSS Receiver Position" on
page 180.
In the event that NetClock cannot complete a GNSS survey within 24 hours (e.g., the survey pro
gress does not go beyond 99%), see "Single Satellite GNSS Receiver Mode" on the next page.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
173
3.3 Managing References
Single Satellite GNSS Receiver Mode
The Single Satellite Mode is designed for use cases in which it is not possible for the GNSS
receiver to track at least four GNSS satellites for at least 33 minutes continuously in a 12-hour
time window so as to complete the GNSS survey, i.e. obtain a 3-D fix. In such cases, NetClock
cannot operate in Standard Mode . This occurs frequently in areas with limited view of the sky
(e.g., "urban canyons").
In Single Satellite Mode, the GNSS receiver will be considered a valid input reference as long
as:
a. the receiver was able to complete a survey during a time window with good satellite
reception, OR you have manually entered a valid position for your antenna location
(instructions can be found under "Manually Setting the GNSS Position" on page 181
and "Determining Your Position" on page 183.)
b. the GNSS receiver continues to track at least one qualified satellite.
Note that NetClock is designed to provide the most accurate time in Standard Mode, hence the
Single Satellite Mode should only be used if the GNSS receiver could not complete a survey.
Note also that Single Satellite Mode can only be used if the NetClock unit remains stationary at
all times.
Mobile GNSS Receiver Mode
In Mobile Mode no surveys will be carried out since the position status is updated in near realtime. NetClock will go into synchronization shortly after beginning to track satellites.
The Mobile Mode should only be selected if your NetClock unit will NOT remain stationary at
all times, i.e. instead of being operated in a building, it is installed in a mobile platform (such
as a vehicle, ship, plane, etc.).
Note: With NetClock's GNSS receiver configured in Mobile Mode , the specified
accuracies of NetClock will be degraded to less than three times that of Standard
Mode . Standard Mode accuracy of the receiver is less than 50 ns to GPS/UTC
(1 sigma), hence Mobile Mode is less accurate than 150 ns to GPS/UTC time
(1 sigma).
3.3.2.4
Setting GNSS Receiver Dynamics
This Receiver Dynamics setting further refines the reception characteristics for the different
receiver modes (see above). It also determines if the receiver will automatically resurvey after
NetClock reboots.
Note: This option only applies to u-blox M8T Receivers and Trimble Res-T Receivers
(RES-SMT-GG and SAASM GPS do NOT support this.)
174
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Caution: If you select a setting that does NOT resurvey, and subsequently relocate
your unit (antenna) by more than 100 m, u-blox M8T and Trimble Res-T receivers
will NOT detect the new position, and hence provide an incorrect time.
For more information about the GNSS Survey , see "Deleting the GNSS Receiver Position" on
page 180.
For more information on Receiver Modes , see "Selecting a GNSS Receiver Mode" on
page 172.
Available GNSS Receiver Dynamics Settings
The following Receiver Dynamics settings are available:
Land (Resurvey): [default]
When used with the Mobile Receiver Mode, the receiver is adjusted for typical dynamic
land-based applications.
When used with the Standard Receiver Mode, this setting also will automatically initiate
a resurvey after NetClock reboots, in order to account for a possible relocation.
Sea: The receiver dynamics will be optimized for mobile motion patterns typical with
marine applications, resulting in greater timing accuracy, and avoiding premature loss
of synchronization.
Air : The receiver dynamics will be optimized for acceleration forces typically exper
ienced in civil aviation applications.
Stationary (No Resurvey): In Standard Mode, the receiver is set to a non-dynamic value
for stationary applications.
There will be no automatic resurvey after a reboot. Should a unit be relocated, you
need to delete its position, thus initiating a new survey.
The following table illustrates the interdependence between Receiver Dynamics, Receiver Mode
(see "Selecting a GNSS Receiver Mode" on page 172) and receiver type:
Table 3-2: Receiver dynamics, ~modes, ~ dynamics, ~ types
Receiver Dynamics
Receiver Mode
Single Satellite
Land
(Resurvey)
Sea
Air
Stationary
(No Resurvey)
irrelevant
irrelevant
irrelevant
irrelevant
Standard
Mobile (with u-blox receivers)
CHAPTER 3 • NetClock User Reference Guide Rev. 13
175
3.3 Managing References
Receiver Dynamics
Receiver Mode
Land
(Resurvey)
Sea
Air
Stationary
(No Resurvey)
Mobile (with Res-T receivers)
(not recommended)
Notes:
Trimble Res-T and Res-SMT-GG receivers will report Land dynamics during a survey until
the survey is complete. Then the dynamics becomes Stationary. This also indicates that the
receiver has completed the survey.
The u-blox M8T receiver now uses Land to indicate it will RESURVEY on reboot, and Sta
tionary to indicate it will not resurvey after reboot.
To change/review the GNSS Receiver Dynamics:
1. Navigate to INTERFACES > REFERENCES: GNSS 0.
2. Under the Main tab of the GNSS 0 status window, the line item Receiver Dynamics will
indicate the current setting.
3. To change the setting, click Edit in the bottom-left corner. The GNSS 0 configuration win
dow will display:
4. Select a setting and click Submit.
3.3.2.5
Performing a GNSS Receiver Survey
When NetClock's integrated GNSS receiver performs a survey, it tries to determine or verify its
geographic position with high accuracy. An accurate geographic position is required to cal
culate a precise system time from the GNSS reference.
During a GNSS survey, the position will be iteratively recalculated while gradually increasing
the position accuracy. A survey can take up to 33 minutes, but typically NetClock will syn
chronize earlier, i.e. offer a valid Time and 1PPS reference, once it has obtained a sufficiently
accurate preliminary position.
176
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Note: In Mobile receiver mode NO surveys will be carried out since the position
status is updated in near real-time.
Initiating a GNSS Survey
Depending on the GNSS receiver model installed in your NetClock, the standard default beha
vior is either:
a. that the GNSS receiver detects if the NetClock has been relocated, and hence will ini
tiate a GNSS survey to determine the new position
b. or that a power cycle, or a reboot will automatically initiate a GNSS survey.
To reboot your unit, navigate to TOOLS > SYSTEM: Reboot/Halt.
While a (re-)survey is crucially important if a NetClock unit has been relocated,
e.g. when commissioning a new unit, it is normally not required if a stationary
unit is rebooted for other reasons. To turn off this functionality, see "Setting
GNSS Receiver Dynamics" on page 174.
Note: Behavior (a.) applies to most Trimble ® receiver types, while behavior (b.)
applies to u-blox® receivers.
Verifying GNSS Survey Progress
To see if NetClock's GNSS receiver is performing a survey and if so, verify its progress:
1. Navigate to INTERFACES > REFERENCES: GNSS 0.
2. The survey status (ACQUIRING, COMPLETE, or progress in percent) is displayed under
the line item Survey Progress.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
177
3.3 Managing References
Note: Once a survey has been initiated, the Survey Progress may not be
displayed right away until the receiver has completed its initialization pro
cess.
3.3.2.6
Configuring a GNSS Receiver Offset
The Offset setting in the GNSS configuration window (INTERFACES > GNSS 0 > "Edit") allows
you to enter an offset to the GNSS time and 1PPS reference in order to account for antenna
cable delays or other latencies (entered and displayed in nanoseconds).
By setting the correct Offset value, you can offset the system’s on-time point by the Offset value
to compensate for the antenna and in-line amplifier delays. Under typical conditions, the expec
ted cable and amplifier delays are negligible. You can calculate the delay based on the man
ufacture’s specifications.
The offset range is ±½ seconds (= ±500 ms, or ±500 000 000 ns). The default value is 0 nano
seconds, and the resolution is 1 nanosecond.
Configuring a GNSS receiver offset
To configure the GNSS receiver offset:
1. Navigate to Interfaces > References: GNSS Reference
2. Click on the GEAR button next to the GNSS Reference. The GNSS 0 window will open:
3. Locate the Offset field, and enter the desired value.
4. Click Submit.
Calculating cable delay
The following formula can be used to calculate antenna cable delay:
D
=
(L
*
C )/ V
Where:
D = Cable delay in nanoseconds
L = Cable length in feet
178
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
C = Constant derived from velocity of light: 1.016
V = Nominal velocity of propagation expressed as decimal, i.e. %66 = 0.66 Value is provided by
cable manufacturer.
When using Spectracom LMR-400 or equivalent coaxial cable, this formula equates to approx
imately 1.2 nanoseconds of delay per every foot of cable. To calculate the Offset value (cable
delay), multiply the length of the entire cable run by “1.2” and then enter this value into the Off
set field.
Ex am ples
delay s :
o f
LMR-400
(o r
equi valent)
c o ax
c able
100 feet of cable = 120 nanoseconds of cable delay
200 feet of cable = 240 nanoseconds of cable delay
300 feet of cable = 360 nanoseconds of cable delay
3.3.2.7
Resetting the GNSS Receiver
The Reset Receiver command causes the GNSS receiver to execute a cold start: All data will be
erased from the volatile receiver memory. Only non-volatile memory is preserved.
Caution: Resetting the GNSS receiver may become necessary in the rare event of
internal communication issues, and is typically ONLY required if Spectracom Tech
nical Support advises you to execute this command.
Note that resetting the GNSS receiver is not the same as "Deleting the GNSS Receiver Position"
on the next page.
To reset the GNSS Receiver:
1. Navigate to Interfaces > References: GNSS Reference
2. Click on the GEAR button next to the GNSS Reference. The GNSS 0 window opens:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
179
3.3 Managing References
3. Locate the Reset Receiver box, check it, and click Submit.
3.3.2.8
Deleting the GNSS Receiver Position
The NetClock timing system requires the exact geographic position in order to calculate the
exact system time from the GNSS signal.
The Delete Position command deletes the GNSS antenna position data that is stored in the nonvolatile memory of the GNSS receiver.
The deletion of the position data will automatically initiate a new GNSS self survey, provided:
a GNSS antenna is connected to NetClock
the GNSS receiver can track at least four satellites continuously
and the GNSS receiver it is configured to operate in Standard Mode (see "Selecting a
GNSS Receiver Mode" on page 172).
The objective of the GNSS Survey is to re-discover the current antenna position.
Note: A self survey will require at least 2000 seconds (33 minutes).
Relocating NetClock
The Delete Position command may need to be used if a NetClock system is physically moved,
and it did not self-initiate a new survey automatically, as is the case with u-blox M8T-series
receivers (see also "Determining Your GNSS Receiver Model" on page 170). Note that neg
lecting to delete the old position data and discover the new position data will cause NetClock
not to go into synchronization state.
Note: Software versions 5.4.5 and above by default will initiate a resurvey on
reboot. See "Setting GNSS Receiver Dynamics" on page 174.
180
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Sanitization
The Delete Position command must also be used when sanitizing a NetClock unit (ensuring that
no trace of position data remains on the unit). See "Sanitizing the Unit" on page 303.
Deleting the GNSS position
To delete the GNSS position:
1. Disconnect the GNSS antenna from the NetClock unit (required only when sanitizing the
unit).
2. Navigate to Interfaces > References: GNSS Reference. 3. Click on the GEAR button next to the GNSS Reference (typically, there is only one ref
erence, numbered "0"). The GNSS 0 window will open:
Locate the Delete Position box, check it, and click Submit.
4. NetClock will initiate a GNSS self survey.
Note: In Mobile Receiver Mode it is NOT possible to delete the position and start
the GNSS survey. This feature is only available in Standard Mode and in Single
Satellite Mode (see "Selecting a GNSS Receiver Mode" on page 172). In Single
Satellite Mode a GNSS survey may take up to 24 hours.
3.3.2.9
Manually Setting the GNSS Position
The exact geographic position (location and elevation) of the antenna your NetClock unit—and
thus its onboard GNSS receiver—is a major factor for NetClock to calculate an accurate Sys
tem Time from the GNSS reference.
Note: The elevation (altitude) should be set in accordance with the World Geo
detic System 1984 (WGS 84), not Mean Sea Level (MSL).
CHAPTER 3 • NetClock User Reference Guide Rev. 13
181
3.3 Managing References
Normally, the onboard GNSS receiver will track and adjust the antenna position during the socalled GNSS self survey , which is performed during initial commissioning of a NetClock unit,
or when rebooting a unit after it had been powered down for some time ("cold start").
Depending on where your GNSS antenna is installed and thus, how good the reception is, the
self survey may be adequate for most applications.
Setting a Manual Position, however, i.e. manually applying your current geographic position
data (Latitude, Longitude, and Altitude) may be necessary if your GNSS receiver could not com
plete its survey due to poor reception.
In some cases, setting the position manually may also help to reduce the amount of time needed
for the initial position "fix", i.e. for NetClock to synchronize with the satellites in view.
Note: When manually setting a position, NetClock must be in one of the sta
tionary modes, Standard or Single Satellite (see "Selecting a GNSS Receiver
Mode" on page 172).
Note that this position will also be used if Apply A-GPS Data is checked.
To manually set your position:
1. Determine your geographic position. For more information, see "Determining Your Pos
ition" on the facing page.
2. Navigate to INTERFACES > REFERENCES: GNSS 0. In the GNSS 0 status window, click
Edit in the lower left corner. The GNSS 0 window will open:
3. Under Manual Position Set accurately enter latitude, longitude (both in decimal
degrees), and altitude (in meters [WGS 84]) of your GNSS antenna, NetClock can use
this data during the satellite tracking/adjustment process, which typically leads to a
quicker "fix". It is recommended to enter the position as accurately as possible.
182
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Determining Your Position
In case your geographic antenna position is not already known, there are several ways to
determine it e.g., using a GPS-enabled device, such as a smart phone. GoogleMaps is another
option, described below.
Reas o ns
f o r
m anually
enter i ng
y o ur
po s i ti o n
Manually entering your position may not only reduce the time to “first fix” during initial installation, it
may also enable the unit to synchronize to satellite timing signals if your GNSS reception is poor.
After manually entering the position data, NetClock will automatically check the status of the GNSS
receiver:
If no GNSS-based position data is available (yet), NetClock will provide the GNSS receiver with the
manually entered position.
Determining your GNSS position, using GoogleMaps™:
1. Locate the building and the relative location of your GNSS antenna.
2. Obtain the coordinates by left-clicking on the location: A popup window will display
your coordinates.
3. Take note of your decimal position.
Note: Should you prefer to determine your position in a different way,
and as a result, have your latitude & longitude data in degrees/minutes/
seconds, you need to convert this data, e.g. by using a conversion tool,
such
as
Earth
Point
www.earthpoint.us ,
or
https://www.fcc.gov/media/radio/dms-decimal:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
183
3.3 Managing References
4. Determine your altitude: Finding the altitude of your NetClock's antenna position is not
as crucial as finding the latitude and longitude. Looking up the altitude for the general
area may suffice for many applications.
If a more exact altitude is desired, the use of a topographical map is recommended.
Applying the WGS 84 standard will likely yield the most accurate elevation.
5. Click Submit to apply any changes you may have made.
3.3.2.10 GNSS Constellations
NetClock allows you to select which GNSS constellations shall be tracked, i.e. you can determ
ine if you want e.g., GLONASS satellites to be tracked (besides GPS).
The options offered depend on the type of GNSS receiver installed in your NetClock unit, and
if a Multi-GNSS license file is installed.
Selecting GNSS Constellations
If your NetClock is equipped with a GNSS receiver, it is capable of tracking GNSS con
stellations other than GPS. Which ones depends on the receiver model; for more information,
see "Determining Your GNSS Receiver Model" on page 170.
Note: In order to track several constellations simultaneously , the Multi GNSS
Option is required. For more information, see "Determining if the Multi- GNSS
Option Is Installed" on page 188.
With a u-blox M8T receiver and a Multi-GNSS license file installed, the following GNSS con
stellations are supported:
184
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
GPS
GLONASS
BeiDou
Galileo(*)
QZSS .
(*) As of winter 2016/17, also Galileo will be receivable.
About QZSS
QZSS is disabled by default. For further information, research QZSS online. In order to
receive QZSS signals, you must either be located in the Japan region, or use a GNSS sim
ulator (such as Spectracom GSG-5 or -6 Series).
QZSS is not considered a standalone constellation and while NetClock allows you to enable
QZSS by itself, it is recommended to use it in combination with GPS.
Per default both GPS, and GLONASS will be enabled, in order to obtain as many satellite sig
nals as possible. Either selection can be disabled, but not both of them (if both are turned off,
no changes will be saved and the last constellation setting will be preserved).
To verify if satellite signals for the selected GNSS constellations are received, see "Determining
Which GNSS Satellites Are Received" on page 187.
To configure which GNSS constellations NetClock's GNSS receiver shall track:
1. Navigate to INTERFACES > REFERENCES: GNSS Reference.
2. Click the GEAR button next to GNSS 0. The GNSS 0 window will open:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
185
3.3 Managing References
3. Under Selected Constellations , review which constellations are currently tracked, and
apply your changes. Note the following:
The u-blox M8T receiver is capable of receiving multiple GNSS constellations sim
ultaneously; the table below shows which combinations are possible:
GPS
Galileo
GLONASS
BeiDou
X
X
–
–
X
X
X
–
X
X
–
X
X
–
X
–
X
–
–
X
–
X
X
–
–
X
–
X
–
–
X
X
Note: As of November 2016, BeiDou and Galileo are still under
development and not fully operational.
186
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Note: The augmentation systems SBAS and QZSS can be enabled
only if GPS operation is enabled.
Note: Should you select more than 3 + QZSS constellations, you
will receive a Constellation Error once you click Submit (ConstError).
Determining Which GNSS Satellites Are Received
To see which GNSS satellites your NetClock is currently receiving:
1. Navigate to INTERFACES > REFERENCES: GNSS 0.
2. The GNSS 0 status window will open:
3. Under Identified Satellite Signal Strengths hover with your cursor over the bars: The let
ter provided in the pop-up window for a signal reception bar indicates which con
stellation the satellite belongs to:
CHAPTER 3 • NetClock User Reference Guide Rev. 13
187
3.3 Managing References
Letter symbol
GNSS Constellation
G
GPS
R
GLONASS
E
Galileo
J
QZSS
C
BeiDou
I
IRNSS
Determining if the Multi-GNSS Option Is Installed
To check if the Multi-GNSS license is installed on your NetClock:
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. Under System Configuration, look for the Option OPT-GNS Multi-GNSS (you may need
to scroll to the bottom of the screen).
If the license is installed, you may proceed to "Selecting GNSS Constellations" on page 184.
If the license is not installed, and you are interested in purchasing it, please contact Spec
tracom.
3.3.2.11 A-GPS
A- GPS stands for Assisted GPS . This widely used technology involves providing additional
data to the GNSS receiver by an alternative means of communication (e.g., via IP, or by
manual data entry), thereby reducing the time for the receiver to acquire and track the actual
satellite signals. This may lead to a significantly shorter time for NetClock to deliver a GNSSbased timing signal upon a “cold start” of the unit.
The A-GPS client is used to send assistance data to the GPS receiver. This is most useful in areas
with poor GPS reception.
Note: The concept of an A-GPS server also exists: This functionality allows a NetC
lock to operate as a server, providing A-GPS ephemeris and almanac data to
other devices e.g., a Spectracom GSG- series GNSS simulator. Contact Spec
tracom for further information.
The A-GPS functionality is only available with the following GNSS receiver models:
Res-SMT GG
u-blox M8T
To determine which GNSS receiver model is installed in your NetClock unit, see "Determining
Your GNSS Receiver Model" on page 170.
188
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.3 Managing References
Configuring A-GPS
To configure the A-GPS settings of your NetClock unit, or review the current configuration:
1. Navigate to INTERFACES > GNSS Reference. The GNSS screen will be displayed.
2. In the GNSS Reference panel on the right, click the GEAR button next to GNSS 0.
3. In the GNSS 0 window, locate the A-GPS panel at the bottom:
Note: The options displayed on your screen depend on your system con
figuration.
4. Configure the settings as required:
Enable A-GPS Client
The feature Enable A- GPS Client will schedule assistance data to be collected and updated
every hour. On startup, if data is present, it will be sent to the receiver.
Apply A-GPS Data
When this option is selected, NetClock will immediately apply the time, position and satellite
data to the receiver once you click Submit.
Time and position are user- configurable; NetClock collects A- GPS satellite data from an
external source automatically. Note: Once you click Submit , any parameters entered under Apply A-GPS Data
will override the system Time and Position data. Exercise caution when using this
feature, since this could negatively impact the GNSS receiver operation.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
189
3.4 Holdover Mode
Use Current System Time
Apply NetClock's currently used system time to the GNSS receiver.
Set System Time
Enter a specific date and time, instead of the system time. This may be useful if the system time is
known to be incorrect, or if you need a time in the past or future, e.g. for simulation purposes.
Enter the date and time using the displayed calendar and time sliders.
Manual Position Set
By accurately entering latitude , longitude (both in decimal degrees), and altitude (in meters,
WGS 84) of your antenna, NetClock can use this data during the satellite tracking/adjustment
process, which typically leads to a quicker "fix". It is recommended to enter the position as
accurately as possible. For more information, see "Manually Setting the GNSS Position" on
page 181.
Note: When manually setting a position, NetClock must be in one of the sta
tionary modes, Standard or Single Satellite (see "Receiver Mode" above).
3.4
Holdover Mode
When input references have been supplying input to NetClock and input from all the references
has been lost, NetClock will not immediately declare loss of time synchronization, but first will
go into Holdover mode. While the unit is in Holdover mode, the time outputs are derived from
the internal 10 MHz oscillator incrementing the System Time, but the oscillator is not dis
ciplined/steered by the external reference e.g., GNSS.
Because of the stability of the internal oscillator, accurate time can still be derived even after all
the primary references are no longer valid or present. The more stable the oscillator is without
an external reference, the longer this holdover period can be and have it still maintain very
accurate outputs. The benefit of Holdover is that time synchronization and the availability of the
time outputs is not immediately lost when input references are no longer available.
While NetClock is in Holdover, the only difference is the Holdover and associated Minor
alarm are asserted. There are no changes to NTP or any of the other outputs, i.e. while in Hol
dover mode, NTP inside NetClock continues to be at the same Stratum level it was at before
going into Holdover mode (such as Stratum 1 when synced to GPS). Should the Holdover
period expire, however, or the unit is rebooted, the NTP Stratum will go to 16, preventing any
clients from being able to sync with NetClock until GPS or another reference has been restored.
How long will the unit remain in Holdover mode?
NetClock will remain in Holdover mode until either:
190
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.4 Holdover Mode
a. Any enabled and valid input reference becomes available again: If one or more ref
erences return and are declared valid before the Holdover period has expired (even
momentarily, i.e. for at least one second), NetClock exits the Holdover mode and returns
to its fully synchronized state.
b. The Holdover Timeout period expires. In this case, NetClock will declare loss of syn
chronization.
Note that Holdover mode does not persist through reboots or power cycles. If a reboot or
power cycle occurs while NetClock is in Holdover mode, it will power-up and remain in a “not
synchronized ” state until at least one valid Time and 1PPS input reference becomes available
again. While in this state, NTP will be Stratum 15 and outputs will not be usable. If the input ref
erences are restored and then lost or declared not valid again, NetClock will then go back into
Holdover mode.
What is "Holdover Timeout"?
Holdover Timeout is the user-configurable allowable time period in which NetClock remains in
Holdover mode before it declares loss of synchronization. Holdover Timeout can be adjusted
according to application- specific requirements and preferences. See below for recom
mendations on how long (short) the Holdover Timeout should be.
How to configure Holdover Timeout
To set the Holdover Timeout value:
Navigate to MANAGEMENT > OTHER: Disciplining, and click the GEAR icon in the
Status panel:
For more information on the TFOM value and Phase Error Limit, see "Configuring the
Oscillator" on page 195.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
191
3.4 Holdover Mode
Note: Changes made to the Holdover Timeout always take effect immediately. If
NetClock is in Holdover and the Holdover timeout is changed to a value that is
less than the current time period that NetClock has been in Holdover Mode, the
unit will immediately declare loss of synchronization.
What is the recommended setting for the Holdover Timeout period?
The factory default Holdover period is 2 hours (7200 seconds). The value can be increased up
to 5 years. During this time period, NetClock will be useable by its NTP clients (or other con
sumers) after GNSS reception has been lost.
The length of time is really based on the type of oscillator installed in a unit, and what the typ
ical accuracy requirements are for the NTP clients. The longer it can run in Holdover mode
before it expires, the longer it can continue being a central time source for all of its clients. But
the longer NetClock runs in Holdover, the larger the offset to true UTC time will become,
because the undisciplined oscillator will drift over time:
The better the type of oscillator installed, the more stable it is while in Holdover and therefore,
the less its time will drift away from true UTC time. This results in more accurate timing, over
extended durations upon the loss of GPS input. For instance, a Rubidium oscillator will main
tain significantly better time over a longer Holdover duration than a TCXO oscillator (TCXOs
are considerably less stable than a Rb oscillator).
Holdover time drift (Oscillator error rates)
The chart below provides typical time drifts (estimated "error rates") for the oscillator types that
can be found in NetClock units. These numbers are based on the oscillator being locked to a
reference for two weeks, but then loses GPS reception for an extended period of time, while
the ambient temperature remains stable.
This data can help you determine how long of a Holdover period can be tolerated, based on
how much time drift may occur after GPS input is lost. The larger the time error that can be tol
erated by NetClock clients, based on the oscillator installed, the larger the Holdover timeout
period can be set to.
Table 3-3: Estimated Holdover time drifts
(Nominal
drifts)
TCXO
OCXO
Low Phase Noise
OCXO
Rubidium
Low Phase Noise Rubid
ium
After 4 hours
12 µs
1µs
0.5 µs
0.2 µs
0.2 µs
After 24 hours
450 µs
25 µs
10 µs
1µs
1µs
After 7 days
3150 µs (3.1
ms)
175 µs
70 µs
7 µs
7 µs
After 30 days
13950 µs
775 µs
310 µs
31 µs
31 µs
To find out which type of oscillator is installed in your NetClock, navigate to MANAGEMENT >
OTHER: Disciplining, and look for the line item Oscillator Type in the Status panel.
192
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.4 Holdover Mode
Typical Holdover lengths
The length of the allowed Holdover Timeout period is displayed and configured in seconds.
The table below provides example conversions for typically desired Holdover periods.
Table 3-4: Typical Holdover lengths in seconds
Desired Holdover Length Holdover Length (in seconds) to be entered
2 hours
7200 seconds (default value)
24 hours
86 400
7 days
604 800
30 days
2 419 200
1 year
29 030 400
Note: Due to Leap Seconds that are periodically inserted into the UTC and Local
timescales, it is not normally recommended to exceed 30 days of Holdover
without an external reference that can supply Leap Second information being
applied (such as GNSS).
Configuring a Holdover value exceeding 30 days could result in a one second time error in
the UTC or Local timescales until an external reference (GNSS or IRIG input) is restored or a
manually configured Leap Second is asserted by a user (leap seconds do not affect the GPS
and TAI time scales).
If no external references (such as GNSS or IRIG) are available when a Leap Second is sched
uled to occur, manual Leap Seconds can also be applied to the UTC or Local time base; see
"Leap Seconds" on page 149.
If the Holdover Timeout has expired, do I need to reset the clock once GPS
becomes available again?
No, the Holdover timer is automatically reset as soon as at least one reference has been
restored/returned for at least one second. If GPS is restored and then lost again moments later,
the Holdover timer starts again with its full value. If its set to one week in this case, it then gets
another week of Holdover operation before NTP goes to Stratum 16 (if GPS remained unavail
able for the entire week).
Holdover mode and the User/User reference
If the only available input reference is a manually set User time, and NetClock is subsequently
rebooted or power cycled, time sync will be lost when NetClock powers back-up. The time will
need to be set manually again in order for NetClock to return to its fully synchronized state.
See "The "User/User" Reference" on page 161 and "Manually Setting the Time" on page 144
for more information.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
193
3.5 Managing the Oscillator
3.5
Managing the Oscillator
The purpose of the built-in oscillator is to provide NetClock with an accurate and very stable fre
quency source. This allows NetClock to go into a holdover mode in the event that external time
or frequency references are lost or become invalid. However, the oscillator can also be used as
a legitimate 1PPS reference during normal operation, in conjunction with an external time ref
erence (for more information, see "Configuring Input Reference Priorities" on page 157.)
NetClock’s internal oscillator is normally disciplined to an input reference (such as GNSS, IRIG
input, 1PPS input, etc.) in order to provide the highest degree of oscillator accuracy and to
account for oscillator drift. While disciplining (with a 1PPS input reference input present and
valid), the oscillator’s output frequency is monitored and based on the measured frequency, the
oscillator is steered to maintain a very accurate 10 MHz output. If no valid 1PPS input ref
erences are present (or input references are present but not considered valid), the oscillator will
be in Freerun mode instead.
If no external input reference such as GNSS, IRIG, etc. is available (or is temporarily lost),
NetClock may become an NTP Stratum 2 or higher reference. If so configured, NetClock can
use a reference such as an NTP daemon, or TimeKeeper, referred to as a Host Reference. If the
Host Reference becomes active, it will automatically take over the disciplining of the oscillator.
This built-in functionality is referred to as Host Disciplining.
Figure 3-2: Host disciplining
Note: Host disciplining is NOT supported by NetClock units that are equipped
with a Rubidium oscillator.
The Oscillators Settings page provides the user with some control of the disciplining process.
This page is also used to configure the length of time NetClock is allowed to remain in the Hol
dover mode when all references are lost.
194
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.5 Managing the Oscillator
3.5.1
Oscillator Types
NetClock units are available with different types of internal oscillators:
TCXO (Temperature-Compensated Crystal Oscillator)
one of two different types of OCXO (Oven-Controlled Crystal Oscillator) oscillators, or
one of two different types of Rb (Rubidium) oscillators.
The two different types of OCXO oscillators are a precision OCXO oscillator and a high-pre
cision (low phase noise) OCXO oscillator. The two different types of Rubidium oscillators are a
precision Rubidium oscillator and a low-phase noise Rubidium oscillator. All of these internal
oscillators are self-calibrating and can be disciplined to a 1PPS input reference for maximum
accuracy.
Because of its high degree of stability, the Rubidium oscillator provides the greatest ability to
extend the hold-over period when input references are not present. Extending the hold-over
period allows the unit to provide very accurate and useable time stamps and a 10 MHz output
for a longer period of time once time synchronization has been lost.
Note: Oscillators are installed at the factory, in accordance with order spe
cifications; an oscillator cannot be swapped/retrofitted later in the product life
cycle (with the exception of repairs).
The Rubidium oscillator is atomic in nature but requires no MSDS (Material Safety Data Sheet).
Note: External Oscillator: It is possible for an external oscillator to be locked to
NetClock's 10 MHz output via an external PLL, with the lock state of the external
PLL monitored by NetClock. Contact Spectracom for more information.
3.5.2
Configuring the Oscillator
3.5.2.1
About the "Time Figure of Merit (TFOM)"
The TFOM reflects the estimated error range values between the reference 1PPS (such as GPS
1PPS) and the System 1PPS which is being aligned to the 1PPS. The estimated error is referred
to as the 1PPS Phase error. TFOM values are ranges of these phase errors. The larger the
phase error estimate, the larger the TFOM value will be. For example, TFOM 3 is reported
when the estimated phase error is any value between 10 ns to less than 100 ns of the offset
between the selected 1PPS reference and the system’s 1PPS.
TFOM is NetClock’s estimation of how accurately it is synchronized with its time and 1PPS ref
erence inputs, based on several factors, known as the Estimated Time Error or ETE. The larger
the TFOM value, the less accurate NetClock believes it is aligned with its 1PPS input that is used
to perform disciplining. If this estimated error is too large, it could adversely affect the
CHAPTER 3 • NetClock User Reference Guide Rev. 13
195
3.5 Managing the Oscillator
performance of oscillator disciplining. The available TFOM range is 1 through 15. You may
refer to the following for the TFOM to ETE conversions:
Table 3-5: TFOM è ETE conversion
Reported TFOM Value
Estimated Time Error (ETE)
1
<= 1 nsec
2
1 nsec < ETE <= 10 nsec
3
10 nsec < ETE <= 100 nsec
4
100 nsec < ETE <= 1 μsec
5
1 μsec < ETE <= 10 μsec
6
10 μsec < ETE <= 100 μsec
7
100 μsec < ETE <= 1 msec
8
1 msec < ETE <= 10 msec
9
10 msec < ETE <= 100 msec
10
100 msec < ETE <= 1 sec
11
1 sec < ETE <= 10 sec
12
10 sec < ETE <= 100 sec
13
100 sec < ETE <= 1000 sec
14
1000 sec < ETE <= 10000 sec
15
ETE > 10000 sec
Example
TFOM is a value between 1 and 15. TFOM can never exceed the default MaxTFOM value of
15.
Typically the MaxTFOM requires no adjustment, but in some instances it may be advisable to
decrease MaxTFOM so that TFOM can potentially exceed it: For example, by lowering the
MaxTFOM to “5” it is now possible for TFOM to be always higher than the MaxTFOM value:
Assuming the MaxTFOM is set to 5 and the TFOM happens to go to a 6, i.e. TFOM is now
exceeding MaxTFOM. This condition will cause a 1PPS out of specification alarm to be asser
ted and the oscillator disciplining will change in order to speed-up the alignment of the sys
tem 1PPS to the selected reference (causing it to take less time getting closer into alignment with
the reference):
This will cause the TFOM to start to decrease faster. Once TFOM no longer exceeds MaxTFOM
because the System 1PPS is now much closer to the reference 1PPS , the disciplining slows back
down again as the system 1PPS continues to be brought into alignment with the selected 1PPS
input.
196
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.5 Managing the Oscillator
3.5.2.2
About the "Phase Error Limit"
Setting a limit (valid for +/-) for the phase error between external 1PPS reference and system
1PPS will cause the disciplining tracking to restart automatically (after a few minutes delay), if
the limit is exceeded, in order to quickly re-align the system 1PPS with a reference.
If you are using a Host Reference as a primary or backup reference, for improved per
formance it is recommended to set the phase error limit for NTP to a suggested value of
100000 ns (= 1 second). Adjust this value as needed, based on your accuracy requirements.
3.5.2.3
Configuring the Oscillator
To configure the oscillator:
1. To configure the oscillator settings, navigate to MANAGEMENT > OTHER: Disciplining.
2. Click the GEAR icon at the top of the Status panel. The Oscillators Settings window will
display:
3. Populate the fields:
Maximum TFOM for Sync : When TFOM (Time Figure of Merit, see below) is
greater than Max TFOM, disciplining will still be attempted against the selected
reference to improve the TFOM. If the condition persists, the system will transition
to holdover, and eventually out of sync. When disciplining is performed such that
TFOM is no longer greater than max TFOM, the system will transition back into
sync.
Holdover Timeout(s): The default is 7200 s (= 2 hours).
For more information on holdover timeouts, see "Typical Holdover lengths in
seconds" on page 193. For additional information on holdover, see "What is
"Holdover Timeout"?" on page 191.
Phase Error Limit: [Default=0 (disables the feature)]. See "About the "Phase Error
Limit"" above.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
197
3.5 Managing the Oscillator
Restart Tracking: Check this box, and click Submit if you want to manually restart
disciplining tracking.
This option causes the disciplining algorithm to stop tracking the input reference
and start over (as if it was just acquired). This can be useful if there is a large
phase offset between reference 1PPS and system 1PPS, as it may occur when
going back into sync to the external reference after a long holdover. A Restart
Tracking will re-align the system 1PPS with the reference 1PPS very quickly, but
may cause the 1PPS output to jump.
Recalibrate: In rare cases, existing calibration data may no longer be suitable to
calibrate the oscillator. This function will delete the existing calibration data, and
begin a new calibration process (not applicable for low phase-noise Rubidium
oscillators).
4. Click Submit.
3.5.3
Monitoring the Oscillator
The Oscillator Management screen provides current and history status information on dis
ciplining state and accuracy.
To access the Oscillator Management screen:
1. Navigate to MANAGEMENT > OTHER: Disciplining.
2. The Oscillator Management screen will display. It consists of two panels:
The Oscillator Status Panel
198
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.5 Managing the Oscillator
This panel provides comprehensive information on the current status of NetClock's timing state.
Oscillator Type: Type of oscillator installed in the unit.
Disciplining State: State of oscillator control and disciplining; indicates whether or not the
internal oscillator is currently being disciplined (steered to an input reference). The states
are: "Warm up", "Calibration", "Tracking Setup", "Lock State", "Freerun", and "Fault".
1PPS Phase Error: A tracking measurement [scaled time, in ns, or ms] of the internal
1PPSs' phase error with respect to the selected input reference. Long holdover periods
or an input reference with excessive jitter will cause the phase error to be high. The oscil
lator disciplining control will gradually reduce the phase error over time. Alternatively,
restarting the tracking manually (see "Restart Tracking" under "Configuring the Oscil
lator" on page 195), or automatically via a pre-set Phase Error Limit, will quickly reduce
the phase error.
10 MHz Frequency Error: An internal estimated calculation (in Hertz) of the internal oscil
lator's frequency error, based on the phase accuracy error at the beginning and end of
a frequency measurement window (the length of this window will vary depending upon
the type of oscillator installed and the oscillator adjustment algorithm).
Current DAC Setting: Current DAC value, as determined by the oscillator disciplining sys
tem. The value is converted into a voltage that is used to discipline the oscillator. A stable
value over time is desirable and suggests steady oscillator performance (see also the
graph in the History Panel).
DAC Step: Step size for adjustments to the internal oscillator, as determined by the oscil
lator disciplining system. Larger steps = quicker, but coarser adjustments. The step size is
mainly determined by the type of oscillator.
TFOM: The Time Figure of Merit is NetClock’s estimation of how accurately the unit is syn
chronized with its time and 1PPS reference inputs, based on several factors, known as
the Estimated Time Error or ETE. The larger the TFOM value, the less accurate NetClock
believes it is aligned with its 1PPS input that is used to perform disciplining. If this estim
ated error is too large, it could adversely affect the performance of oscillator dis
ciplining. The available TFOM range is 1 through 15.
Max TFOM for Sync: Value, as set under "Configuring the Oscillator" on page 195
Temperature(s): Three temperatures are displayed:
Oscillator temperature, which has an effect on oscillator accuracy, and therefore
can be used to interpret oscillator performance.
Board temperature (measured on the main board, sometimes also referred to as
'System temperature')
CPU temperature
CHAPTER 3 • NetClock User Reference Guide Rev. 13
199
3.5 Managing the Oscillator
Note: Oscillator temperature is plotted over time in the History panel
on the right, while graphs for board and CPU temperature can be
found under TOOLS > SYSTEM: System Monitor.
Note that a temperature sensor started being added to NetClock Model 9483s in 2012
(the Model 9489s do not have this sensor installed). Model 9483s purchased prior to
this hardware change being implemented will not be able to report the internal tem
perature, even with software update versions 5.2.0 or above installed.
For more information, see "Temperature Management" on page 272.
Last Time Reference Change: [Timestamp: Last occurrence]
Last 1PPS Reference Change: [Timestamp: Last occurrence]
Last TFOM Change: [Timestamp: Last occurrence]
Last Sync State Change: [Timestamp: Last occurrence]
Last Holdover State Change: [Timestamp: Last occurrence]
The Oscillator History Panel
The Oscillator History Panel offers real-time graphical monitoring of NetClock’s internal tim
ing. The following graphs plot key oscillator-relevant data over time::
Phase Error Magnitude: See 1PPS Phase Error
Frequency Error : See 10_MHz_Frequency_Error
Scaled DAC Value: See DAC Step
Oscillator Temperature, which has an effect on oscillator accuracy, and therefore can
be used to interpret oscillator performance. See also "Temperature Management" on
page 272, "The Oscillator Status Panel" on page 198.
You can zoom in on any of the graphs by grabbing the handles at either end and pulling them
inwards. The graph will focus in on the time interval you choose in real time.
Clicking on the Delete icon in the top-right hand corner will erase all current oscillator log data.
Clicking on the Download arrow icon will download the latest oscillator log data as a . csv
file.
3.5.4
Oscillator Logs
To export, or delete the oscillator logs:
1. Navigate to MANAGEMENT > OTHER: Disciplining.
200
CHAPTER 3 • NetClock User Reference Guide Rev. 13
3.5 Managing the Oscillator
2. To download the log file: In the History panel, click the downwards pointing ARROW
icon. in the top-right corner. The log file will be downloaded onto your local computer.
Its name is oscillatorStatusLog.csv. Depending on the operating system you
can open the file, or save it locally.
To delete the log file, click the TRASH CAN icon, and confirm.
CHAPTER 3 • NetClock User Reference Guide Rev. 13
201
3.5 Managing the Oscillator
BLANK PAGE.
202
CHAPTER 3 • NetClock User Reference Guide Rev. 13
CHAPTER 4
SYSTEM ADMINISTRATION
The following topics are included in this Chapter:
4.1 Powering Up/Shutting Down
204
4.2 Notifications
207
4.3 Managing Users and Security
215
4.4 Miscellanous Typical Configuration Tasks
239
4.5 Quality Management
249
4.6 Updates and Licenses
293
4.7 Resetting the Unit to Factory Configuration
296
CHAPTER 4 • NetClock User Reference Guide
203
4.1 Powering Up/Shutting Down
4.1
Powering Up/Shutting Down
4.1.1
Powering Up the Unit
1. After installing your NetClock unit, verify that power is connected, then turn ON the unit
using the switch on the rear panel, and wait for the device to boot up.
Note: NetClock 9483 only: DC input power is not switched, so NetClock
will be powered up with DC input connected, unless you installed an
external power switch.
2. Observe that all of the front panel LEDs momentarily illuminate (the Power LED will then
stay lit) and that the Information display LCD back light illuminates. The fan may or may
not run, depending on the model year of your NetClock unit. For more information, see
"Temperature Management" on page 272.
NetClock 9483 only:
The time display will reset and then start incrementing the time. About 10 seconds after
power-up, “Starting up NetClock” will be displayed in the information display. After
approximately 2 minutes, the information display will then show the current network set
tings.
By default, the 4-line information display shows the unit’s hostname, IPv4 address, mask,
and gateway.
The time display shows the current time: UTC (default), TAI, GPS or local timescale, as
configured.
Figure 4-1: NetClock front panel
3. Check the front panel status LED indicators:
The Power lamp should be solid green.
The Sync lamp will probably be red, since synchronization has not yet been
achieved.
204
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.1 Powering Up/Shutting Down
The Fault lamp will be OFF, or solid orange, indicating a minor alarm, or solid
red, asserting a power-up frequency error alarm (until the disciplining state is
reached.)
For additional information, see "Status LEDs" on page 8 and "Status Monitoring via Front
Panel" on page 249.
4.1.2
Shutting Down the Unit
Shutting down NetClock by interrupting the AC and/or DC power supply is acceptable and
will not damage the unit.
It is, however, worthwhile to point out the differences between shutting down the unit by inter
rupting the power supply vs. gracefully shutting it down e.g., via the Web UI.
To learn more, see "Issuing the HALT Command Before Removing Power" below.
For more information on AC and DC supply power, see "Power Source Selection" on
page 36.
4.1.3
Issuing the HALT Command Before Removing Power
Gracefully shutting down NetClock by using the HALT command offers the following advant
ages over shutting the unit down via the AC ON/OFF switch (see"NetClock 9400 Series Rear
Panels" on page 10), or otherwise interrupting the AC or DC supply power:
The shutdown process will be logged
The System Clock will update the Real Time Clock with the latest System Time.
NetClock's file system will be synchronized, which under some circumstances will allow
for faster startup next time the unit will be powered up again.
The HALT command may be issued to the NetClock via:
the Web UI
the front panel keypad
the front panel serial port.
Note: Wait 30 seconds after entering the HALT command before removing
power.
Once the HALT process has been initiated via the Web UI or front panel, the front panel LCD
will display Power off NetClock, and the front panel LED time display will stop incrementing.
Issuing a HALT Command via the Web UI
1. Navigate to TOOLS > SYSTEM: Reboot/Halt.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
205
4.1 Powering Up/Shutting Down
2. The Reboot/Halt window will display. Select the Shutdown the Unit checkbox.
3. Click Submit.
4. Wait 30 seconds after entering the HALT command before switching off the unit .
Once the HALT process has been initiated, the front panel LCD will display Power offNetClock,
and the front panel LED time display will stop incrementing.
Issuing a HALT Command via Keypad/SerialPort/Telnet/SSH:
The HALT command can be initiated not only via the NetClock Web UI, but also via the keypad
and LCD display. For more information on the keypad, see "Keypad and Information Display"
on page 6.
With a serial connection to the front panel serial port, telnet connection or SSH connection,
type halt <Enter> to halt the unit for shutdown. For more information on NetClock commands,
see "CLI Commands" on page 364.
Once the HALT process has been initiated, the front panel LCD will display Power off NetClock,
and the front panel LED time display will stop incrementing.
Note: After issuing the HALT command wait 30 seconds before you remove
power.
4.1.4
Rebooting the System
To reboot NetClock via the Web UI:
1. Navigate to TOOLS > SYSTEM: Reboot/Halt.
206
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.2 Notifications
2. Select the Restart after Shutdown box in the Reboot/Halt window.
3. NetClock will now be rebooted and be accessible again shortly thereafter.
Rebooting via LCD/Keypad, Serial Port, Telnet, SSH, SNMP
The Reboot command can be initiated not only via the NetClock Web UI, but also via the
keypad and LCD information display. See "Keypad and Information Display" on page 6 for
information on using the keypad to perform a system reboot.
With a serial connection to the front panel serial port, telnet connection or SSH connection,
type reboot <Enter> to reboot NetClock.
Reboot is also is available to be performed through an snmpset operation. For more inform
ation on NetClock commands, see "CLI Commands" on page 364.
Once the Reboot process has been initiated, the front panel LCD will display a Power off mes
sage, and the front panel LED time display will stop incrementing until NetClock has started
booting back up again.
4.2
Notifications
If an event occurs e.g., NetClock transitions into Holdover, or a short is detected in the GNSS
antenna, NetClock can automatically notify users that a specific event has occurred.
In some situations, two events are generated. One event occurs in the transition to a specified
state and then another event occurs when transitioning back to the original state. Examples of
these are losing sync and then regaining sync, or going into Holdover mode and then going
out of Holdover mode. Other situations may only consist of one event. An example of this situ
ation is switching from one input reference to another.
Notifications of each event that may occur can be via alarms, via SNMP Traps being sent to
one or more SNMP Managers, via an email being sent to a specified email recipient, or a com
bination of the three. The Notifications page allows a user to configure whether the occurrence
of each event automatically triggers an alarm to be generated, an SNMP trap to be sent out,
an email to be sent out, or a combination of the three.
Also, this page allows the desired email recipient’s address for that particular event to be spe
cified. Each event can be configured with the desired email address that is specific to just that
one event only. Note that only one email address can be specified in each Email Address field.
If desired, the same email address can be used in all of the fields, or different addresses can be
used for different events.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
207
4.2 Notifications
Note: Whether or not notifications are enabled/disabled for a given event, the
occurrence of the event is always logged.
All available NetClock events that can generate a notification to be sent are located under dif
ferent tabs in the Notification Events panel: Timing, GPS , and System .
The NetClock Events that can automatically trigger a notification are listed in the Event column.
It is possible to:
Mask the alarm generation for specific events (prevent the alarm)
Enable “SNMP” (to send out an SNMP trap)
Send an email to the address specified in the corresponding “Email Address” column.
4.2.1
Configuring Notifications
To configure Notifications:
1. Navigate to MANAGEMENT > OTHER: Notifications . The Notifications screen will dis
play:
It is divided into two panels:
The Actions panel, featuring:
The SNMP Setup button: See "SNMP" on page 79.
The Email Setup button: Configure NetClock's interface settings for
Exchange email servers and Gmail.
For more information on this subject, see the Spectracom Technical Note
Email Notification Setup.
208
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.2 Notifications
The Events panel, offering three tabs:
Timing : Events for Sync Status and Holdover, Frequency error, Input ref
erences and the internal oscillator.
GPS : Events related to the GNSS receiver, including antenna cabling, track
ing less than the minimum number of satellites and GNSS receiver faults.
Systems : Events related to the system operation, including minor and
major alarms being asserted, reboot, timing system errors and option
cards.
2. In the Events panel, choose the Timing, GPS or System tab. Configure your Noti
fications (see below), and click Submit.
The columns under each tab are:
Event—This is the event that will trigger the notification. The events under each tab
will vary according to context.
Mask Alarm —Check here to enable an alarm mask. Enabling an alarm mask for
a given notification will prevent that notification from generating an alarm con
dition. Other notifications for that event and logging of the event will still occur.
SNMP Trap—Check here to configure the event to trigger an SNMP Trap.
Email—Check here to configure the event to trigger an email notification.
Email Address — Enter the address to which the email should be sent when
triggered by the event.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
209
4.2 Notifications
Note: Each event can be configured with the desired email address that is
specific to just that one event only. Note that only one email address can
be specified in each Email Address field.
For each event choose the notification you want and an email address – if any – to
which you want the notification to be sent. For more information, see "SNMP" on
page 79 and "Setting Up Email Notifications" on page 213.
For each event, only the notification options available can be configured. For example,
a mask alarm can be set for an In-Sync event, and a Not-in-Sync event, but not for an InHoldover event.
4.2.2
Notification Event Types
The following types of events can be used to trigger notifications:
4.2.2.1
Timing Tab: Events
In Sync
Not In Sync
In Holdover
No Longer in Holdover
Frequency Error
Frequency Error Cleared
1PPS Not In Specification
1PPS Restored to Specification
Oscillator Alarm
Oscillator Alarm Cleared
Reference Change (Cleared)
Reference Change
4.2.2.2
GPS Tab: Events
Too Few GPS Sat, Minor Alarm
Too Few GPS Sat, Minor, Cleared
Too Few GPS Sat, Major Alarm
Too Few GPS Sat, Major, Cleared
210
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.2 Notifications
GPS Antenna Problem
GPS Antenna OK
GPS Receiver Fault
GPS Receiver Fault Cleared
Under the GPS Events tab, you can also configure Minor and Major Alarm Thresholds for
GNSS fault events; see "Configuring GPS Notification Alarm Thresholds" below.
4.2.2.3
System Tab: Events
Minor Alarm Active
Minor Alarm Inactive
Major Alarm Active
Major Alarm Inactive
Unit Reboot
Timing System Software Error
Timing System Hardware Error
High Temperature, Minor Alarm
High Temperature, Minor, Cleared
High Temperature, Major Alarm
High Temperature, Major, Cleared
4.2.3
Configuring GPS Notification Alarm Thresholds
NetClock allows you to configure Minor and Major alarm thresholds for the GNSS receiver.
This is done by setting the minimum number of satellites the receiver can track for a set time
before an alarm is triggered. If both conditions are met, i.e. the reception quality falls below
the set number of satellites for the set amount of time, an alarm is triggered.
The alarm notification feature described below allows you to be notified of a potential recep
tion issue BEFORE the GNSS reference becomes invalid. This may be useful e.g., to notify sys
tem operators of a deteriorating signal reception before NetClock possibly losing the GNSS
reference.
Note that NetClock itself has a pre-defined minimum number of satellites that must be tracked in
order for GNSS to be considered a valid reference. The minimum number of satellites depends
e.g., on your receiver mode (see "Selecting a GNSS Receiver Mode" on page 172), the GNSS
signal reception in the area where your antenna is located, and the receiver type. For SAASM
units and in Stationary Mode, the minimum number of satellites is normally 4 (four). Hence, it
would be suggested to set the Minor Alarm Threshold to 8, and the Major Alarm Threshold to
6.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
211
4.2 Notifications
Note: While GPS Notification Alarms can be used in Mobile GNSS Receiver
Mode, it is not advisable.
To determine which GNSS Receiver Mode your NetClock is using, see "Selecting a GNSS
Receiver Mode" on page 172.
To determine how many satellites your NetClock unit is currently receiving, navigate to
INTERFACES > REFERENCES: GNSS 0 . See also "Reviewing the GNSS Reference Status" on
page 167.
To set the GPS Alarm Thresholds:
1. Navigate to MANAGEMENT > OTHER: Notifications , and choose the GPS tab.
2. At the bottom of the window, locate the ALARM THRESHOLD panel:
3. In the Minimum Satellites fields enter the minimum number of satellites that must be avail
able before the alarm is triggered. The alarm will be triggered when the number of satel
lites available is BELOW this number.
4. In the Duration Below Threshold (s) fields, enter the time in seconds that the system must
be below the threshold set in the Minimum Satellites field before an alarm is triggered.
The alarm will be triggered when this time is reached.
By default, this timeout value is set to 0 seconds: As soon as the receiver drops below the
minimum number of satellites, the associated alarm is triggered. A delay of e.g., 5
seconds, however, would not trigger an alarm if the number of received satellites drops
below the specified number for only 3 seconds.
You can configure this event to cause either a Minor alarm, or a Major alarm, or both.
To learn more about Minor and Major alarms, see "Minor and Major Alarms" on page 309.
Note that the GNSS receiver must initially be tracking more than the configured number of satel
lites in order for this alarm to be triggered (the alarm is triggered when the receiver falls below
the number of Minimum Satellites you specified above).
4.2.4
Setting Up SNMP Notifications
SNMP Notifications are SNMP traps that occur on a change of a monitored event.
To configure SNMP notifications:
212
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.2 Notifications
1. Navigate to MANAGEMENT > OTHER: Notifications .
2. In the Actions panel, click SNMP Setup.
For more information on SNMP, see "SNMP" on page 79.
4.2.5
Setting Up Email Notifications
The Email Setup window provides a means to configure NetClock with the necessary settings to
interface it with Exchange email servers and Gmail.
To set up Notification Emails:
1. Navigate to MANAGEMENT> OTHER: Notifications .
2. In the Actions panel of the Notifications screen, click * Email Setup.
3. The Email Setup window will display:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
213
4.2 Notifications
The Email Configuration box provides two example configuration files. One is for inter
facing NetClock with an Email Exchange server; and the other is for sending emails via
Gmail:
4. To configure the applicable example email configuration, delete the comments (“#”)
from each line and replace the “<>” with the appropriate values for your particular
email server (such as the user name and password for your Email server).
Ex am ple
I:
S MT P
i nter f ac e
to
MS
Ex c hange
#set smtp=<server name, example: exchange.example.com>
#set smtp-auth-user=<user name>
#set smtp-auth-password=<password>
#set smtp-auth=login
Ex am ple
II:
S MT P
i nter f ac e
to
Gm ai l
#set smtp=smtp.gmail.com:587
#set smtp-use-starttls
#set ssl-verify=ignore
#set smtp-auth-user=<user name, example user_xyz123@gmail.com>
#set smtp-auth-password=<password>
#set smtp-auth=login
5. Click the Submit button at the bottom of the window.
6. To test your settings:
In the Test Email Address field, enter an email address.
Click the Send Test Email button.
A notification that your email has been sent will appear at the top of the window.
214
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
4.3
Managing Users and Security
4.3.1
Managing User Accounts
Users need to authenticate as the login to NetClock. The system administrator is responsible for
maintaining a list of user accounts (user names, passwords etc.) via the MANAGEMENT >
OTHER: Authentication screen of the NetClock Web UI (HTTP/HTTPS). Note that user accounts
CANNOT be created or edited via CLI commands using telnet or SSH.
To read more about how to login to the Web UI, see "Accessing the Web UI" on page 52.
4.3.1.1
Types of Accounts
"user" accounts:
User accounts are read-only accounts, i.e. they do not allow any editing rights and are restric
ted to reviewing status-related information. The Web UI will not show (or gray-out) any editing
functionality.
"admin" accounts:
Administrator accounts are intended to be used by system administrators. These accounts have
writing access. You can add additional admin accounts to the pre- installed administrator
account spadmin.
"factory" account:
The default factory account with the username spfactory is meant to provide access to Spec
tracom technical support personnel. You can delete this account, if you so prefer. Note, how
ever, that executing the Clean and Halt command (see "Cleaning the Configuration Files and
Halting the System" on page 302) will recreate the Factory account.
4.3.1.2
Rules for Usernames
Length: Usernames can be between 3 and 32 characters long.
Accepted characters:
All letters, including the first, must be lower-case.
Numbers, underscores and dashes are accepted.
Next to punctuation symbols, the following special characters are NOT accepted:
!@#$%^&*()
CHAPTER 4 • NetClock User Reference Guide Rev. 13
215
4.3 Managing Users and Security
4.3.1.3
Adding/Deleting/Changing User Accounts
To access the Users list, and the Password Security panel:
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. The Users panel on the right shows a list of all user accounts, including their Username,
the Group to which that user account is assigned to, and any Notes about the user
account:
NetClock units are shipped with two default accounts:
i. The "administrator" account (spadmin), and
ii. The "factory" service account (spfactory).
Additional accounts may be added and deleted as desired. The number of accounts that can
be setup is virtually unlimited.
Note: The password for the spadmin account can be changed (and it is recom
mended to do so for security reasons). However, the spadmin account name
cannot be changed, and the account cannot be removed from NetClock.
Note: The spfactory account is for use by Spectracom service personnel.
While the spfactory account can be deleted by an administrator, it should
be noted that this may potentially limit remotely provided technical support.
User accounts can be created to have either limited user or full administrator rights. Each user
can be assigned his own login password.
To ADD a user account, click the PLUS icon in the top-right corner of the Users screen.
To DELETE a user account, click the Delete button in that account’s entry on the Users
screen.
To APPLY CHANGES to a user account, click the Change button next to the desired user
account.
When either the Change button or the PLUS icon is clicked, the Add or Change User window
appears:
216
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
To add a user account:
1. Enter a Username. (For rules, see "Rules for Usernames" on page 215.)
2. Enter a Password. The password requirements are configurable, see "Configuring Pass
word Policies" on page 220. By default a password can be any combination of upperand lower-case characters. Minimum password length = 8 characters, maximum length =
32 characters.
3. Repeat the new Password.
4. In the Group field, choose the permission group to which you want the user to belong to:
user or admin. The user permission level assigns permission to access and change all set
tings, with the following exceptions that are limited to the admin accounts:
Changing network settings
Adding and deleting user accounts
Web Interface Settings
Upgrading NetClock system software
Resetting the NetClock configuration
Clearing log files
Changing Disciplining Setup options
Changing configuration options for the following protocols or features:
NTP
HTTPS, SSH
LDAP/RADIUS
SNMP (with the exception of configuring SNMP notifications).
To change an existing user account:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
217
4.3 Managing Users and Security
1. In the Add or Change User window the Username field will be populated.
a. To change it, type the new name.
b. To change the user account’s password, type the new password in the Password
field and confirm it in the Repeat New Password field. Note that the password
requirements are configurable, see "Configuring Password Policies" on
page 220.
c. To change the user account’s user permission group, select the group from the
drop-down menu.
4.3.2
"user" Account Permissions
As outlined in "Managing User Accounts" on page 215 – unlike "administrator" accounts –
"user" accounts are read-only accounts, i.e. they do not allow any editing rights and are restric
ted to reviewing status-related information.
Otherwise, the privileges assigned to admin groups are exactly the same whether logging in
via the Web UI, or connecting via SSH.
4.3.2.1
Account Differences, General
While most menus look the same to "admin" and "user" type accounts (except the
MANAGEMENT menu, see below), the screens and panels located below the main menus will
differ in such that the "user" UI will show fewer (if any) configuration options:
The status information presented, however, will be largely identical.
The most significant differences are visible in the MANAGEMENT menu, since most of the Setup
menus are hidden from "user" accounts:
218
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
4.3.2.2
Account Differences, by Menu
INTERFACES Menu
"user" and "admin" accounts can view and modify all settings in these pages (can view/edit
GNSS receiver, Outputs, and Option Cards).
MANAGEMENT Menu
Network : While the toggle switches in the Network Services panel are displayed, "user" can
not modify any of the network- related configurations (such as telnet, FTP, SSH and
HTTP/HTTPS). The switches can be moved, but an error message will be displayed shortly there
after.
Authentication: "user" can access this page but can only change his/her own password. Users
cannot create any new accounts and cannot modify any accounts.
Reference Priority: "user" can access this page and modify settings.
Notifications : "user" can access this page and modify settings.
Time Management: "user" can access this page and modify settings.
Front panel: "user" can access this page and modify settings.
Log Configuration: "user" can access this page and modify settings.
Disciplining: "user" can access this page and modify settings.
Change my password: "user" can access this page and change only their password.
TOOLS Menu
Logs : "user" can view only the listed logs
Upgrade/Backup: "user" cannot perform any updates.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
219
4.3 Managing Users and Security
Reboot/Halt: "user" cannot reboot/shutdown/halt the unit.
4.3.3
Configuring Password Policies
To configure password requirements e.g., rules for minimum password length and special char
acters:
1. Access the Authentication page by navigating to MANAGEMENT > OTHER: Authentic
ation.
2. In the Actions panel, click Security Policy.
3. The Password Security window will display. Fill in the self-explanatory fields and click
Submit.
4.3.3.1
The Administrator Login Password
The factory default administrator password value of admin123 can be changed from the
default value to any desired value. If the current password is known, it can be changed using
the NetClock Web UI.
220
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
Note: To follow this procedure, you must be logged in as the spadmin user. If
you are unable to login as spadmin, follow the procedure outlined in "Resetting
the Administrator Password When Forgotten/Lost" below.
If the password has already been changed from the default value, but the current value is no
longer known, the administrator password can be reset back to the factory default value, see
"Resetting the Administrator Password When Forgotten/Lost" below. Once reset, it can then be
changed to a new desired value via the Web UI.
Changing the admin password
To change the admin password from a known value to another desired value:
1. Navigate to MANAGEMENT > OTHER: Change My Password.
2. The Change Password window will display.
3. In the Old Password field, type the current password.
4. In the New Password field, type the new password.
Note: The new password can be from 8 to 32 characters in length.
5. In the Repeat New Password field, retype the new password.
6. Click Submit.
4.3.3.2
Resetting the Administrator Password When Forgotten/Lost
If the current spadmin account password has been changed from the default value and has
been forgotten or lost, you can reset the spadmin password back to the factory default value of
admin123.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
221
4.3 Managing Users and Security
Resetting the spadmin account password does not reset any user-created account passwords.
This process only resets the spadmin account password.
Any user with administrator rights can reset the spadmin password through the
MANAGEMENT > OTHER: Authentication window.
Changing the "spadmin" password via Web UI
To change the spadmin password:
1. Navigate to the MANAGEMENT > OTHER: Authentication window.
2. Locate the spadmin entry in the Users table.
3. Click the CHANGE button.
4. In the Add or Change User window:
1. Enter a new password.
Note: The new password can be from 8 to 32 characters in length.
2. Confirm the new password.
3. Click Submit.
222
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
If you do not have access to NetClock through another admin account, the spadmin password
must be reset via the front panel keypad or using the front panel serial port.
Resetting the "spadmin" account password via the keypad:
1. Use the front panel LCD and the keypad to perform a RESETPW . See also "Keypad and
Information Display" on page 6. (RESETPW is located in the Home/System menus).
2. You will be prompted to confirm the operation before the password is reset. The spad
min account password is now reset to “admin123”.
To reset the "spadmin" account password via the serial port, or SSH:
1. Connect a PC to the front panel serial port, and log in using an account with admin
group rights (such as the spadmin account).
2. Type: resetpw <Enter>. The spadmin account password is now reset.
After resetting the password follow the procedure above to change the spadmin password in
the MANAGEMENT > OTHER: Authentication window.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
223
4.3 Managing Users and Security
4.3.4
LDAP Authentication
LDAP (Lightweight Directory Access Protocol) authentication provides the means to use an
external LDAP server to authenticate the user account credentials when logging in to NetClock.
LDAP allows the login password for user-created accounts to be stored and maintained in a
central LDAP or server on the network. This function greatly simplifies password management.
Instead of having to change the password in many network appliances when a password needs
to be changed, if a user password is changed in the LDAP server, it automatically changes the
login password for all of the appliances that are using the LDAP server to authenticate a user
login.
In order to use the LDAP authentication capability of NetClock, it needs to first be configured
with the appropriate settings in order to be able to communicate with the LDAP server(s) on the
network.
Caution: If you plan on using LDAP, configure it with diligence. If not required,
Spectracom recommends to keep LDAP disabled.
Configuring LDAP authentication
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel, click the LDAP Setup button.
224
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
3. The LDAP Setup window will display.
4. There will be 5 tabs from which to choose:
Settings : This is where you set up the general LDAP Distinguished Name and Bind
settings.
Security: This is where you upload and manage the CA server certificate, CA cli
ent certificate and CA client key.
Group: This is where you enable/disable group-based authentication.
Advanced: This is where you set up your search filter(s) and login attribute.
Servers : This is where you identify the LDAP server to be used.
LDAP Settings
Under the LDAP Settings tab, set the following parameters:
Server Type: This must be the correct type—check with your LDAP server administrator if
you are not sure which you are using. You have a choice of:
Active Directory: This will be used when the LDAP server is a Windows server.
Open LDAP: This will be used when the LDAP server is a Linux/UNIX server.
Server Base DN: Specifies the default base distinguished name to use for searches. This
is the base name to use in the database search. Typically, this is the top-level of the dir
ectory tree structure. Your LDAP server administrator will provide this information.
Bind DN: Enter the Distinguished Name used to bind to (this is an optional field if the
database allows anonymous simple authentication). You are able to use any same level
of the tree and everything below.
The bind DN is the user that is permitted to search the LDAP directory within the
defined search base. Most of the time, the bind DN will be permitted to search the
CHAPTER 4 • NetClock User Reference Guide Rev. 13
225
4.3 Managing Users and Security
entire directory. The role of the bind DN is to query the directory using the LDAP
query filter (as specified under the Advanced tab) and search base for the DN
for authenticating users. When the DN is returned, the DN and password are
used to authenticate the user.
Bind Password: Enter the password to be used to bind with the LDAP Server. Leave this
field empty for anonymous simple authentication.
NSS Password: Enter the password to be used for nss_base and nss_shadow.
Example: ou=People,dc=example,dc=com?one.
Port: The port number of the LDAP server (default port numbers: regular LDAP = 389;
secure LDAP = 636)
Checkbox Auto-follow Referrals : Allow the use of LDAP referrals to be utilized in order
to access locations that more likely hold a requested object.
LDAP Security Settings
Under the LDAP Security tab, you can upload and install the SSL required certificates and NTP
client key. If your LDAP server requires secure communications with its "clients" (i.e. the use of
SSL), the Server Certificate , the Client Certificate , and the Client Key must be uploaded to
NetClock here.
You may upload a server certificate, a client certificate, or a client key.
For each:
a. If necessary, create the desired certificate or client key. See "NTP Autokey: IFF Autokey
Support" on page 108 for information on client keys.
b. Click the INFO icon for the certificate you wish to upload.
c. In the Certificate window, click the Choose File button.
226
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
d. Locate and upload the certificate or client key file.
e. Click Submit.
The SSL certificates and/or client key you upload will be installed in the /home/spectracom/xfer/cert/ directory.
Use the checkbox Enable Security if you want to enable SSL security, i.e. use Secure LDAP.
Use the checkbox Clean Security Certificates to remove all certificates currently stored on NetC
lock (e.g., to eliminate expired certificates).
LDAP Group Settings
Under the LDAP Group tab, you can filter access by group.
To enable group authentication:
a. Select the Enable group filter checkbox.
b. Enter information for:
Required Group—Enter the required group. Example. : ou=Group,
dc=example, dc=com.
Group Attribute—Enter the group attribute. Example: member.
NSS base group—Enter the nss_base group. Example: ou=Group, dc=example,
dc=com?one.
c. Click the Submit button.
LDAP Advanced Settings
CHAPTER 4 • NetClock User Reference Guide Rev. 13
227
4.3 Managing Users and Security
Under the LDAP Advanced tab, you can set the search filter and the LDAP login attribute.
Fill in the following fields, as desired:
Search filter —This is the LDAP search filter. Example: objectclass=user.
Login Attribute—This is the LDAP login attribute. Example: sAMAccountName.
Verify Certificate (checkpeer) —Select this checkbox if you wish to turn on checkpeer
authentication.
LDAP Servers Settings
Under the Servers tab, you manage the LDAP server(s) to be accessed:
Under the LDAP Servers tab, the window displays:
Server —The hostname(s) or IP address(es) of the LDAP server(s) that have been added.
Action—After a server has been listed, it can be removed by clicking the X-button.
LDAP Server Status —This will display one of the following states:
PASS (green)—An LDAP server that has been set up is available and is able to
pass data.
CONFIGURATION MISSING (red)—No configuration files are available.
FAILED TO READ DATA (red)—An LDAP server is available but no data was
passed.
FAILED NOT REACHABLE (red)—No LDAP server could be reached.
LDAP DISABLED—The Enabled checkbox under the Settings tab as not been selec
ted.
228
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
Add additional server —Enter the hostname or IP address of the LDAP server to be quer
ied. You may list multiple servers.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
229
4.3 Managing Users and Security
4.3.5
RADIUS Authentication
RADIUS authentication provides the means to use an external RADIUS server to authenticate the
user accounts when logging in to NetClock. RADIUS allows the login password for user-created
accounts to be stored and maintained in a central RADIUS or server on the network. This func
tion greatly simplifies password management. Instead of having to change the password in
many network appliances when a password needs to be changed, if a user password is
changed in the RADIUS or RADIUS server, it automatically changes the login password for all
of the appliances that are using the RADIUS server to authenticate a user login.
In order to use the RADIUS authentication capability of the NetClock, it needs to first be con
figured with the appropriate settings in order to be able to communicate with the RADIUS
server(s) on the network.
Configuring RADIUS Authentication
To configure RADIUS authentication:
Note: It is necessary to enable HTTP/HTTPS first, then enter the configuration para
metes in a second step. See below.
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel, click the RADIUS Setup button.
3. The Radius Setup window will display:
230
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
4. Select the HTTP/HTTPS checkbox, so as to enable HTTPS.
5. Click Submit, to enable Radius authentication.
6. In the Actions panel, click the RADIUS Setup button again.
7. In the Radius Setup window, enter your configuration parameters.
In the Retransmit Attempts field, select the number of retries for NetClock to com
municate with the RADIUS server.
Adding a RADIUS Server
To add a RADIUS server:
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel, click the RADIUS Setup button.
3. The Radius Setup window will display. Ensure that HTTP/HTTPS is enabled. If not, see
procedure above, "Configuring RADIUS Authentication".
CHAPTER 4 • NetClock User Reference Guide Rev. 13
231
4.3 Managing Users and Security
4. Populate the following fields as needed:
Host—Enter either the hostname or IP address of the RADIUS server on the net
work with which you wish NetClock to authenticate.
Port—Defines the RADIUS Port to use. The default RADIUS Port is 1812, but this
can be changed, as required.
Secret key—Enter the secret key which is shared by NetClock and the RADIUS
server (the key is used to generate an MD5 hash).
Timeout—Defines the Timeout that NetClock will wait to communicate with the
RADIUS server.
5. Click the Add Server button.
Viewing the Status of a RADIUS Server
To view the status of a RADIUS server:
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel, click the RADIUS Setup button.
3. The Radius Setup window will display.
232
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
For each RADIUS server, the following information will display:
Host—The hostname or IP address of the RADIUS server.
Port—The RADIUS port used to access the RADIUS server.
Timeout—The timeout that has been set for the RADIUS server.
Status —One of the following statuses will display:
UNREACHABLE (red, blinking)—The server is not available on the
network.
UNAUTHORIZED (red)—The server is available on the network but
access was denied.
REACHABLE (green)—The server is available on the network and
access was allowed.
DISABLED (yellow)— The server is available on the network but
RADIUS authentication is disabled on the server.
Actions —Click the X-button to remove a server.
Removing a RADIUS Server
To remove a RADIUS server:
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel, click the RADIUS Setup button.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
233
4.3 Managing Users and Security
3. The Radius Setup window will display. Click the X-button next to the RADIUS server you
wish to remove.
234
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
4.3.6
TACACS+ Authentication
Terminal Access Controller Access-Control System Plus (TACACS+) is a protocol that handles
authentication, authorization, and accounting (AAA) services. NetClock supports pam_tacplus ,
allowing users to validate their username/password when logging into NetClock via a
TACACS+ server. Currently, http/https/ssh/pure-ftpd are supported.
In order to enable TACACS+ for ssh/pure-ftpd, a matching user account needs to be created
locally on the NetClock unit that matches the account on the TACACS+ server:
For example, a user with the username “user3” and password “pass3” on the TACACS+ server
also has to create a “user3” account on the NetClock unit before logging in (the password can
be different).
Reference information:
https://en.wikipedia.org/wiki/TACACS
http://www.cisco.com/c/en/us/support/docs/security-vpn/remoteauthentication-dial-user-service-radius/13838-10.html
https://github.com/jeroennijhof/pam_tacplus
For additional help, see also "RADIUS Authentication" on page 230
4.3.6.1
Adding/Deleting a TACACS+ Server
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel on the left, click TACACS+. The TACACS+ Setup window will be
displayed:
3. Fill out the fields:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
235
4.3 Managing Users and Security
Host: The address of the TACACS+ server
Port: The port number of the TACACS+ server
Secret Key: The same encryption key as used on the TACACS+ server.
4. Click the Add Server button. A confirmation message "The item has been added" will be
displayed if the server could be added, and the server will be added to the list.
Note: NetClock supports multiple TACACS+ servers. The system per
formance, however, will be negatively affected by a large number of serv
ers or invalid servers, respectively.
The Server Status can be:
DISABLED: The TACACS+ service is disabled (see below to enable it)
UNREACHABLE: This TACACS+ server cannot be reached.
REACHABLE: This TACACS+ server can be reached.
5. To delete a TACACS+ server from the list, click the X -button in the Actions column.
4.3.6.2
Enabling/Disabling TACACS+
1. Navigate to MANAGEMENT > OTHER: Authentication.
2. In the Actions panel on the left, click TACACS+. The TACACS+ Setup window will be
displayed:
236
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.3 Managing Users and Security
3. Check the box HTTP/HTTPS , and click Submit to enable TACACS+ on this NetClock.
(Uncheck the box and click Submit to disable TACACS+).
4.3.7
HTTPS Security Levels
NetClock supports two different modes of HTTPS operation:
The Standard HTTPS Level allows the use of medium strength ciphers and older TLS
(Transport Layer Security) protocols,
while the High-Security Level is restricted to strong ciphers and TLS version 1.2 exclus
ively.
While Standard Mode is the default setting, the High-Security Level is preferred (unless you
require the extra compatibility), since High Security turns off TLSv1, which has known secur
ity vulnerabilities.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
237
4.3 Managing Users and Security
B r o ws er
S uppo r t
Note that the High-Security Level requires the use of current browsers – as of July 2016, the oldest
compatible clients include:
• Firefox® 27
• Chrome® 30
• Internet Explorer® 11
• Safari® 9.
(This is not an exhaustive list.)
To enable High-Security HTTPS :
1. Navigate to MANAGEMENT > Network Setup.
2. In the Actions Panel on the left, click on Web Interface Settings . The Web Interface Set
tings window will open.
3. Click on the tab Security Level:
4. Read the Caution statement and verify that you meet the requirements stated.
5. Check the box Enable High Security, and click Submit.
6. While it is NOT necessary to close the Web UI, and restart the browser, it is recom
mended to wait 90 seconds before continuing to use the Web UI, in order to allow the
web server software to restart in the background.
It is also possible to disable High-Security HTTPS: Follow the procedure outlined above, but
uncheck the box Enable High Security.
For more information on HTTPS certificates, see "HTTPS" on page 62.
238
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.4 Miscellanous Typical Configuration Tasks
4.3.8
Unlocking the Keypad via Keypad
The front panel keypad can be locked via the Web UI, under MANAGEMENT > OTHER: Front
Panel.
If the front panel keypad is locked, and you do not have access to the unit's Web UI to unlock
it, press the following key sequence to locally unlock the keypad for use:
4.3.9
If a Secure Unit Becomes Inaccessible
Spectracom assumes that you are responsible for the physical security of the product. Spec
tracom secure products are recommended to be locked in a secure enclosure, cabinet or room.
Unauthorized persons are not to be given access to the product nor should a serial cable and
terminal program be attached unless the system administrator is configuring or performing
maintenance.
A secure NetClock may become inaccessible if:
your company disables HTTPS
you lose the system passwords
you allow the Certificate to expire
someone deletes the Certificate and Private Keys and deletes the Host Keys
you forget the Passphrase.
To regain access to the NetClock unit, you must utilize the front panel keypad and LCD in order
to restore the spadmin account’s default password.
The spadmin account can then be used to enable HTTPS using the “defcert ” command. The
“defcert” command generates a new self-signed SSL certificate.
Refer to "Keypad and Information Display" on page 6 for information on using the keypad
and LCD information display.
4.4
Miscellanous Typical Configuration Tasks
4.4.1
Web UI Timeout
For security reasons, the Web UI will automatically timeout after a set number of minutes, i.e.
you will be logged out by the system, regardless of activity, and need to actively login again.
Minimum timeout duration: 10 minutes
Maximum timeout duration: 1440 minutes (24 hours)
Default timeout duration: 60 minutes.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
239
4.4 Miscellanous Typical Configuration Tasks
To change the time after which the Web UI will timeout:
1. Navigate to the MANAGEMENT > Network Setup screen.
2. In the Actions panel on the left, click on Web Interface Settings .
3. In the Web Interface Settings window, enter the desired value in minutes.
In order for a new setting to take effect, you need to log off, and then log back in again. This
setting affects all users, i.e. not just the user changing the value.
4.4.2
Configuring the Front Panel
Note: This Section applies to NetClock 9483 only.
The front panel of the NetClock unit comprises three elements which can be configured via the
NetClock Web UI:
The keypad, which—in conjunction with the information display—can be used to access
NetClock's main functions directly via the unit's front panel. To prevent inadvertent
keypad operation, it can be locked and unlocked from the Web UI. Learn more about
front panel keypad operation: "Keypad and Information Display" on page 6.
The information display: A 4-line LCD display that can be configured to display dif
ferent screens, and that is used in conjunction with the keypad.
The LED time display which can be configured to show the current time (UTC, TAI, GPS
or Local timescale) in either 12- or 24-hour format. By factory default, the LED will dis
play UTC time in 24-hour format.
Accessing the Front Panel Setup Screen
NetClock's Web UI allows you to configure the main elements on the front panel of the unit,
and to see an image of the information currently displayed on the 4-line front panel inform
ation display.
To access the front panel configuration window:
1. Navigate to MANAGEMENT > OTHER: Front Panel.
240
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.4 Miscellanous Typical Configuration Tasks
2. The Front Panel configuration window will display:
Next to the graphical near-real time representation of the 4-line front panel information
display, the following functionality can be accessed in this window:
Show Content—A drop-down of the options that can be shown on the information
display. This field determines what is normally displayed in the information dis
play when the keypad is not in use. The desired screen to display can be selected
with either the keypad or with this drop-down field. While switching from one
screen to another either “Keypad Locked” or “Keypad Unlocked” will be dis
played on the LCD (depending on the setting of the keypad “Lock” field).
Clock Hour Format—This option configures the time display on the front panel as
either in 12-hour or 24-hour format.
Timescale/Local Clock —This option configures the time scale for the LED time dis
play. The available options are:
UTC (temps universel coordonné)
TAI (Temps Atomique International)
GPS : the raw GPS time as transmitted by the GNSS satellites (as of July,
2015, GPS time is 17 seconds ahead of UTC time).
The Local timescale, which allows a Local Clock to apply a time offset for
Time Zone and DST correction. This option is only available, if a Local
Clock has been enabled under MANAGEMENT/OTHER/Time Man
agement.
Note: If GPS or TAI time is used, then the proper timescale offsets must be
set on the MANAGEMENT/OTHER/Time Management page.
Lock Keypad—If desired, the front panel keypad can be locked to prevent inad
vertent operation. Locking and unlocking of the keypad can be performed either
with the keypad itself, or by means of this check box. [DEFAULT = this box is NOT
CHAPTER 4 • NetClock User Reference Guide Rev. 13
241
4.4 Miscellanous Typical Configuration Tasks
checked, i.e. the keypad is NOT locked]
Allow Position Display—As per DEFAULT, NetClock allows to display the geo
graphic position of your antenna in the information display, if so configured
under the Show Content selection menu. The option to display the position can be
disabled by unchecking this box. This will cause the information display on the
front panel of the unit to show the message “Not Enabled” when selecting and
applying the Position option via the keypad.
Configuring the Front Panel Information Display
To configure the 4-line LCD information display on the front panel of the unit:
1. Navigate to MANAGEMENT > OTHER: Front Panel.
2. In the Show Content field, select the display you want from the drop-down list. The
options are:
Rotate—This option enables sequential rotation of the content displayed in the
information display as long as the keypad is not in use. Content will rotate
through all enabled content for installed options. When Rotate is selected, a fur
ther option appears on the screen:
Rotation Delay—This option sets the duration in seconds for content display
during rotation before the next content screen is displayed. [Range =
between 1 and 30 seconds]
Network (the default)—This option displays the current network settings. If an
option card is installed that provides additional network interfaces, there will be
additional network choices (i.e., Network: eth0, Network: eth1, etc.).
Status —This option displays current key status indications (such as NTP Stratum
level, TFOM –“Time Figure of Merit”, Sync status and Oscillator lock status).
Position—This option displays latitude, longitude and elevation of the antenna.
Day of Year —This option displays the day of year (such as “Day of Year 104”).
GNSS —This option displays the number of satellites currently being used (and the
strongest signal strength out of all these satellites) and their relative signal
strengths of all the receiver channels that are tracking satellites as a bar graph.
Date—This option displays the current date (such as “16 November 2014”).
Note: The date is based on the timescale configured for the information dis
play. It is possible that a date other than “today’s local date” may be
shown, if the configured time scale has already rolled over to its new date,
though local time has not yet rolled over to its new date.
Keys —This option is applicable to the SAASM GPS receiver option module only.
The front panel will display “NOT SUPPORTED” unless a SAASM receiver is
242
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.4 Miscellanous Typical Configuration Tasks
installed.
None—This option configures the front panel 4-line information display to remain
blank unless the keypad is unlocked and in use.
3. In the Timescale/Local Clock field, choose the timescale or local clock you wish to use
as the time reference for the time shown on the front panel time display. The options
available are:
UTC
TAI
GPS
Any Local Clocks you have set up. The Time Zone and DST rules, as configured
under Time Management/Local Clocks will now be applied to the front panel
time display. For more information on Local Clocks see .
Note: With Timescale configured as “Local” and during DST (Daylight Saving
Time, as configured in the Local Clock), a “DST indicator” (decimal point) will be
displayed to the bottom-right of the minutes portion of the LED time display. The
“DST indicator” extinguishes during “Standard” time. If the Local Clock is con
figured as “No DST/Always Standard Time”, the DST indicator won’t ever be lit.
4. Select the Lock Keypad check box if you want to lock the front panel keypad. [DEFAULT
= unlocked (unchecked)]
5. Deselect the Allow Position Display checkbox if you do not want to enable the option to
display position data on the front panel information display. See also Allow Position
Display.
Locking/Unlocking the Keypad via Web UI
To lock or unlock the keypad on the front panel of the unit (see illustration Front Panel):
1. Navigate to MANAGEMENT> OTHER: Front Panel.
2. Check or uncheck the Lock Keypad checkbox to disable, or enable the keypad
3. Click Submit or Apply.
Note: If the keypad is unlocked, pressing any keypad key will temporarily return
the information display to the “Home” menu display for keypad operation. One
minute after the last keypad press, the information display will return to its con
figured screen.
It is also possible to unlock the keypad without using the Web UI; see "Unlocking the Keypad
via Keypad" on page 239.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
243
4.4 Miscellanous Typical Configuration Tasks
Enabling/Disabling the Position Display Screen
To enable or disable [DEFAULT = enable] the option to display geographic position data on
the information display, if so configured (see also Allow Position Display):
1. Navigate to MANAGEMENT > OTHER: Front Panel.
2. Check or uncheck the Allow Position Display checkbox.
3. Click Submit or Apply.
4.4.3
Displaying Local Time
This applies to NetClock 9483 units only.
After physical product installation, a commonly requested scenario is for NetClock to display
local time on the front panel (rather than UTC time). To learn more about this feature, see , and
"Configuring the Front Panel" on page 240.
4.4.4
Creating a Login Banner
A login banner is a customizable banner message displayed on the login page of the NetClock
Web UI. The login banner can be used e.g., to identify a unit.
Figure 4-2: Login banner (example)
To configure a login banner:
1. Navigate to the MANAGEMENT > Network Setup screen.
2. In the Actions panel on the left, click Login Banner .
3. The Network Access Banner window will display. Check the box Enable Custom Ban
ner .
4. In the Plain Text Banner text box, type in your custom text.
244
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.4 Miscellanous Typical Configuration Tasks
Note: The Plain Text Banner is used to create a message for all interactive
login interfaces (Web UI, telnet, SSH, FTP, SFTP, serial, etc.). It is not
required to include HTML tags.
5. Optionally, you may also use the Web Interface Banner text box.
Note: Enabling and using the Web Interface Banner text box will allow you
to apply HTML formatting tags to your message (e.g., colors). Note that this
functionality is limited to browser-based Web UI access.
6. To test your new banner, click Apply to see a preview at the bottom of the window. OR,
click Submit, and log out of the Web UI, and back in so as to see the banner on the
actual login page.
4.4.5
Show Clock
Instead of the Web UI, a large digital clock can be displayed on your computer screen. Next to
the system status, the screen clock will display the UTC time, and the NetClock front panel time.
To display the screen clock instead of the Web UI:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
245
4.4 Miscellanous Typical Configuration Tasks
1. Navigate to TOOLS > SYSTEM: Show Clock :
2. To return to the standard Web UI, click Home.
4.4.6
Configuring an External Display Clock
A frequently requested configuration is to connect and configure a remote Spectracom
TimeView® Display Clock to a NetClock unit.
Figure 4-3: Spectracom TV400 series display clock
The following procedure applies to Spectracom display clocks, models TV400W, and
TV210W.
1. Set up a Local Clock: In the Web UI, navigate to Management > Time Management, and
click the PLUS icon to add a new Local Clock.
Name the new Local Clock, and configure it (for more information, see ).
246
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.4 Miscellanous Typical Configuration Tasks
2. Navigate to the INTERFACES menu, and select ASCII Output 1 (the RS-485 Output). In
the window that opens, click the EDIT button:
3. In ASCII Output 1 configuration window, select:
Under Format Group: Spectracom
Under Format 1: Spectracom Format 0, and
Under Timescale: the Local Clock that you created in Step 1.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
247
4.4 Miscellanous Typical Configuration Tasks
For additional information on the other settings, see "Configuring an ASCII Time Code
Output (RS-232 or RS-485)" on page 334.
4. Click Submit. The RS-485 output has not been setup to supply the correct time and format
for the display clock.
5. Connect the NetClock RS-485 output to the display clock input.
Do not forget to install the 120 Ω terminating resistor (included with the display clock
ancillary kit) between Pin 1 and Pin 2 of the terminal block of the display clock.
Figure 4-4: Wiring the RS-485 signal
Note: The TV400W series display clock can be daisy chained from Input to
Input, up to a total of 32 devices in a single chain. The terminating resistor
should be installed in only the last clock in the daisy chain.
6. TESTING: Once the TV400W synchronizes, the seconds will stop flashing and the time
will read the Local Time configured in your NetClock. If this does not happen, check the
configuration, wiring and sync status of the NetClock 9483. The TV400W will not syn
chronize unless the GNSS is connected to your NetClock, and the unit is in sync.
4.4.7
Product Registration
Spectracom recommends that you register your NetClock so as to allow our Customer Service
and Technical Support to notify you of important software updates, or send you service bul
letins, if required.
Upon initial start of the NetClock Web UI (see "Accessing the Web UI" on page 52), you will
be prompted to register your new product. It is also possible to register at a later time via the
HELP menu item, or directly on the Spectracom website.
248
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
4.4.8
Synchronizing Network PCs
Frequently, network PCs have to be synchronized to NetClock via the Ethernet port, using NTP
(Network Time Protocol). A detailed description on how to synchronize Windows PCs can be
found online in the Spectracom Technical Note Synchronizing Windows Computers on the
Spectracom website . This document also contains information and details about using the
Spectracom PresenTense NTP client software.
4.4.9
Selecting the UI Language
Spectracom continues to localize the NetClock Web UI into languages other than English e.g.,
French. Additional languages will be displayed under the Language button in the top- right
corner of the screen as they become available.
Once you selected a language preference, it will be maintained across logins.
4.5
Quality Management
4.5.1
System Monitoring
4.5.1.1
Status Monitoring via Front Panel
Note: This topic applies only to NetClock 9483.
When you have physical access to the NetClock front panel, the Status LEDs and the Inform
ation Display allow you to obtain a system status overview.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
249
4.5 Quality Management
For more information on the Status LEDs, see "Status LEDs" on page 8.
For more information on the Information Display, see "Configuring the Front Panel" on
page 240.
It is also possible to display the front panel information display on the Web UI: Navigate to
MANAGEMENT > Front Panel.
4.5.1.2
Status Monitoring via the Web UI
While the NetClock front panel status LEDs provide an indication of the current operating status
of the system (see "Status Monitoring via Front Panel" on the previous page), more detailed
status information can be accessed via the NetClock Web UI, such as:
Time synchronization status, including references
GNSS satellites currently being tracked
NTP sync status and current Stratum level
Estimated time errors
Oscillator disciplining
Temperature monitoring
Status of outputs and presence of DC input power.
The HOME screen provides time server status information, while the TOOLS > System Monitor
screen also displays hardware status data, e.g. temperature curves:
Status Monitoring via the HOME Screen
The HOME screen of the NetClock Web UI provides a system status overview (see also "The
Web UI HOME Screen" on page 14).
The HOME screen is divided into four panels:
250
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
System Status panel
Reference—Indicates the status of the current synchronizing reference, if any.
Power —Indicates whether the power is on and which type of power is being used. If the
unit is configured for AC power, AC will appear in this panel. If the unit is configured
for DC power, DC will appear in this panel. If the unit is configured for both AC and
DC, AC and DC will appear in this panel.
Status —Indicates the status of the network’s timing. There are three indicators in the
Status field:
Sync —Indicates whether NetClock is synchronized to its selected input references.
Green indicates NetClock is currently synchronized to its references (the
front panel Sync light will also be green).
Orange indicates NetClock is not currently synchronized to its references
(the front panel Sync light will be red).
Hold—When lit, NetClock is in Holdover mode.
Fault—Indicates a fault in the operation of the NetClock. See "Troubleshooting
via Web UI Status Page" on page 312 for instructions for troubleshooting faults.
Alarm Status : If a major or minor alarm is present, it will be displayed here.
NTP—Current STRATUM status of this NetClock unit.
Temperature—The current board temperature will be displayed here, plus—depending
on product configuration—oscillator, and CPU temperatures, as well. For more inform
ation, see "Temperature Management" on page 272.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
251
4.5 Quality Management
Reference Status panel
REFERENCE: Indicates the name type of each reference. These are determined by the
inputs set up for the NetClock
PRIORITY: Indicates the priority of each reference. This number will be between 1 and
15. References in this panel appear in their order of priority. See "Configuring Input
Reference Priorities" on page 157 for more information.
STATUS : Indicates which available input reference is acting as the Time reference and
which available input reference is acting as the 1PPS reference.
Green indicates that the reference is present and has been declared valid.
Orange indicates the input reference is not currently present or is not currently
valid.
PHASE: The measured time interval error ("TIE") between the internally disciplined 1PPS
and the selected external 1PPS reference.
Performance panel
Disciplining State—Indicates whether or not the internal oscillator is currently being dis
ciplined (steered to an input reference).
1PPS Phase Error —An internal measurement (in nanoseconds) of the internal 1PPSs’
phase error with respect to the selected input reference (if the input reference has excess
ive jitter, phase error will be higher)
10 MHz Frequency Error —An internal estimated calculation (in Hertz) of the internal
oscillator’s frequency error, based on the phase accuracy error at the beginning and
end of a frequency measurement window (the length of this window will vary depending
upon the type of oscillator installed and the oscillator adjustment algorithm).
Events panel
The Events panel in the bottom-left corner of the HOME screen is a log of NetClock’s recent
activity. It updates in real time.
Note: If you know the individual reference or output whose status you wish to see,
you can access the Status window of that reference or output directly through the
INTERFACES > REFERENCES or INTERFACES > OUTPUTS drop-down menu.
Status Monitoring via the System Monitor Screen
To display status information pertaining mainly to NetClock's current hardware status, navigate
to TOOLS > SYSTEM > System Monitor .
The information provided on the System Monitor Screen is subdivided into three panels:
252
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
System Status panel
This is identical with the HOME screen "System Status panel" on page 251.
Disk Status panel
This panel displays:
Total: [MB]
Used: [MB]
Free: [MB]
Percent: [%]
The last item refers to system storage. If you need to update the System Software, and this num
ber is 70% or higher , it is recommended to clear logs and stats in order to free up memory
space. (Navigate to TOOLS > SYSTEM: Upgrade/Backup, and click the corresponding buttons
in the lower left-hand corner.)
System Monitor panel
Graphs are displayed for:
Board Temperature
CPU Temperature
Memory Used
CPU Used.
To delete the logged data used to generate the displayed graphs, click the TRASHCAN icon.
(Note that re-populating the graphs with fresh data generated at a 1/min. rate will take several
minutes.)
To download the logged data in .csv format, click the ARROW icon.
4.5.1.3
Status Monitoring of Input References
NetClock’s input references can be monitored in real time through the INTERFACES menus. The
menus will populate dynamically, depending on which references are available.
To display all references, navigate to INTERFACES > REFERENCES.
To display all references of a given type, click on the entry for that reference type (not
indented e.g., GNSS Reference).
To display one particular reference, click on its entry (indented e.g., GNSS 0).
The Reference window will show the validity status for the chosen reference(s):
CHAPTER 4 • NetClock User Reference Guide Rev. 13
253
4.5 Quality Management
You can also click on any of the connectors shown in the rear panel illustration to high
light/identify the corresponding reference:
To display more status information for a particular input reference, click the cor
responding INFO button:
The reference window being displayed will show additional status information and
option-card specific settings. The type of input reference, and the option card model
determine which status information and option card settings will be displayed.
254
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
To change settings, click the Edit button in the bottom left corner.
4.5.1.4
Reference Monitoring
Reference monitoring enables you to assess the quality of your references by comparing them
against the current system reference, and against each other. This allows you to predict or
understand system behavior in the event that the current system reference will be lost, or was
lost, respectively. You may also decide to alter reference priorities as a result of monitoring
their quality e.g., assigning a lower reference priority to a noisy reference, or a reference with
a significant offset.
NetClock allows Reference Monitoring by comparing the phase data of references against the
System Ontime Point. The phase values shown are the filtered phase differences between each
input reference 1PPS and the internal disciplined 1PPS.
The data is plotted in a graph in real-time. The plot also allows you to display historic data,
zoom in on any data range or on a specific reference. A data set can be exported, or deleted.
To monitor the quality of references:
1. Navigate to TOOLS > System: Reference Monitor . The Reference Monitor screen will dis
play:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
255
4.5 Quality Management
On the left side of the screen, Status information is displayed for the System, and the
References. Note that the Reference Status panel also displays the latest PHASE OFFSET
reading (1) for active references against the System Ontime Point. The reading is
updated every 30 seconds.
This PHASE OFFSET data is plotted over time (abscissa) in the Reference Monitor panel
in the center of the screen. Use the handles (2) to zoom in on a time window.
The scale of the axis of ordinate (3) is determined by the largest amplitude of any of the
references displayed in the current time window. Use the checkboxes in the References
panel on the right to remove references from the graph, or add them to it.
4.5.1.5
Ethernet Monitoring
To monitor Ethernet status and traffic:
256
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
1. Navigate to TOOLS > SYSTEM: Ethernet Monitor . The Ethernet monitoring screen opens:
The data displayed is linked to a specific Ethernet port e.g, ETH0. If you enable additional Eth
ernet ports, their throughput data will also be displayed.
In the Traffic pane on the right the traffic throughput in Bytes per second is displayed in two
graphs. Drag the handles at the bottom of the graphs to zoom in on a particular time frame.
In the Actions panel on the left, you can clear or download monitoring data.
In the Status panel on the left, information pertaining to the given Ethernet port is displayed,
including throughput statistics and error statistics. The Mode field indicates which transmission
mode is being used for the given Ethernet port:
FULL duplex, or
HALF duplex.
Note that the Mode is auto-negotiated by NetClock. It can be changed only via the switch NetC
lock is connected to, not by using the NetClock Web UI.
4.5.1.6
Outputs Status Monitoring
Per standard configuration, NetClock is equipped with one 1PPS and one 10 MHz output.
Additional outputs can be added by means of output option cards.
Outputs can be monitored in real time via the INTERFACES drop-down menu. The menu will
populate dynamically, depending on which outputs are installed.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
257
4.5 Quality Management
Monitoring the status of all outputs
To display a list of all the outputs installed in a NetClock unit:
1. Select INTERFACES and click OUTPUTS in the menu heading.
2. The Outputs panel will list all the outputs installed, sorted by category.
To display more detailed information about a particular output, click the corresponding
INFO button.
To edit the settings of an output, click the GEAR button (see also "Configuring Outputs"
on page 132.)
To refresh the information displayed, click the REFRESH button (circling arrows icon on
the right side of the screen).
On the rear panel illustration, click on an output connector to highlight its list entry.
Monitoring all outputs of a specific type
258
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
To monitor all the outputs of a particular category (PPS, for example) simultaneously:
1. Navigate to INTERFACES > OUTPUTS , and click the desired output category (not recessed
e.g., PPS Output):
2. The Status window will display a list of all outputs of the selected category:
To display more detailed information about a particular output, click the corresponding
INFO button.
To edit the settings of a given output, click the GEAR button (see also "Configuring Out
puts" on page 132.)
To refresh the information displayed, click the REFRESH button (circling arrows icon).
In the illustration of the rear panel, click on a connector to highlight the corresponding
list entry.
Displaying the settings of a specific output
The outputs installed in your NetClock unit have specific settings that can be reviewed, and—to
some extent—edited.
To display the settings of an output:
1. Navigate to INTERFACES > OUTPUTS , and click on the desired output (recessed e.g., PPS Out
put 0):
CHAPTER 4 • NetClock User Reference Guide Rev. 13
259
4.5 Quality Management
2. The corresponding Status window will display:
Click the Edit button in the bottom-left corner to configure settings that are user-editable. See
also "Configuring Outputs" on page 132.
4.5.1.7
Monitoring the Oscillator
The Oscillator Management screen provides current and history status information on dis
ciplining state and accuracy.
To access the Oscillator Management screen:
260
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
1. Navigate to MANAGEMENT > OTHER: Disciplining.
2. The Oscillator Management screen will display. It consists of two panels:
The Oscillator Status Panel
This panel provides comprehensive information on the current status of NetClock's timing state.
Oscillator Type: Type of oscillator installed in the unit.
Disciplining State: State of oscillator control and disciplining; indicates whether or not the
internal oscillator is currently being disciplined (steered to an input reference). The states
are: "Warm up", "Calibration", "Tracking Setup", "Lock State", "Freerun", and "Fault".
1PPS Phase Error: A tracking measurement [scaled time, in ns, or ms] of the internal
1PPSs' phase error with respect to the selected input reference. Long holdover periods
or an input reference with excessive jitter will cause the phase error to be high. The oscil
lator disciplining control will gradually reduce the phase error over time. Alternatively,
restarting the tracking manually (see "Restart Tracking" under "Configuring the Oscil
lator" on page 195), or automatically via a pre-set Phase Error Limit, will quickly reduce
the phase error.
10 MHz Frequency Error: An internal estimated calculation (in Hertz) of the internal oscil
lator's frequency error, based on the phase accuracy error at the beginning and end of
a frequency measurement window (the length of this window will vary depending upon
the type of oscillator installed and the oscillator adjustment algorithm).
Current DAC Setting: Current DAC value, as determined by the oscillator disciplining sys
tem. The value is converted into a voltage that is used to discipline the oscillator. A stable
CHAPTER 4 • NetClock User Reference Guide Rev. 13
261
4.5 Quality Management
value over time is desirable and suggests steady oscillator performance (see also the
graph in the History Panel).
DAC Step: Step size for adjustments to the internal oscillator, as determined by the oscil
lator disciplining system. Larger steps = quicker, but coarser adjustments. The step size is
mainly determined by the type of oscillator.
TFOM: The Time Figure of Merit is NetClock’s estimation of how accurately the unit is syn
chronized with its time and 1PPS reference inputs, based on several factors, known as
the Estimated Time Error or ETE. The larger the TFOM value, the less accurate NetClock
believes it is aligned with its 1PPS input that is used to perform disciplining. If this estim
ated error is too large, it could adversely affect the performance of oscillator dis
ciplining. The available TFOM range is 1 through 15.
Max TFOM for Sync: Value, as set under "Configuring the Oscillator" on page 195
Temperature(s): Three temperatures are displayed:
Oscillator temperature, which has an effect on oscillator accuracy, and therefore
can be used to interpret oscillator performance.
Board temperature (measured on the main board, sometimes also referred to as
'System temperature')
CPU temperature
Note: Oscillator temperature is plotted over time in the History panel
on the right, while graphs for board and CPU temperature can be
found under TOOLS > SYSTEM: System Monitor.
Note that a temperature sensor started being added to NetClock Model 9483s in 2012
(the Model 9489s do not have this sensor installed). Model 9483s purchased prior to
this hardware change being implemented will not be able to report the internal tem
perature, even with software update versions 5.2.0 or above installed.
For more information, see "Temperature Management" on page 272.
Last Time Reference Change: [Timestamp: Last occurrence]
Last 1PPS Reference Change: [Timestamp: Last occurrence]
Last TFOM Change: [Timestamp: Last occurrence]
Last Sync State Change: [Timestamp: Last occurrence]
Last Holdover State Change: [Timestamp: Last occurrence]
The Oscillator History Panel
The Oscillator History Panel offers real-time graphical monitoring of NetClock’s internal tim
ing. The following graphs plot key oscillator-relevant data over time::
262
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Phase Error Magnitude: See 1PPS Phase Error
Frequency Error : See 10_MHz_Frequency_Error
Scaled DAC Value: See DAC Step
Oscillator Temperature, which has an effect on oscillator accuracy, and therefore can
be used to interpret oscillator performance. See also "Temperature Management" on
page 272, "The Oscillator Status Panel" on page 261.
You can zoom in on any of the graphs by grabbing the handles at either end and pulling them
inwards. The graph will focus in on the time interval you choose in real time.
Clicking on the Delete icon in the top-right hand corner will erase all current oscillator log data.
Clicking on the Download arrow icon will download the latest oscillator log data as a . csv
file.
4.5.1.8
Monitoring the Status of Option Modules
Note: This section applies to NetClock 9483 only.
NetClock’s installed option modules can be monitored in real time through the INTERFACES >
OPTION CARDS drop-down menu. The menu will populate dynamically, depending on which
option modules are installed.
Monitoring ALL Options
To monitor all options, or a specific option installed in your NetClock:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
263
4.5 Quality Management
1. Navigate to INTERFACES , and click on OPTION CARDS :
2. The resulting screen will display all installed option cards, and their current status.
You can drill down on any of the listed input references and outputs by clicking the
INFO button (u status information), or the GEAR button (u edit settings).
Monitoring a SPECIFIC Option
To monitor the status of a selected option:
1. Navigate to INTERFACES > OPTION CARDS , and click on a specific option card, or
one of its indented input references, or outputs drop-down menu.
264
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
2. A window will display for the specific option you chose.
Via the GEAR button, INFO button, or Edit button you can access and edit more detailed
settings.
4.5.1.9
NTP Status Monitoring
NetClock's NTP Status Summary provides a means to monitor NTP status and performance
parameters relevant to your NetClock at a glance.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
265
4.5 Quality Management
1. To access the NTP Status Summary panel, navigate to MANAGEMENT > NETWORK:
NTP Setup.
2. The NTP Status Summary panel is at the lower left of the screen. The panel contains the
following information:
Selected Ref—The reference NetClock is currently using.
Stratum —This is the stratum level at which NetClock is operating.
Leap Indicator —The leap indicator bits (usually 00). See "Leap Second Alert Noti
fication" on page 150.
Delay (ms)—The measured one-way delay between NetClock and its selected ref
erence.
Time Offset—This is a graphical representation of the system time offset over
time. Clicking on this graph in the NTP Status Summary panel will open a win
dow in the main panel containing a larger, more detailed view of the graph. See
"The NTP Time Offset Performance Graph" on the facing page.
Offset (ms)—Displays the configured 1PPS offset values.
266
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Frequency Offset—This is a graphical representation of the system frequency off
set over time. Clicking on this graph in the NTP Status Summary panel will open a
window in the main panel containing a larger, more detailed view of the graph.
See "The NTP Frequency Offset Performance Graph" on the next page.
Jitter (ms)—Variance (in milliseconds) occurring in the reference input time (from
one poll to the next).
Jitter —This is a graphical representation of the system jitter over time. Clicking on
this graph in the NTP Status Summary panel will open a window in the main
panel containing a larger, more detailed view of the graph. See "The NTP Jitter
Performance Graph" on page 270.
Note: This panel is updated every 30 seconds, or upon clicking the
browser refresh button.
The NTP Time Offset Performance Graph
To view the NTP Time Offset performance graph:
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Status Summary panel locate the Time Offset graph.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
267
4.5 Quality Management
3. Click the graph in the NTP Status Summary panel.
4. The NTP Performance Graph panel will appear.
5. To select the statistics for a particular day, select a date from the drop-down list in the
Select Day for Statistics field. The default date is the present date. Click Apply.
6. To display a higher resolution graph for a shorter time span, move one or both time
sliders at the bottom of the graph inwards.
The NTP Frequency Offset Performance Graph
To view the NTP Frequency Offset performance graph:
268
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
1. Navigate to MANAGEMENT > NETWORK: NTP Setup.
2. In the NTP Status Summary panel locate the Frequency Offset graph.
3. Click the graph in the NTP Status Summary panel.
4. The NTP Performance Graph panel will appear (the data may be displayed with a
delay). The X-axis represents time, the Y-axis shows the frequency offset in parts-per-mil
CHAPTER 4 • NetClock User Reference Guide Rev. 13
269
4.5 Quality Management
lion (PPM); e.g. 290 PPM is equivalent to .0290 percent.
5. To select the statistics for a particular day, select a date from the drop-down list in the
Select Day for Statistics field (highlighted in green in the illustration above). The default
date is the present date. Click the Apply button.
To display a higher resolution graph of a shorter time frame, move one or both
of the two sliders inwards.
The NTP Jitter Performance Graph
To view the NTP Jitter performance graph:
270
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
1. Navigate to MANAGEMENT > NETWORK: NTP Setup screen.
2. In the NTP Status Summary panel locate the Jitter graph.
3. Click the graph in the NTP Status Summary panel.
4. The NTP Performance Graph panel will appear.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
271
4.5 Quality Management
5. To select the statistics for a particular day, select a date from the drop-down list in the
Select Day for Statistics field. The default date is the present date. Click the Apply but
ton.
To display a higher resolution graph for a shorter time span, move one or both
time sliders at the bottom of the graph inwards.
4.5.1.10 Temperature Management
NetClock is equipped with one cooling fan, located behind the right-hand side of the front
panel, and several hardware temperature sensors, including:
the board temperature near the CPU
the CPU temperature
the air temperature near the oscillator .
Temperature readings are performed once per minute. The temperature data is logged, and
can be visualized via graphs integrated into the Web UI. The temperature readings can also
be used to control the fan. For details see below under Fan Control Feature.
Units produced before 2016
NetClock units produced before 2016 may not be equipped with the oscillator sensor. They
can be retrofitted, if so requested. For additional information, contact Technical Support (see
"Technical Support" on page 411). As the front panel cooling fan is internal temperature con
trolled, the fan may not always be in operation. However, the fan may momentarily turn on
each time NetClock is power-cycled.
Units produced since 2016
Units produced since 2016 are often equipped with the Fan Control feature, which turns ON
the fan by default. This feature also allows for a custom temperature window to be set for the
fan.
Fan Control Feature
The Web UI Fan Control feature allows you to define a temperature range for the fan to turn
272
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
OFF and ON.
Note: Units produced before Dec. 2015 are not equipped with the Fan Control
feature.
Does my unit have Fan Control?
To find out, navigate to the HOME screen. Your unit is equipped with the Fan Control
feature, if there is a GEAR icon displayed in the System Status panel:
To enable user-defined Fan Control:
The default fan setting is ALWAYS ON.
To apply custom fan temperature settings:
1. Navigate to the HOME screen.
2. In the System Status panel, click the Gear icon in the upper right-hand corner. The Sys
tem Options window will open:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
273
4.5 Quality Management
3. Choose between the Fan Settings :
Always On [Default]: The fan runs all the time.
User Defined: You determine the:
Fan Max Temperature: The CPU temperature in °C at which the fan will
turn ON. It is advisable to set this temperature no higher than 40°C.
Fan Min Temperature: The CPU temperature in °C at which the fan will
turn OFF (the default is 30°C).
The temperature between the two threshold values is the range in which the temperature is
allowed to rise before the fan turns on again.
In addition there is a hardware temperature sensor that will automatically turn the fan ON if the
measured temperature is over 40°C.
Temperature Monitoring
You can monitor the unit's measured temperatures actively by inspecting the temperature
graphs in the Web UI, or passively by setting up automatic alarm messages.
Alarm notifications can be generated via SNMP Traps and Emails, as well as log messages in
the Alarm and Event Logs. The alarms may optionally be masked.
Also, it is possible to implement a delay by setting the number of times the 1/minute readings
need to exceed a temperature threshold before an alarm is triggered.
Monitoring CPU and Board Temperature
Current readings for Oscillator/Board/CPU Temperature are displayed in the System Status
panel, which can be accessed via the HOME screen, or via TOOLS > System Monitor .
CPU and Board Temperature graphs are displayed under TOOLS > System Monitor :
274
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
The graph for the Oscillator Temperature is displayed under MANAGEMENT > OTHER: Dis
ciplining:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
275
4.5 Quality Management
Temperature readings are subject to environmental conditions and hardware configuration
e.g., oscillator type. Under normal operating conditions, all temperatures should remain fairly
constant. Drastic changes may indicate e.g., a problem with the fan. Note that the oscillator tem
perature will have a direct impact on its accuracy, i.e. there is a strong correlation between dis
ciplining performance and oscillator temperature.
Setting Temperature Monitoring Alarms
Navigate to MANAGEMENT > OTHER: Notifications . In the Events panel, select the System
tab:
276
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Under the System tab, you can set Notifications for Minor and Major Alarms/Clearances. The
temperature readouts used for the Alarms are generated by the CPU temperature sensor .
Also, you can set the temperature threshold value for Minor/Major alarms, and define a retry
value by determining how many readings (1/min.) the temperature must exceed the threshold
value before an alarm/clearance is triggered.
The default temperature threshold value for both Minor, and Major Alarms is 100°C. With sim
ultaneous alarm triggerings, the Major Alarm will override the Minor Alarm, i.e. you will be
notified only about the Major Alarm. If you want to be notified early about a rise in tem
perature, a recommended setting for the Minor Alarm temperature would be 90°C. Please note
that it is not advisable to set the Major Alarm temperature to a value higher than 100°C.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
277
4.5 Quality Management
Downloading Temperature Data
It is possible to download the temperature data e.g., to plot your own temperature graphs, or
because Spectracom Technical Support inquires about this data for diagnostic purposes in the
event of technical problems.
To download the logged data used to generate the displayed graphs, navigate to any
panel that displays one or more graphs (see above), and click on the Arrow icon in the
top-right corner.
A file named systemMonitorLog.csv file will be generated in your designated down
load folder.
Deleting Temperature Data
Temperature graphs (and other graphs as well) will display up to approximately 10000 read
ings, which are generated at a 1/min. rate, i.e. the data displayed covers about 7 days. There
after, the oldest data gets overwritten.
To delete the logged data used to generate the displayed graphs, click the TRASH CAN
icon in the top-right corner of the panel.
Note that re-populating the graphs with fresh data will take several minutes.
Temperature Readout via CLI
Temperature data can be read out via the CLI using the i2cget command:
EX A MPLE:
i2cget -y 0 0x4d <register>
i2cget returns temperature in Celsius in hex format. No
additional conversion required.
Further reading
See also: "Troubleshooting the Front Panel Cooling Fan" on page 317.
4.5.2
Logs
NetClock maintains different types of event logs (see below) to allow for traceability, and for
record keeping. Should you ever require technical support from Spectracom, you may be
asked for a copy of your logs to facilitate remote diagnosis.
Logs stored internally are being kept automatically, while the storage of log files in a remote
location has to be set up by the user.
For each type of log, four 75 KB files are maintained internally on a revolving basis, i.e. the
oldest file will be overwritten, as soon as all four files have filled up with event data. The life
expectancy of a log file depends on the amount of data accumulating over time: Some types of
logs will fill up within days, while others can take months until they have reached their max
imum storage capacity.
278
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
You can delete logs at any time, see "Clearing Selected Logs" on page 293.
4.5.2.1
Types of Logs
NetClock generates log files for the following event categories:
System Log
Displays log entries related to the Timing System events and daemon events (such as the Alarms,
Monitor, Notification, or SNMP daemons starting or stopping, etc.)
Events Log
Displays log entries related to GNSS reception status changes, Sync/Holdover state changes,
SNMP traps being sent, etc. Examples include:
Reference Change: NetClock has switched from one input reference to another (for
example, IRIG was the selected input being used, but now GNSS is the selected ref
erence).
GPS Antenna Problem : The GPS Antenna Problem alarm indicates the GNSS receiver
has detected an over-current or undercurrent condition (an open or short exists in the
GNSS antenna cable, or the GNSS antenna is not connected to NetClock). The receiver
will attempt to continue the normal acquisition and tracking process regardless of the
antenna status. The current draw measurements that will indicate an antenna problem
are:
Under-current indication < 8 mA
Over-current indication > 80 mA
Note: This alarm condition will also be present if a GNSS antenna splitter that
does not contain a load to simulate an antenna being present is being used.
GPS Antenna OK: The antenna coax cable was just connected or an open or short in the
antenna cable was being detected but is no longer being detected.
Frequency Error : The oscillator’s frequency was measured and the frequency error was
too large. Or, the frequency couldn’t be measured because a valid input reference was
not available.
Frequency Error cleared: The Frequency Error alarm was asserted but was then cleared.
In Holdover : Input references were available, but all input references have since been
lost. If the references are not restored before the Holdover period expires, time sync will
be lost.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
279
4.5 Quality Management
No longer in Holdover : Input references were lost at one point (or declared not valid),
but have since been restored OR the Input references were not restored before the Hol
dover period expired (Time Sync alarm is asserted).
In Sync : NetClock is synchronized to its Time and 1PPS inputs.
Not In Sync : NetClock is not synchronized to its Time and 1PPS inputs and is not cur
rently in Holdover. NTP will indicate to the network that it is Stratum 15 and so the time
server likely be ignored as a time reference.
Sending trap for event 1 (SNMPSAD): An SNMP trap was sent by the SNMP agent to
the SNMP Manager. The event number in this entry indicates which SNMP trap was sent.
The Unit has Rebooted: NetClock was either rebooted or power cycled.
Alarms Log
Displays log entries for the Timing System, for example:
The Unit has Rebooted: NetClock was either rebooted or power cycled.
In Holdover : Input references were available, but all input references have since been
lost. If the references are not restored before the Holdover period expires, time sync will
be lost.
No longer in Holdover : Input references were lost at one point (or declared not valid),
but have since been restored OR the Input references were not restored before the Hol
dover period expired (Time Sync alarm is asserted).
In Sync : NetClock is synchronized to its selected Time and 1PPS reference inputs.
Not In Sync : NetClock is not synchronized to its Time and 1PPS inputs and is not cur
rently in Holdover. NTP will indicate to the network that it is Stratum 15 and so the time
server likely be ignored as a time reference.
Frequency Error : The oscillator’s frequency was measured and the frequency error was
too large. Or, the frequency couldn’t be measured because a valid input reference was
not available.
Reference change: NetClock has selected a different Time and 1PPS input reference for
synchronization. Either the previously selected input reference was declared not valid (or
was lost), so a lower priority reference (as defined by the Reference Priority Setup table)
is now selected for synchronization OR a valid reference with higher priority than the
previous reference is now selected for synchronization.
EX A MPLE:
GNSS is the highest priority reference with IRIG input being a lower priority. NetClock is synced to
GNSS and so GNSS is the selected reference. The GNSS antenna is disconnected and IRIG
becomes the selected reference. The Reference change entry is added to this log.
Timing Log
280
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Displays log entries related to Input reference state changes (for example, IRIG input is not con
sidered valid), antenna cable status. Examples include:
GRGR = GNSS Reference1 antenna fault: The GNSS Antenna Problem alarm indicates
the GNSS receiver has detected an over-current or undercurrent condition (an open or
short exists in the GNSS antenna cable, or the GNSS antenna is not connected to NetC
lock). The receiver will attempt to continue the normal acquisition and tracking process
regardless of the antenna status.
GR antenna ok : The antenna coax cable was connected at this time or an open or short
in the antenna cabling was occurring but is no longer being detected.
GPS Qualification Log
If NetClock is connected to a GNSS antenna and is tracking satellites, this log contains a run
ning hourly count of the number of GNSS satellites tracked each hour. This history data can be
used to determine if a GNSS reception problem exists and whether this is a continuous or inter
mittent reception issue.
GNSS reception may be displayed as cyclic in nature. A cyclic 12 hour pattern of decreased
GNSS reception typically indicates that the GNSS antenna has an obstructed view of the hori
zon. The GNSS satellites are in a 12-hour orbit, so if part of the sky is blocked by large obstruc
tions, at the same time every day (at approximately 12 hour intervals), the GNSS reception
may be reduced or may vanish altogether. If this occurs, the antenna should be relocated to
afford it an unobstructed view of the sky.
Every hour (displayed in the log as UTC time), NetClock counts the total number of satellites that
were tracked during that hour. The GNSS qualification log shows the number of satellites that
were tracked followed by the number of seconds that the particular number of satellites were
tracked during the hour (3600 seconds indicates a full hour). The number to the left of the “=”
sign indicates the number of satellites tracked and the number to the right of the “=” sign indic
ates the number of seconds (out of a total of 3600 seconds in an hour) that the unit was track
ing that number of satellites. For example, “0=3600” indicates the unit was tracking 0 satellites
for the entire hour, while “0=2700 1=900” indicates the unit was tracking one satellite for 900
seconds, but for the remaining portion of the hour it was tracking zero satellites.
Every hourly entry in the log also contains a quality value, represented by “Q= xxxx” (where x
can be any number from 0000 through 3600). The Qualification log records how many satel
lites were tracked over a given hour. If for every second of the hour a tracked satellite was in
view, the Quality value will equal 3600. For every second NetClock tracked less than the min
imum number of satellites, the value will be less than 3600. The minimum requirement is one
satellite at all times after the unit has completed the GNSS survey and indicates “Stationary”. A
minimum of four satellites are required in order for the GNSS survey to be initially completed.
If all entries in the qualification log are displayed as “0=3600”, a constant GNSS reception
problem exists, so the cause of the reception issue is continuous. If the unit occasionally shows
0=3600 but at other times shows that 1 through 12 have numbers of other than “0000”, the
reception is intermittent, so the cause of the reception issue is intermittent. If the Quality value
1GR = GNSS Reference
CHAPTER 4 • NetClock User Reference Guide Rev. 13
281
4.5 Quality Management
normally equals 3600 but drops to lower than 3600 about every 12 hours, the issue is likely
caused by the GNSS antenna having an obstructed view of the sky.
Ex am ple
GPS
Q uali f i c ati o n
Lo g
Entr y :
6 = 151 7 = 1894 8 = 480 9 = 534 10 = 433 12 = 108 Q = 3600
In this example, NetClock tracked no less that 6 satellites for the entire hour. Out of the entire
hour, it was tracking 6 satellites for a cumulative total of 151 seconds (not necessarily in a
row). For the duration of the hour, it was tracking, 7, 8, 9, 10 and 12 satellites for a period of
time. Because it was tracking at least at least one satellite for the entire hour, this Quality value
is Q=3600.
Note: If NetClock is not connected to a GNSS antenna, this log will remain
empty.
Oscillator Log
Displays log entries related to oscillator disciplining. Provides the calculated frequency error
periodically while synchronizing to a reference.
Journal Log
Displays log entries created for all configuration changes that have occurred (such as creating
a new user account, for example).
Update Log
Displays log entries related to software updates that have been performed.
Authentication Log
Displays log entries for authentication events (e.g., unsuccessful login attempts, an incorrectly
entered password, etc.) that are made to NetClock’s command line interfaces (such as the front
panel setup port, telnet, SSH, FTP, etc.).
NTP Log (Not Configurable)
The NTP log displays operational information about the NTP daemon, as well as NTP through
put statistics (e.g., packets/sec.). Examples for entries in this log include indications for when
NTP was synchronized to its configured references (e.g., it became a Stratum 1 time server), as
well as stratum level of the NTP references.
The NTP throughput statistics data can be utilized to calculate mean values and the standard
deviation.
Example log entries include:
282
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Synchronized to (IP address), stratum=1: NTP is synchronizing to another Stratum 1
NTP server.
ntp exiting on signal 15: This log entry indicates NTP is now indicating to the network
that it is a Stratum 15 time server because it is not synchronized to its selected reference.
Time reset xxxxx s : These entries indicate time corrections (in seconds) applied to NTP.
No servers reachable: NTP cannot locate any of its configured NTP servers.
Synchronized to PPS(0), stratum=0: NTP is synchronized using the PPS reference clock
driver (which provides more stable NTP synchronization).
4.5.2.2
Local and Remote Logs
NetClock logs are all stored internally by default. With the exception of the NTP log, all logs
can also be configured to be stored externally, if desired.
The log entries for the logs can also be configured to be automatically sent to a Syslog Server
for external log storage. In order for these logs to be sent to a Syslog server, each desired log
needs to be configured for Syslog operation. With the exception of the Authentication and NTP
logs, all log setup options can be configured from the Logs Configuration page.
Note: The NTP log has no available configuration options.
In each log, entries appear with the most recent events first (i.e., in reverse chronological order,
starting from the top).
To set up a remote log server, see "Setting up a Remote Log Server" on page 290.
4.5.2.3
The Logs Screen
The Logs Screen not only provides a status overview of all log types, but also allows for all logs
to be configured.
To access the Logs Screen:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
283
4.5 Quality Management
2. The Logs screen will appear. It is divided into three panels:
The Logs panel
The Logs panel on the right-hand side provides a logs overview, displaying the status of all
NetClock logs.
To read a log, click the corresponding INFO button.
To configure a log, click the corresponding PENCIL button.
To clear a log, click the X-button.
Note: The Clear File feature does not delete any of the logs that have been sent to
and stored in a Syslog server.
A green indicator lamp shows if events of the corresponding log category are stored remotely
or locally.
The Logs Actions panel
The Actions panel on the upper-left corner of the Logs screen allows you to perform batch
actions on your logs:
Save and Download All Logs —Save and download all the logs on NetClock. See also:
"Saving and Downloading Logs" on page 286.
Clear All Logs —Clear all the logs on NetClock. See also: "Clearing Selected Logs" on
page 293.
Restore Configuration—Restore all log configurations to their factory settings. See also:
"Restoring Log Configurations" on page 292.
The Remote Log Server panel
284
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
The Remote Log Server panel, which is where you set up and manage logs on one or more
remote locations. See also: "Setting up a Remote Log Server" on page 290.
4.5.2.4
Displaying Individual Logs
Next to displaying a Logs overview (see "The Logs Screen" on page 283), it is also possible to
access individual NetClock logs:
1. From the TOOLS drop-down menu, select the desired Logs category (for example,
“Alarms”, or “Events”) from the right-hand column.
OR
1. Access the Logs screen through the MANAGEMENT > OTHER: Log Configuration dropdown menu:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
285
4.5 Quality Management
2. The Logs screen will be displayed:
3. Click on the INFO button for the desired log category.
4. A short log will be displayed, showing recent entries. Click on the ARROWS icon in the
top-right corner to expand to the full Logs view:
4.5.2.5
Saving and Downloading Logs
The NetClock Web UI offers a convenient way to save, bundle, and download all logs in one
simple step. This feature may be useful when archiving logs, for example, or for troubleshoot
ing technical problems: Spectracom Technical Support/Customer Service may ask you to send
them the bundled logs to remotely investigate a technical concern.
286
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
To save, bundle, and download all logs:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. On the left side of the screen, in the Actions panel, click on the Save and Download All
Logs button.
3. Select where to save the log bundle to. The default file name is netclock.log.
4. If so asked by Spectracom Technical Support, attach the bundled log files (typically
together with the oscillator status log, see: "Saving and Downloading the Oscillator Log"
below) to your email addressed to Spectracom Technical Support.
Saving and Downloading the Oscillator Log
The oscillator status log captures oscillator performance data, such as frequency error and
phase error. The data can be retrieved as a comma-separated .csv file that can be read and
edited with a spreadsheet software, such as Microsoft Excel®. You may want to review and/or
keep this data for your own records, or you may be asked by Spectracom Technical Support to
download and send the oscillator status log in the event of technical problems.
To download the oscillator status log:
1. Navigate to MANAGEMENT > OTHER: Disciplining.
2. Click on the ARROW icon in the top-right corner of the screen. Save the .csv file to your
computer.
3. If so asked by Spectracom Technical Support, attach the oscillator status log file (typ
ically together with the bundled NetClock log files, see: "Saving and Downloading
Logs" on the previous page) to your email addressed to Spectracom Technical Support.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
287
4.5 Quality Management
4.5.2.6
Configuring Logs
Note: The NTP log has no available configuration options.
To configure a log:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. In the Logs panel select the log you wish to configure, then click the corresponding
PENCIL button.
3. In the Log File window, fill in the available fields.
The following log configuration options are available:
a. Add/Remove Remote Server —The Syslog server(s) to which remote logs are sent. This
panel is only available if Remote Log is checked below in the Log Configuration panel.
If the log has a remote log server to which it writes, the name of the server will appear
here. Click Delete to remove the remote server.
288
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
Note: Clicking the Delete button in the Log File configuration window does
NOT remove the remote log server from the network. In this instance it
merely deselects the server as that particular log’s remote log server.
If the log does not have a remote log server assigned, there will be a drop-down list of
server choices. Click Add to add a remote server from the drop-down list.
If this list is empty, you will need to set up a remote log server through the Remote Log
Server panel. See "Setting up a Remote Log Server" on the next page.
b. Log File—Displays the name of the log file being configured.
c. Facility—Value (defined by the Syslog server) to determine where the log is stored in the
Syslog server. Set this value to match the scheme used by the remote server.
d. Priority—Value (defined by the Syslog server) to determine where the log is stored in the
Syslog server. Set this value to match the scheme used by the remote server.
Note about Facility and Priority values: In addition to configuring the log entries to be
sent to a specific location in the Syslog server, the combination of these two values also
determines which local log the entries are sent to inside NetClock.
Changing either or both of these values from the factory default values will alter which
log the entries are sent to inside NetClock.
The table below indicates which Log Tab the log entries will be sent to (by default),
based on the configuration of these two values.
If remote logging is not being used, the Facility and Priority values should not be changed from
the default values. Altering these values can cause log entries that have similar values to be sent
to the same log file (combining different types of log entries into one log). The factory default
settings for the Facility and Priority configurations of all logs that can be sent to a Syslog server
are as follows:
Table 4-1: Factory default facility and priority codes
Log Tab Name
Facility
Priority
Event
Local Use 7
Alert
Alarms
Local Use 7
Critical
Oscillator
Local Use 7
Debug
GPS Qualification
Local Use 7
Warning
CHAPTER 4 • NetClock User Reference Guide Rev. 13
289
4.5 Quality Management
Log Tab Name
Facility
Priority
Journal
Local Use 7
Notice
Update
Local Use 7
Information
Timing
Local Use 7
Error
System
Local Use 7
Emergency
e. Local Log—Enable or disable this particular log being stored inside NetClock. When
this box is checked, the log will be stored in NetClock.
f. Remote Log—Configure the desired Syslog servers. When this box is checked, the par
ticular log will be sent to a Syslog server.
In order for the logs to be formatted correctly for Syslog storage, all log entries are displayed
using Syslog formatting. Each log entry contains the date and time of the event, the source of
the log entry, and the log entry itself.
The “time” of all log entries will be in UTC, Local, TAI or GPS time, as configured in the “Time
scale” field that is located in the System Time Setup page (Setup/Time Management). For more
information on Timescales, see "Timescales" on page 143.
4.5.2.7
Setting up a Remote Log Server
Storing log files on a remote log server supports advanced logging functionality.
Adding a remote log server:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. In the Remote Log Server panel, click on the PLUS icon in the top-right corner of the
panel. The Add Remote Log Servers window displays.
3. Enter the IP address or host server name (e.g., “MyDomain.com”) you want to use as a
remote log server.
290
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.5 Quality Management
4. Click the Submit button.
5. Your remote log server will appear in the Remote Log Server panel, and as a SERVER
NAME in any Log File configuration screen:
Changing or deleting a remote log server:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. In the Remote Log Server panel locate the remote server you wish to change or delete.
3. Choose the MINUS button to delete the remote log server. Confirm by clicking OK in the
message window.
—OR—
3. In the Remote Log Server panel, click the GEAR button to change the remote log server.
Type in a new IP address or host domain server (e.g. MyDomain.com).
Note: Clicking the Delete button in any of the Log file configuration windows
does NOT remove the chosen remote log server from the network; it merely
deselects the server as that particular log’s remote log server.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
291
4.5 Quality Management
Note: In the event that a syslog server does not support listening on the standard
syslog port, you may redirect the syslog port to the desired port by utilizing builtin port forwarding capability in network switches (search online for port for
warding or port mapping).
4.5.2.8
Restoring Log Configurations
To restore log configurations:
1. Navigate to the MANAGEMENT > OTHER: Log Configuration.
2. In the Actions panel, click on the Restore Configurations button.
3. Click the Browse button.
4. Navigate to the directory where the configurations are stored and click Upload.
4.5.2.9
Clearing All Logs
Note: Authentication logs and NTP logs cannot be cleared.
All local logs in the home/spectracom directory will be logged. Other logs e.g., located
on Syslog Servers, must be maintained by the user.
To clear all locally stored log files:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. In the Actions panel, click Clear All Logs :
292
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.6 Updates and Licenses
3. In the grey confirmation window, click OK.
4.5.2.10 Clearing Selected Logs
Note: NTP logs cannot be cleared.
To clear selected locally stored log files:
1. Navigate to MANAGEMENT > OTHER: Log Configuration.
2. In the Logs panel, click the X-icon next to the log category you wish to clear (e.g.,
Alarms log).
3. In the grey confirmation box, click OK.
4.6
Updates and Licenses
4.6.1
Software Updates
Spectracom periodically releases new versions of software for NetClock. These updates1 are
offered for free and made available for download from the Spectracom website. If you
1The terms update and upgrade are both used throughout Spectracom technical literature, as software releases may
include fixes and enhancements, as well as new features.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
293
4.6 Updates and Licenses
register your product, you will be notified of software updates.
To download a software update for your NetClock as it becomes available, click here.
This web page also offers detailed instructions on how to perform a software update.
General Notes:
NetClock will save system configurations across upgrades but will not save other information. In
particular, update files may not be retained after a successful update.
All system elements will be forced to the versions in the update file, and all configuration inform
ation will be erased as part of the update. See "Backing-up and Restoring Configuration Files"
on page 297 for details.
To “roll back” system elements to an earlier version, select the older Update File in the Choose
File pull-down, select both Update System and Force Update, and click Update. All system ele
ments will be “forced” to the version in the update file.
Step-by-Step Instructions:
Note: These instructions apply to updates to recent software. Updates to software
versions older than 5.0.x may require additional steps. These will be covered in
the SWUI (Software Update Instructions) documents, which can be found under
the above-mentioned link.
1. In the Web UI, under Tools > Upgrade/Backup, determine the System software version
and the type of GNSS receiver. Proceed if your existing software is V5.1.5 or higher,
AND you have a RES-SMT GG receiver.
(Otherwise, consult the above-mentioned instructions for updating NetClock software.)
294
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.6 Updates and Licenses
2. Free up disk space, if needed:
Under Tools > Upgrade/Backup > Disk Status , check Percent Used: If the number is
greater than 70%, free up disk space.
(NOTE: If required, existing logs can be archived; for details consult the above-men
tioned instructions for updating NetClock software.)
To free up disk space:
a. Delete old log files: Tools > Upgrade/Backup > Disk Status > Clear All Logs .
b. Delete old statistics files: [~] > Clear All Stats .
c. Delete previous Upgrade files: Tools > Upgrade/Backup > Actions > Update
System > Delete Upgrade File(s). Note that Delete Upgrade File and Update Sys
tem cannot be selected at the same time.
3. Download the upgrade software bundle onto your PC.
4. Check if you have any of the following option cards installed:
Simulcast (Model 1204-14)
PTP (Model 1204-12)
Gigabit Ethernet (Model 1204-06)
If this is the case, see above- mentioned instructions for updating NetClock software
(unless this has been addressed at an earlier update).
5. Perform the actual upgrade by navigating to TOOLS > Upgrade/Backup > Actions :
Update System File: Upload the upgrade software bundle previously downloaded onto
your PC (updateXYZ.tar.gz), and carry out the upgrade, as instructed.
6. Verify that the upgrade was successful: Tools > Upgrade/Backup, confirm the new SW
version.
Note: In case the update failed, see "Troubleshooting Software Update" on
page 318 for additional information.
4.6.2
Applying a License File
Software options—if available for your product—must be activated by applying a license file:
Typically, NetClock units are shipped with the license file pre-installed, reflecting the system con
figuration as ordered. If a feature is to be activated after delivery of the NetClock unit, please
contact Spectracom Support or your local representative to have a license file generated.
License files are archive files with a tar.gz extension. One license file may contain multiple
licenses for multiple products.
To apply the license file, you need to upload it into your NetClock unit and install it:
1. Save the license file license.tar.gz to a location on your PC (which needs to be
connected to the same network NetClock is.)
CHAPTER 4 • NetClock User Reference Guide Rev. 13
295
4.7 Resetting the Unit to Factory Configuration
2. Open the NetClock Web UI, and navigate to Tools > Upgrade/Backup:
3. In the Actions panel, click Apply License File.
4. In the Apply License File window, click Upload New File.
5. In the Upload File window, click Choose File. Using the Explorer window, navigate to
the location mentioned under the first step, select the license file, and monitor the install
ation progress in the Status Upgrade window until the application has rebooted.
6. Refresh the browser window, and login to the Web UI again. Re-navigate to Tools >
Upgrade/Backup, and confirm that the newly installed Option is listed in the System
Configuration panel.
4.7
Resetting the Unit to Factory Configuration
In certain situations, it may be desired to reset all NetClock configurations back to the factory
default configuration. The GNSS location, any NetClock configurations and the locally stored
log files can be cleared via the Web UI.
Caution: It is not possible to clear the Authentication logs and NTP logs.
Note: Restoring configurations (reloading a saved configuration), erasing the
stored GNSS location and clearing the log files are separate processes. You may
restore one without restoring the others.
296
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.7 Resetting the Unit to Factory Configuration
If NetClock was assigned a static IP address before cleaning the configurations, it will be reset
to DHCP after the clean has been performed. If no DHCP server is available after the clean
operation, the static IP address will need to be manually reconfigured. See "Assigning a Static
IP Address" on page 43.
4.7.1
Resetting All Configurations to their Factory Defaults
To restore the configuration files to their factory defaults:
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the Actions panel, click the Restore Factory Defaults (Clean) button.
3. NetClock restores the configuration files to the factory settings, and then reboots in order
to read the new configuration files. Once powered back up, NetClock will be con
figured with the previously stored files.
Note: While the geographic GNSS position is stored and retained
through power cycles, choosing Clean (Restore Factory Configuration) will
erase the stored GNSS position.
Erasing the position stored in your GNSS receiver means that the next time the GNSS
antenna is connected and the GNSS receiver is able to continuously track at least four
satellites, a new GNSS survey will be initiated, so the position can be recalculated and
locked-in. A GNSS survey typically takes up to 33 minutes.
4.7.2
Backing-up and Restoring Configuration Files
Once NetClock has been configured, it may be desired to back up the configuration files to a
PC for off-unit storage. If necessary in the future, the original configuration of the NetClock can
then be restored into the same unit.
The capability to backup and restore configurations also adds the ability to “clone” multiple
NetClock units with similar settings. Once one NetClock unit has been configured as desired,
configurations that are not specific to each unit (such as NTP settings, log configs, etc.) can be
backed up and loaded onto another NetClock unit for duplicate configurations.
There are several configuration files that are bundled in one file for ease of handling.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
297
4.7 Resetting the Unit to Factory Configuration
Note: For security reasons, configurations relating to security of the product, such
as SSH/SSL certificates, cannot be backed up to a PC.
4.7.2.1
Accessing the System Configuration Screen
The System Configuration Screen provides comprehensive information about hardware and
software status. To access the System Configuration screen:
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. The System Configuration screen will display:
The System Configuration screen consists of 5 panels:
The Actions panel
The Actions panel is used for updating the system software, managing license files, saving and
restoring the configuration files, and restoring the factory defaults.
The System Configuration panel
The System Configuration panel provides the following information:
System —The model name of this unit, and the software version currently installed.
Model—The model number of this unit.
298
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.7 Resetting the Unit to Factory Configuration
Serial Number —The serial number of this unit.
Power Supply—The type of power supply installed in this unit. This can be AC, DC or
both.
Oscillator —The type of internal timing oscillator installed in this unit.
GNSS Receiver —The GNSS receiver in use with this unit.
HW Slots 1–6—The Option Cards installed in this unit.
The Upgrade Log panel
The upgrade log is a running log of system upgrades, used for historical and troubleshooting
purposes. It can be expanded by clicking on the DIAGONAL ARROWS icon in the top-right
corner:
Each log entry is comprised of a unique ID, the date the entry was created, the originator of the
entry, and the actual message. Refresh the log by clicking the CIRCLE ARROWS icon in the topright corner. Go to the First, Last, or Previous entries by clicking the corresponding buttons in
the bottom-right corner.
The Disk Status panel
The Disk Status panel provides information on the Compact Flash card memory usage. This
information is relevant for troubleshooting purposes, and when preparing the system for a soft
ware update.
The Software Versions panel
This panel provides version information on the different SW components utilized by the system.
4.7.2.2
Saving the System Configuration Files
To save (back up) the system configuration files:
CHAPTER 4 • NetClock User Reference Guide Rev. 13
299
4.7 Resetting the Unit to Factory Configuration
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the Actions panel, click the Save Configuration button.
3. Click OK in the grey confirmation window that displays.
4. Save the configuration file to a directory where it will be safe. NetClock simultaneously
saves a file at /home/spectracom/xfer/config/NetClock.conf.
4.7.2.3
Uploading Configuration Files
To upload configuration files from a PC:
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the Actions panel, click the Upload Configuration button.
3. Click Choose File in the window that displays, and navigate to the directory on your PC
where the bundled file is stored.
300
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.7 Resetting the Unit to Factory Configuration
4. Click the Upload button. NetClock saves the uploaded bundled file in the
/home/spectracom/xfer/config/directory.
Note: When uploading files remotely via long distances, or when upload
ing multiple files via several browser windows simultaneously, the upload
process may fail to complete. In this case, cancel the upload by clicking X,
and go back to Step 2.
5. To use the new configuration file for this NetClock, click the Restore Configuration but
ton, and follow the procedure described under "Restoring the System Configuration"
below.
4.7.2.4
Restoring the System Configuration
To restore the System Configuration:
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the Actions panel, click Restore Configuration.
3. Click OK in the grey confirmation window. The system will restore the configuration
using the bundled file stored at
/home/spectracom/xfer/config/NetClock.conf, then reboot in order to
read the new configuration file. Once powered back up, NetClock will be configured
with the previously stored file.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
301
4.7 Resetting the Unit to Factory Configuration
4.7.2.5
Restoring the Factory Defaults
For instructions on how to restore the NetClock's configuration files to their factory default set
tings see "Resetting All Configurations to their Factory Defaults" on page 297.
4.7.3
Cleaning the Configuration Files and Halting the System
The "Clean and Halt" procedure restores the configuration files to their factory defaults and
then immediately halts the system, so as to prevent any changes from being applied to the fact
ory default condition.
To perform a "Clean and Halt":
1. Navigate to TOOLS > SYSTEM: Upgrade/Backup.
2. In the Actions panel, click * Clean Configuration and Halt * .
3. NetClock restores the configuration files to their factory default, and halts the system.
4.7.4
Default and Recommended Configurations
The factory default configuration settings were chosen for ease of initial setup. Some of the
default settings may deviate from best practices recommendations, though. The following table
outlines the differences between factory default and recommended configuration settings for
your consideration:
Table 4-2: Default and recommended configurations
Feature
302
Default Setting
Recommended Setting
HTTP
Enabled
Disabled
HTTPS
Enabled (using customer-generated certificate and key or default Spectracom selfsigned certificate and common public/private key SSH/SCP/SFTP enabled with
unit unique 1024-bit keys)
Where to
Configure
Web UI
or CLI
Web UI
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.7 Resetting the Unit to Factory Configuration
Feature
Default Setting
Recommended Setting
Where to
Configure
SNMP
Enabled
Disabled or Enabled (with SNMP v3 w/
encryption*)
Web UI
NTP
Enabled (with no MD5 values entered)
Enabled (use MD5 authentication with
user-defined keys)
Web UI
Daytime Disabled
Protocol
Disabled
Web UI
Time
Disabled
Protocol
Disabled
Web UI
Command Line Interface
Serial
Port
Available
Available
n/a
Telnet
Enabled
Disabled (use SSH instead)
Web UI
SSH
Enabled (default private keys provided)
Enabled
Web UI
File Transfer
FTP
Enabled
Disabled (use SFTP or SCP)
Web UI
SCP
Available
Disabled (use SFTP or SCP)
Web UI
SFTP
Available
Disabled (use SFTP or SCP)
Web UI
* Spectracom recommends that secure clients use only SNMPv3 with authentication for secure
installations.
4.7.5
Sanitizing the Unit
The concept of sanitizing a NetClock unit refers to erasing usage data that may be stored in
volatile and/or non-volatile memory, i.e. permanently eliminating any data that could be used
to trace the unit's former usage. This data may include – but is not limited to – logs, con
figuration settings, IP addresses, passwords, GNSS geographic positioning data, and networkspecific usage data.
From a top level, cleaning a NetClock involves restoring the following to factory default con
figurations:
1. The file system on the Compact Flash (CF) card is restored to factory state by removing
the logs and restoring all configuration files to the default factory state.
2. Commercial GPS/GNSS receivers have stored position data deleted, and are setup to
resurvey on reboot.
The command line gpsreset clean option erases the GPS/GNSS receiver flash
memory, returning it to factory state and setting up to resurvey.
CHAPTER 4 • NetClock User Reference Guide Rev. 13
303
4.7 Resetting the Unit to Factory Configuration
3. SAASM GPS receivers are zeroized which deletes position, GPS data and keys.
Without valid keys the SAASM GPS only operates in L1 C/A mode like a com
mercial GPS receiver.
4.7.5.1
Physically Removing the CF Card
1. Read the topic "SAFETY" on page 31 and follow all applicable instructions pertaining to
safety and ESD compliance.
2. Remove the top cover off the chassis.
3. Locate the card socket on the main PCB.
4. Remove the metal bar that holds the card in the socket.
4.7.5.2
Cleaning/Restoring
Starting in system software version 4.8.7 (see under TOOLS > SYSTEM: Upgrade/Backup), the
Compact Flash card can be modified in several different ways via Actions panel under TOOLS
> SYSTEM: Upgrade/Backup:
Restore Configuration: This will reset all user configurations to factory defaults with the
exception of networking settings and GPS position. Network settings can be changed, if
desired, via the Web UI, via the front panel, or the serial command line interface. The
GPS position can be deleted via INTERFACES > REFERENCES: GNSS 0.
* Clean Configuration and Halt *: This will delete the network settings and the GPS pos
ition, as well as resetting all other user configurations to factory default. Alternatively,
"Clean" or "CleanHalt" can be initiated through the front panel or command line inter
face.
304
CHAPTER 4 • NetClock User Reference Guide Rev. 13
4.7 Resetting the Unit to Factory Configuration
4.7.5.3
Removing other files from the CF Card
While the restore and clean functions reset the configuration parameters, they do not remove
any files that may have been uploaded via FTP. One way to delete these files, if any, is via the
Update System Software functionality under TOOLS > SYSTEM: Upgrade/Backup.
The Clean Upgrade function wipes the CF card clean and recreates every system file. An
upgrade alone does not.
Note: When selecting both the Perform Upgrade checkbox, and the Clean
Upgrade checkbox, Force Upgrade will also be automatically selected, as neces
sary for this process.
4.7.5.4
Further Reading
For more information on Sanitization, see also:
"Deleting the GNSS Receiver Position" on page 180.
Certificate of Volatility, NetClock
Please search the Spectracom knowledge base support.spectracom.com for more specific
information regarding Sanitization and Volatility, or contact Spectracom Technical Support
(see "Technical Support" on page 411).
CHAPTER 4 • NetClock User Reference Guide Rev. 13
305
4.7 Resetting the Unit to Factory Configuration
BLANK PAGE.
306
CHAPTER 4 • NetClock User Reference Guide Rev. 13
APPENDIX
Appendix
The following topics are included in this Chapter:
5.1 Troubleshooting
308
5.2 Option Modules
319
5.3 Command-Line Interface
361
5.4 ASCII Time Code Data Formats
369
5.5 IRIG Standards and Specifications
395
5.6 Technical Support
411
5.7 Return Shipments
412
5.8 License Notices
413
5.9 List of Tables
425
5.10 List of Images
426
5.11 Document Revision History
427
NetClock User Reference Guide • APPENDIX
307
APPENDIX
5.1
Troubleshooting
The front panel LEDs and the Web UI provide NetClock status information that can be used to
help troubleshoot failure symptoms that may occur.
5.1.1
Troubleshooting Using the Status LEDs
The front panel Status LEDs can provide “local” status information about NetClock. Observe the
front panel Status LEDs and use the table below to find the recommended troubleshooting steps
or procedure for the observed condition.
LED
Current
Status
Power LED is
blank
(not lit).
Indication
NetClock has no AC and/or DC
input power applied.
Troubleshooting
1) Verify AC power is connected to an AC source
and AC power switch is ON.
2) Verify DC power (within the correct voltage
range, as stated on the DC connector) is applied
to the DC power connector.
3) See "Unpacking and Inventory" on
page 29
Sync
LED is
off
No valid Reference inputs avail
able since power-up.
1) Make sure the Input Reference Priority table has
the desired inputs enabled, based on desired pri
ority.
2) Make sure the desired input references are con
nected to the correct port of NetClock.
3) See "Configuring Input Reference Pri
orities" on page 157
Sync
308
LED is
orange
Holdover mode: All available
inputs have been lost.
1) Make sure the Input Reference Priority table still
has the desired inputs enabled, based on desired
priority. See "Configuring Input Reference Pri
orities" on page 157.
2) Make sure desired input references are still con
nected to the correct port of NetClock.
4) Verify GNSS antenna installation (if applic
able).
See "Troubleshooting GNSS Reception" on
page 314.
NetClock User Reference Guide
APPENDIX
LED
Current
Status
Indication
Troubleshooting
Sync
LED is
red
Time Sync alarm: NetClock was
just powered-up and has not yet
synced to its references. Or, all
available reference inputs have
been lost and the Holdover mode
has since expired.
Note: If NetClock was just recently powered-up or
rebooted and input references are applied, no
troubleshooting may be necessary. Allow a few
minutes for the input reference to be declared valid
(allow 35 – 40 minutes for a new install with
GNSS input).
1) Make sure the Input Reference Priority table still
has the desired inputs enabled, based on desired
priority. Refer to "Configuring Input Reference
Priorities" on page 157.
2) Make sure desired input references are still con
nected to the correct port of NetClock.
3) Verify GNSS antenna installation (if applic
able). Make sure the antenna has a clear view of
the sky.
Fault
LED is
GNSS Antenna problem alarm is
blinking asserted
orange
1) Verify GNSS antenna is connected to NetClock
GNSS input connector
Fault
LED is
solid
red
Major alarm is asserted
Refer to XXX
Fault
LED is
solid
orange
Minor alarm is asserted
Refer to XXX
2) Check antenna cable for presence of an open
or a short. Refer to XXX for additional information.
Table 5-1: Troubleshooting NetClock, using the front panel Status LED indications
5.1.2
Minor and Major Alarms
Minor Alarm
There are several conditions that can cause the front panel Fault lamp, or Web UI status lights to
indicate a Minor alarm has been asserted. These conditions include:
Too few GPS satellites, 1st threshold: The GNSS receiver has been tracking less than the
minimum number of satellites for too long of a duration. Refer to "Troubleshooting
GNSS Reception" on page 314 for information on troubleshooting GNSS reception
issues.
NetClock User Reference Guide
309
APPENDIX
Major Alarm
There are several conditions that can cause the front panel Fault lamp, or Web UI status lights to
indicate a Major alarm has been asserted. These conditions include:
Frequency error : Indicates a jump in the oscillator’s output frequency has been detected.
Contact Tech Support for additional information.
1PPS is not in specification: The 1PPS input reference is either not present or is not qual
ified.
System Sync : A Major alarm is asserted when the Timing System is not in sync (Input ref
erences are not available and the unit is not in Holdover). Examples of not being synced
include:
When the Timing System has just booted-up and has not yet synced to a ref
erence.
When all input references were lost and Holdover Mode has since expired.
Timing System Error : A problem has occurred in the Timing System. Contact Spectracom
technical support if the error continues.
5.1.3
Troubleshooting: System Configuration
One of the first tasks when troubleshooting a unit is to read out the current system configuration
(you may also be asked for this when contacting Spectracom Technical Support.)
Select TOOLS > Upgrade/Backup: The screen displayed will provide information on:
System configuration
Disk status, memory status
Software versions, and
Recent log entries.
310
NetClock User Reference Guide
APPENDIX
5.1.3.1
System Troubleshooting: Browser Support
Spectracom recommends using one of the following Web browsers to run the NetClockWeb UI
on: Google Chrome, Mozilla Firefox, Internet Explorer > Ver. 8.
Using different or older browsers may lead to some incompatibility issues.
5.1.4
Troubleshooting – Unable to Open Web UI
With NetClock connected to either a stand-alone or networked PC and with the network con
figuration correct, it should be possible to connect to the Web UI.
NetClock User Reference Guide
311
APPENDIX
Verify
Current Status
Indication
Troubleshooting
LEDs on
Green “Good link”
network
is not solid green
connector
NetClock ICMP test
is failing. NetClock
is not connected to
PC via Ethernet con
nection
1) Verify one end of standard network cable is
connected to NetClock’s Ethernet port and other
end is connected to a hub/switch. Or a network
cable is connected to NetClock and a standalone PC.
2) Verify network settings of NetClock are valid
for the network/PC it is connected with (IP
address is on the same subnet as the other PC).
Green “Good Link”
is solid green on
both NetClock and
other end of net
work cable.
NetClock ICMP test
is passing. NetC
lock is connected to
PC via Ethernet con
nection
1) Disconnect NetClock’s network cable and ping
its assigned address to ensure no response (no
duplicate IP addresses on the network).
2) Try accessing NetClock from another PC on
the same network.
3) Network Routing/firewall issue. Try connecting
directly with a PC and network cable.
Table 5-2: Troubleshooting network connection issues
5.1.5
Troubleshooting via Web UI Status Page
NetClock’s Web UI includes pages that provide current “remote” status information about NetC
lock. The following table includes information that can be used as a troubleshooting guidance
if status fault indications or conditions occur.
Web UI Page loc
ation
HOME page, Sys
tem Status panel,
Status row
Current Status
Indication
SYNC indicator is not “lit”
(not Green).HOLD indic
ator is “lit” (Orange).—
OR—FAULT indicator is
“lit” (Red). Below the Sys
tem Status panel there is an
Out of Sync alarm state
ment
NetClock is in
Holdover
mode—OR—
NetClock is now
out of Time Sync
Troubleshooting
All available Input References have
been lost. The Reference Status table
on the HOME page will show the cur
rent status of all inputs (Green is valid
and Red is invalid or not present).
1. Make sure the Input Reference Pri
ority table still has the desired ref
erence inputs Enabled, based on the
desired priority. See "Configuring
Input Reference Priorities" on
page 157.
2. Make sure the desired input ref
erences are still connected to the cor
rect input port of NetClock.
3. Verify GNSS antenna installation (if
applicable). See "Troubleshooting
GNSS Reception" on page 314.
312
NetClock User Reference Guide
APPENDIX
Web UI Page loc
ation
HOME page, Sys
tem Status panel,
Power row
Current Status
Indication
Troubleshooting
AC and/or DC indicator is
red instead of greenNOTE:
The AC indicator will only
display on the HOME
screen if NetClock is
equipped with an AC
power input.The DC indic
ator will only display on
the HOME screen if NetC
lock is equipped with a DC
power input.
Specified AC
and/or DC input
power is not
present.
Refer to Section "Connecting Sup
ply Power" on page 35 for AC and
DC power connection information:
If AC indicator is red:
1. Verify AC power cord is connected
to an AC outlet.
2. Verify AC power input switch is ON.
3. Check the two fuses in the AC
power module.
If DC indicator is red:
1. Verify DC power source is within
range specified at the DC power con
nector.
2. Verify DC power is present at the
input connector.
3. Verify DC input polarity.
NTP is not syn
chronized to its
available input
references
(NetClock may
have been in
Holdover mode,
but Holdover
has since
expired without
the return of
valid inputs)
Note: If NetClock was just recently
powered-up or rebooted and input ref
erences are applied, no troubleshoot
ing may be necessary. Allow at least
10-20 minutes for the input references
to be declared valid and NTP to align
to the System Time (allow an addi
tional 35-40 minutes for a new install
with GNSS input).
1. Verify in the Configure Reference Pri
orities table that all available ref
erences enabled. See "Configuring
MANAGEMENT/ Stratum 15
NTP Setup page
NTP Status Sum
mary panel
Stratum row
Input Reference Priorities" on
page 157.
2. Verify that the Reference Status on
the HOME page shows “OK” (Green)
for all available references.
3. Verify NTP is enabled and con
figured correctly. See "NTP Refer
ence Configuration" on page 98.
NetClock User Reference Guide
313
APPENDIX
Web UI Page loc
ation
Current Status
MANAGEMENT/ Cannot login or access the
NETWORK page Web UI.
Indication
Troubleshooting
The following
error message is
displayed:
“Forbidden You
don’t have per
mission to
access/ on this
server”
This message is displayed when any
value has been added to the Network
Access Rules table and your PC is not
listed in the table as an Allow From IP
address.To restore access to the
Web UI, either
1. Login from a PC that is listed as an
Allow From in this table; or
2. If it is unknown what PCs have been
listed in the Access table, perform an
unrestrict command to
remove all entries from the Network
Access Rules table. This will allow all
PCs to be able to access the Web UI.
Table 5-3: Troubleshooting using the Web UI Status indications
5.1.6
Troubleshooting GNSS Reception
If NetClock reports Holdover and/or Time Sync Alarms caused by insufficient GNSS reception:
When a GNSS receiver is installed in NetClock, a GNSS antenna can be connected to the rear
panel antenna connector via a coax cable to allow it to track several satellites in order for
GNSS to be an available input reference. Many factors can prevent the ability for the GNSS
receiver to be able to track the minimum number of satellites.
With the GNSS antenna installed outdoors, with a good view of the sky (the view of the sky is
not being blocked by obstructions), NetClock will typically track between 5-10 satellites (the
maximum possible is 12 satellites). If the antenna’s view of the sky is hindered, or if there is a
problem with the GNSS antenna installation, the GNSS receiver may only be able to a few
satellites or may not be able to track any satellites at all.
When GNSS is a configured time or 1PPS input reference, if the GNSS receiver is unable to
continuously track at least four satellites (until the initial GNSS survey has been completed) or at
least one satellite thereafter, the GNSS signal will not be considered valid. If no other inputs
are enabled and available, NetClock may not initially be able to go into time sync. Or, if
GNSS reception is subsequently lost after initially achieving time sync, NetClock will go into the
Holdover mode. If GNSS reception is not restored before the Holdover period expires (and no
other input references become available) NetClock will go out of sync. The GNSS reception
issue needs to be troubleshot in order to regain time sync.
For additional information on troubleshooting GNSS reception issues with NetClock, please
refer to the GNSS Reception Troubleshooting Guide , available here on the Spectracom web
site.
314
NetClock User Reference Guide
APPENDIX
5.1.7
Troubleshooting – Keypad Is Locked
The NetClock 9483 front panel keypad can be locked in order to prevent inadvertent oper
ation. It can be locked and unlocked using either the keypad or the Web UI. When locked, the
keypad operation is disabled until it is unlocked using either of the two following processes:
To unlock the front panel keypad, using the keypad (locally), perform the following key
sequence:
To unlock the front panel keypad, using the Web UI (remotely):
1. Open the NetClock Web UI, and navigate to MANAGEMENT > OTHER: Front
Panel.
2. Check the Lock Keypad box.
3. Click Submit.
5.1.8
Troubleshooting – 1PPS, 10 MHz Outputs
If the 1PPS and/or the 10 MHz output(s) (the latter is only available on NetClock 9483) are not
present, input power may not be applied. Or NetClock is not synchronized to its input ref
erences and Signature Control is enabled.
Web UI Page
HOME page
Current Status
Indication
Troubleshooting
Reference Status
Table
One or more
input references
indicate “Not
Valid” (red)
All available Input References have
been lost. The Reference Status table
on this same page will show the cur
rent status of all inputs (Green is valid
and red is not valid, or not present). If
Signature Control is enabled in this
state, the output may be disabled, see
"The Outputs Screen" on
page 133.
1. Make sure the Input Reference Pri
ority table still has the desired inputs
enabled, based on desired priority.
2. Make sure desired input references
are still connected to the correct input
port of NetClock.
3. Verify GNSS antenna installation (if
applicable).
NetClock User Reference Guide
315
APPENDIX
Web UI Page
Navigate to
INTERFACES/OUTPUTS/
PPS Output page
Current Status
Select the PPS
Output screen.
See "The Out
puts Screen"
on page 133.
Indication
Troubleshooting
Signature Con
trol will show
"Output Always
Enabled",
"Output Enabled
in Holdover",
"Output Dis
abled in Hol
dover" or
"Output Always
Disabled".
1. With "Output Always Enabled"
selected, the selected output will be
present no matter the current syn
chronization state.2. Any other con
figured value will cause the applicable
output to be halted if NetClock is not
fully synchronized with its input ref
erences.
Table 5-4: Troubleshooting 1PPS and/or 10 MHz outputs not being present
5.1.9
Troubleshooting – Blank Information Display
Note: This section applies only to NetClock 9483.
If the front panel 4-line LCD Information Display is blank:
As long as input power is applied (as indicated by the power light being green and the LED
time display incrementing) the 4-line LCD Information Display is capable of displaying data.
The Information Display can be configured to display different data while the keypad is not in
use. One available configuration is to have the Information Display show a blank page when
not in use. The Information Display operation can be verified and can also be configured via
the Web UI, or the front panel keypad.
A. Using the front panel keypad to verify the LCD Information Display is configured to dis
play a blank page:
To verify the front panel LCD Information Display is configured to display a blank page,
just press any keypad button. As long as the keypad is unlocked, the Home screen will
be displayed (after one minute of not pushing any keys, the screen will go back to
blank).
Note: The information that is selected, is the page that is normally displayed in
the LCD window, beginning one minute after the keypad is no longer being used.
316
NetClock User Reference Guide
APPENDIX
B. Using the front panel keypad to change the information normally displayed in the LCD
when the keypad is not in use:
To use the front panel keypad to reconfigure the LCD Information Display to show some
thing other than a blank page (such as GNSS information, network configuration, etc.),
see "Keypad and Information Display" on page 6.
C. Using the Web UI to change the information normally displayed in the LCD Information
Display when the keypad is not in use:
To use the Web UI to reconfigure the LCD Information Display to show something other
than a blank page (such as GNSS information, network configuration, etc.), refer to
"Configuring the Front Panel" on page 240.
5.1.10 Troubleshooting the Front Panel Serial Port
The front panel serial port can be used for NetClock configuration or to obtain select data. The
serial port is a standard DB9 female port. Communication with this port is via a standard
DB9 F to DB9M serial cable (minimum pinout is pin 2 to 2, pin 3 to 3 and pin 5 to 5) con
nected to a PC running a terminal emulator program such as Tera Term or Microsoft Hyper
Terminal. The port settings of the terminal emulator should be configured as 9600, N, 8, 1
(flow control setting does not matter).
If the terminal emulator program does not display any data when the keyboard <Enter> key is
pressed, either NetClock is not powered up or there is a problem with the connection between
NetClock and the PC.
Using a multimeter, ring out the pins from one end of the serial cable to the other. Verify the
cable is pinned as a straight-thru serial cable (pin 2 to 2, pin 3 to 3 and pin 5 to 5) and not as
a null-modem or other pin-out configuration.
Disconnect the serial cable from NetClock. Then, jumper (using a wire, paperclip or car key,
etc.) pins 2 and 3 of the serial cable together while pressing any character on the PC’s key
board. The character typed should be displayed on the monitor. If the typed character is not
displayed, there is a problem with either the serial cable or with the serial COM port of the
PC.
Refer to "Setting up a Terminal Emulator" on page 363 for more information on using a ter
minal emulator software to communicate with NetClock via serial port.
5.1.11 Troubleshooting the Front Panel Cooling Fan
The cooling fan (located on the front panel, to the right of the LED time display) is a tem
perature controlled cooling fan. Temperature sensor(s) determine when the cooling fan needs to
turn on and off. It is normal operation for the cooling fan to not operate the entire time NetC
lock is running. It may be turned off for long periods at a time, depending on the ambient and
internal temperatures.
NetClock User Reference Guide
317
APPENDIX
To verify the cooling fan is still operational, power cycle NetClock unit (if AC and DC power
are both applied, momentarily turn off the AC power switch and disconnect the DC power con
nector).
Note: If the internal temperature in the unit is below 30 degrees Celsius, the fan
may not turn on as part of the power-up sequence. In this case, it is recommended
to let the unit “warm up” for approximately 30 minutes, in order to allow the unit
to get to the appropriate temperature.
See also: "Temperature Management" on page 272
5.1.12 Troubleshooting – Network PCs Cannot Sync
In order for clients on the network to be able to sync to NetClock, several requirements must be
met:
1. The PC(s) must be routable to NetClock. Make sure you can access NetClock Web UI
from a PC that is not syncing. If the PC cannot access the Web UI, a network issue likely
exists. Verify the network configuration.
2. The network clients have to be configured to synchronize to NetClock's address. For
additional information on syncing Windows PC's, see
http://support.spectracom.com/articles/How_To/Synchronizing-WindowsComputers. The last section of this document also contains troubleshooting assistance
for Windows synchronization. For UNIX/Linux computer synchronization, please visit
http://www.ntp.org/.
3. If at least one PC can sync to NetClock, the issue is likely not with NetClock itself. The
only NetClock configurations that can prevent certain PCs from syncing to the time server
are the NTP Access table and MD5 authentication. See "Configuring NTP Symmetric
Keys" on page 113. A network or PC issue likely exists. A firewall may be blocking Port
123 (NTP traffic), for example.
4. NTP in NetClock must be “in sync” and at a higher Stratum level than Stratum 15 (such
as Stratum 1 or 2, for example). This requires NetClock to be either synced to its input
references or in Holdover mode. Verify the current NTP stratum level and the sync status.
5.1.13 Troubleshooting Software Update
When experiencing slow data transmission rates, or other network issues, it may be possible
that a system software update will be aborted due to a web server timeout during the transfer.
318
NetClock User Reference Guide
APPENDIX
In such an event, the Upload New File window will disappear, and the Upgrade System Soft
ware window will be displayed again instead.
Should this happen repeatedly, you can transfer the update file using a file transfer pro
tocol such as scp, sftp or ftp, if security is not a concern. The update can then be initiated
from the Web UI or Command Line.
Disk Status: In the event of an aborted update process, under Tools > Upgrade/Backup
> Disk Status , check Percent Used: If the number is greater than 70%, free up disk
space, before starting another attempt to update the System Software.
Software Versions older than 5.3.0:
Note that failed update attempts may result in lost Disk Space on the NetClock. Reboot the sys
tem to erase unwanted update files.
Software Version 5.3.0 and higher:
In the event that an update process becomes aborted, clicking Update System Software will
automatically erase unwanted update files.
5.2
Option Modules
This Chapter lists all option modules currently available, their features, specifications, and how
to configure them via the Web UI.
5.2.1
Accessing Option Module Settings via the Web UI
The topics below describe Web UI functionality that is common to all Option Modules.
NetClock User Reference Guide
319
APPENDIX
5.2.1.1
Web UI Navigation: Option Modules
Figure 5-1: Option module navigation
To view or edit option module settings in the NetClock Web UI (see also image above):
Status Summary panel
Under INTERFACES > OPTION CARDS , clicking the superordinate list entry will open
the Status Summary panel, which provides a status overview, as well as access to the
Status window and the Edit window.
Status window
Under INTERFACES > OPTION CARDS , clicking subordinate (indented) entries will
open the Status window, providing detailed option module status information.
Edit window
To edit option module settings, either click the Edit button in the lower-left corner of the
Status window, or click the GEAR button in the Status Summary panel: The Edit window will
open.
320
NetClock User Reference Guide
APPENDIX
5.2.1.2
Viewing Input/Output Configuration Settings
The configurable settings of any NetClock input or output interface can be viewed in its Status
window. The Status window can be accessed in several ways; the procedure below describes
the standard way:
1. Identify the name of the option module, (e.g., NENA ) and the name of the input or out
put you want to configure (e.g., ASCII Output 0).
Note: If you have only one input or output of any type, NetClock will num
ber that input or output 0. Additional inputs or outputs will be numbered 1
or above.
2. Navigate to INTERFACES > OPTION CARDS , and click the list entry of the option mod
ule identified above. The option module’s Status Summary panel opens:
3. Click on the INFO button next to the input or output whose settings you wish to review.
The Status window will open:
NetClock User Reference Guide
321
APPENDIX
4. If you want to change any of the settings shown in the Status window, click the Edit but
ton in the bottom-left corner. The Edit window will open:
5. Information about the configurable settings can be found in the corresponding option
module section, see "NetClock 9483—Available Option Modules" on page 12, or
"NetClock 9489 Outputs" on page 345.
5.2.1.3
Configuring Option Module Inputs/Outputs
The configurable settings of any NetClock input or output interface are accessible through the
Edit window of the option module to which the input or output belongs. The Edit window can
be accessed in several ways; the procedure below describes the standard way:
1. Identify the name of the card, (e.g., NENA), and verify the name of the input or output
you want to configure (e.g., ASCII Output 0).
322
NetClock User Reference Guide
APPENDIX
Note: If you have only one input or output of any type, NetClock will num
ber that input or output 0. Additional inputs or outputs will be numbered 1
or above.
2. Navigate to the INTERFACES > OPTION CARDS drop-down menu, and click the list
entry of the option module identified above. The option module’s Status Summary panel
opens:
3. Click on the GEAR button next to the input or output you wish to configure (as verified in
Step 1 of this procedure). The Edit window of the input or output opens:
NetClock User Reference Guide
323
APPENDIX
4. Information about the configurable settings can be found in the corresponding option
module section, see "NetClock 9483—Available Option Modules" on page 12, or
"NetClock 9489 Outputs" on page 345.
5.2.1.4
Viewing an Input/Output Signal State
To view if an input or output is currently enabled or disabled, go to the option module’s Status
Summary panel:
1. Identify the name of the option module, (e.g., NENA ), and the name of the input or out
put you want to configure (e.g., ASCII Output 0).
Note: If you have only one input or output of any type, NetClock will num
ber that input or output 0. Additional inputs or outputs will be numbered 1
or above.
324
NetClock User Reference Guide
APPENDIX
2. Navigate to the INTERFACES > OPTION CARDS drop-down menu, and click the list
entry of the option module identified above. The option module’s Status Summary panel
opens:
All the inputs and/or outputs of this option module are listed in the Status Summary panel.
In accordance with the Signature Control setting, and the Lock Status, the current signal state for
an output is indicated as:
ENABLED (green); or
DISABLED (orange)
The current state of an input signal is indicated as:
VALID (in green); or
INVALID (in red)
The Status Summary panel will be refreshed automatically every 30 seconds. Click the Refresh
button (circling arrows) on the right to refresh the status instantaneously. A slight refreshment
delay is normal (the duration depends on the configuration of your system.)
5.2.1.5
Verifying the Validity of an Input Signal
The HOME page of the NetClock Web UI provides quick access to the status of all inputs via its
Reference Status panel.
NetClock User Reference Guide
325
APPENDIX
If an INPUT is not present, or not valid, and qualified , the 1PPS Validity and Time Validity fields
will be “Not Valid” (orange).
If an INPUT is present, and the signal is considered valid, and qualified , the two indicators will
then turn “Valid” (Green).
5.2.2
NetClock 9483 Option Modules
Spectracom offers several configurations for the NetClock 9483. This section contains technical
details and specifications for option modules that may have been selected at the time of pur
chase, and information regarding configuration and usage that can be used after installation.
Also covered are commonly used Web UI procedures for the configuration of option modules,
and the status review of option module inputs and outputs.
326
NetClock User Reference Guide
APPENDIX
Table 5-5: Option Modules available for NetClock 9483
Option
Name
Module/PN
Description
Refer to Section
NENA
1209-1F
NENA-Compliant Module
"NENA-Compliant Module" below
Option 16
1209-06
Gigabit Ethernet (3X,
10/100/1000BaseT)
"Gigabit Ethernet Module [Option 16]"
on page 338
Option 13
1209-0A
T1/E1 – (100/20 Ω)
"T1/E1 Out Module [Option 13]" on
page 340
Contact sales@spectracom.com general inquiries regarding option module card functionality
or availability.
If you do not have a NetClock 9483 product that already shipped pre-configured with specific
option modules, or if you have purchased new option modules for your NetClock 9483, refer
to the Option Card Installation Guide for NetClock 9400 Series document for detailed
installation steps.
5.2.3
NENA-Compliant Module
NetClock 9483 is equipped with a NENA-compliant module which provides:
IRIG support (including support for all NENA formats)
ASCII RS-232 time code support
ASCII RS-485 time code
relay/alarms.
Note: This module is not available for NetClock 9489.
NetClock User Reference Guide
327
APPENDIX
5.2.3.1
NENA-Compliant Module: Specifications
Outputs:
(1) IRIG B/E, IEEE
1344/C37.118-2005
(AM/TTL) Connectors: BNC (J1)
Accuracy:
(1) ASCII RS-232
(1) ASCII RS-485
DB9F (J2)
3.81 mm Terminal block (J3)
±20 to ±200 μs of UTC, format- ±100-1000 μs
dependent
(format-dependent)
±100-1000 μs
(format-dependent)
(2)
Relay/Alarm
Switch time
4ms, max.
Table 5-6: NENA module specifications
Figure 5-2: Rear plate of NetClock 9483 NENA-compliant module
5.2.3.2
IRIG Output Specifications
AM IRIG Output:
Output impedance: 50 Ω nominal
Amplitude (adjustable):
500 mVp-p min, 6Vp-p max into 50 Ω
1Vp-p min, 12 Vp-p max into > 600 Ω
AM Carrier:
IRIG A – 10 kHz
IRIG B – 1kHz
IRIG E – 100 Hz, 1kHz
IRIG G – 100 kHz
Modulation Ratio: 3.3:1 nominal
328
NetClock User Reference Guide
APPENDIX
DCLS IRIG Output:
Signal Level: 0V to 4.3 V (TTL compatible) into 50 Ω
Output impedance of buffer is ~7 to 10 Ω
5.2.3.3
ASCII RS-232 Specifications
Outputs :
±5VDC minimum, ±5.4 VDC typical
Signal Type and Connector :
RS-232 DB-9F
RS-232 Input:
-25 VDC to +25 VDC
+0.6VIL min, +1.2VIL TYP
+1.5VIH TYP, +2.4VIH MAX
Input impedance > 3kΩ
RS-232 Output:
±5VDC minimum
±5.4 VDC typical
Output impedance 300 Ω, minimum
-13.2 VDC to +13.2 VDC
1PPS Output:
Signal level: 0V to 4.3 V (TTL compatible) into 50 Ω
Output impedance of buffer is ~7 to 10 Ω
Rise/fall times of ~20 nsec.
Pin Assignments
Figure 5-3: DB-9 connector "J2"
NetClock User Reference Guide
329
APPENDIX
Pin No.
Signal Name
Function
Top row of 5 pins
1
PPS_OUT
1PPS output
2
SERIAL_OUT_TX
RS-232 Transmit data
3
SERIAL_OUT_RX RS-232 Receive data
4
NC
No connection
5
GND
Ground
Bottom row of 4 pins
6
NC
No connection
7
NC
No connection
8
NC
No connection
9
NC
No connection
Table 5-7: ASCII RS-232 Output connector pin assignments
5.2.3.4
ASCII RS-485 and Alarms/Relays Specifications
Inputs/Outputs :
(2) Two contact relay connections (NC, common, NO)
Signal Type and Connector :
Terminal block
Contacts Switch under max. load of 30 VDC, 2A
Contacts rated to switch 220 VDC
Breakdown voltage of 1000 VDC between contacts
Switch time 4ms, max.
RS-485 Differential Output:
+1.65 V Typical Common Mode Output Voltage
2V min Differential Output Voltage Swing with 100 Ω load,
3.3 V Differential Output Voltage Swing, No Load, with ESD protection
330
NetClock User Reference Guide
APPENDIX
Pin Assignments
Figure 5-4: RS-485 connector "J3"
Connector Pin
Signal
Direction
Characteristics
1
RS-485 TX+
Out
0V to 3VDC differential, 120 Ω load
2
RS-485 TX-
Out
0V to 3VDC differential, 120 Ω load
3
GROUND
N/A
GROUND
4
Relay 1 NO
Out
Normally Open 30 VDC, 2A max. switching power
5
Relay 1 NC
Out
Normally Closed 30 VDC, 2A max. switching power
6
Relay 1 COMMON Out
Common Contact 30 VDC, 2A max. switching power
7
Relay 2 NO
Out
Normally Open 30 VDC, 2A max. switching power
8
Relay 2 NC
Out
Normally Closed 30 VDC, 2A max. switching power
9
Relay 2 COMMON Out
Common Contact 30 VDC, 2A max. switching power
10
GROUND
GROUND
N/A
Table 5-8: Relay/RS-485 outputs pin assignments
Note: The last device on each of the RS-485 remote output should be terminated
into 120 Ω. Auxiliary Spectracom equipment (such as wall display clocks) include
a 120 Ω resistor for termination.
NetClock User Reference Guide
331
APPENDIX
5.2.3.5
Configuring the IRIG Time Code Output
Via INTERFACES > OUTPUTS [ or : INTERFACES > OPTION CARDS ], navigate to IRIG
Output 0 . Depending on which path you take, you will need to click the GEAR button, or the
Edit button in order to open the Edit window.
Note: If you have only one input or output of any type, NetClock will number that
input or output 0. Additional inputs or outputs will be numbered 1 or above.
The IRIG output Edit window offers the following configuration fields:
Signature Control: Used to control when the IRIG modulation will be present. This func
tion allows the modulation to stop under certain conditions; see also "Signature Control"
on page 136.
Format: Defines the desired IRIG output formatting. Available options include: IRIG A, B,
G, NASA-36, IRIG E (100 Hz or 1kHz)
332
NetClock User Reference Guide
APPENDIX
Modulation: Changes the type of output signal modulation:
IRIG AM is an amplitude modulated output. The amplitude of the output is determ
ined by the value entered in the “Amplitude” field.
IRIG DCLS is a TTL modulated output.
Frequency: If AM modulation is chosen above, the frequency is offered. Otherwise No
Carrier is displayed.
Coded Expression: Defines the data structure of the IRIG signal, where:
BCD = Binary Coded Decimal
TOY = Time of Year
CF = Control Field
SBS = Straight Binary Seconds
Control Function Field: IRIG signals have an optional section in the data stream that can
be used to include additional information (such as the present year, for example). This
field allows the Control Field section of the IRIG output to be defined. The available con
figurations are as follows:
RCC-2004: IRIG spec 200-04 specified a location for year value, if included in
this field.
IEE 1344 (C37.118-2005): IRIG B format with extensions. Control Field contains
year, Leap Second and DST information.
Spectracom Format: Year is included in Control Field but not in the same loc
ation as RCC-2004 output (year is offset by one position).
Spectracom FAA Format: A unique IRIG output Control Field that contains satel
lite lock status and time error flags.
NASA : A variant of IRIG B.
Time Scale: Used to select the time base for the incoming time code data. The entered
Timescale is used by the system to convert the time in the incoming data stream to UTC
time for use by the System Time. The available choices are:
UTC : Coordinated Universal Time ("temps universel coordonné"), also referred to
as ZULU time
TAI: Temps Atomique International
GPS : The raw GPS time as transmitted by the GNSS satellites (as of July, 2015,
this is 17 seconds ahead of UTC)
NetClock User Reference Guide
333
APPENDIX
A local clock set up through the Time Management Page: This option will appear
under the name of the local clock you have set up (see . Local timescale allows a
Local Clock to apply a time offset for Time Zone and DST correction.
Amplitude: The peak-to-peak output voltage level into a 600 Ω load is adjusted by enter
ing a digital control value in this field. The level adjustment has no effect on TTL outputs,
only on AM formats. The value of 128 will cause the Mark amplitude to be about 5Vp-p
into high impedance. A value of 200 results in an output amplitude of about 9Vp-p into
high impedance.
Note: These are nominal values only. Actual values will vary from unit to
unit. To adjust the level precisely, connect an oscilloscope to the output con
nector when adjusting.
Offset: Provides the ability to account for IRIG cable delays or other latencies in the IRIG
input. The Offset value is entered and displayed in nanoseconds (ns). The available Off
set range is -500 to +500 ms.
Each IRIG code specifies a carrier frequency that is modulated to encode date and time, as well
as control bits to time-stamp events. Initially, IRIG applications were primarily military and gov
ernment associated. Today, IRIG is commonly used to synchronize voice loggers, recall record
ers, and sequential event loggers found in emergency dispatch centers and power utilities.
For more information on IRIG frequency and output specifications, see "IRIG Standards and
Specifications" on page 395.
5.2.3.6
Configuring an ASCII Time Code Output (RS-232 or RS-485)
Note: The process of configuring the ASCII Time Code output is independent of
the communications protocol.
Via INTERFACES > OUTPUTS [or: INTERFACES > OPTION CARDS ], navigate to the ASCII Out
put you want to configure. Depending on which path you take, you will need to click the GEAR
button, or Edit button in order to open the Edit window:
334
NetClock User Reference Guide
APPENDIX
Note: If you have only one input or output of any type, NetClock will number that
input or output 0. Additional inputs or outputs will be numbered 1 or above.
The Edit window offers the following configuration fields:
Format Group: Determines the time code message format category (see also "ASCII Time
Code Data Formats" on page 369). Choices are:
None
NENA-Spectracom (Formats 0, 1, 2, 3, 4, 7, 8, 9, 1S)
NMEA (GGA, RMC, ZDA message)
BBC (Formats 1, 2, 3 PSTN, 4, 5 RMC)
ICD-153 (Buffer Box, Time Transfer, Current Status)
EndRun (EndRun Time Format, Endrun X Format)
Format: Once a Format Group has been selected, one or more Format fields may
appear, allowing you to select one or more time code Formats . For more information
on time code formats, see "ASCII Time Code Data Formats" on page 369.
NetClock User Reference Guide
335
APPENDIX
The choice of format group determines t he format choices available in the Format
1, Format 2 and Format 3 fields.
Format 1: Selects either the first of up to three, or the only format message
to be output. See "ASCII Time Code Data Formats" on page 369 for a
description of available formats.
Format 2: Selects the second consecutive format message to be outputted.
Select “None” if only one output format is desired. See "ASCII Time Code
Data Formats" on page 369 for a description of available formats.
Format 3: Selects the third consecutive format message to be outputted.
Select “None” if only one output format is desired. See "ASCII Time Code
Data Formats" on page 369 for a description of available formats.
Signature Control: Used to control when the IRIG modulation will be present. This func
tion allows the modulation to stop under certain conditions; see also "Signature Control"
on page 136.
Output Mode: This field determines when the output data will be provided. The avail
able Mode selections are as follows:
Broadcast: The format messages are automatically sent out on authorized con
dition (Signature control), every second a message is generated in sync with the
1PPS.
Request (On-time): A format message is generated in sync with 1PPS after the con
figured request character has been received.
Request (Immediate): A format message is generated as soon as the request char
acter is received. As this selection does not correlate the output data to the on-time
point for the message, in Data Formats that do not provide sub-second inform
ation (such as Formats 0 and 1 whereas Format 2 provides sub-second inform
ation), it should be noted that the output data can be provided immediately, but a
time error could occur when using the on-time point of the message in addition to
the data for timing applications.
Timescale: Used to select the time base for the incoming ASCII time code data. The
entered Timescale is used by the system to convert the time in the incoming ASCII data
stream to UTC time for use by the System Time. The available choices are:
UTC : Coordinated Universal Time ("temps universel coordonné"), also referred to
as ZULU time
TAI: Temps Atomique International
GPS : The raw GPS time as transmitted by the GNSS satellites (as of July, 2015,
this is 17 seconds ahead of UTC time)
336
NetClock User Reference Guide
APPENDIX
A local clock set up through the Time Management Page: This option will appear
under the name of the local clock you have set up. Refer to "The Time Man
agement Screen" on page 140 for more information on how to configure and
read the System Time. Local timescale allows a Local Clock to apply a time offset
for Time Zone and DST correction.
The incoming input time information may be provided as local time, but System
Time may be configured as UTC time, so internal computations need to be per
formed. With the Timescale field set to “Local”, select the name of a previously cre
ated Local Clock. The Time Zone and DST rules, as configured in the Local Clock
will be applied to the front panel time display. See .
Note: The Timescale of the ASCII input (as configured in the ASCII time
source) must be set correctly, especially if other input references are
enabled.
Failure to configure the Timescale of the ASCII input correctly could result
in time jumps occurring in the System Time when input reference changes
occur. These time jumps could affect NTP and normal operation of the sys
tem.
Baud Rate: Determines the speed that the output port will operate at.
Data Bits : Defines the number of data bits for the output port.
Parity: Configures the parity checking of the output port.
Stop Bits : Defines the number of stop bits for the output.
5.2.3.7
Configuring the Relay/Alarm Output
To manage the alarm relays:
1. Via the INTERFACES > Alarm Output drop-down menu, navigate to the Alarm Output
entry for the card you wish to configure. Depending on the path taken, …
… click Edit or the GEAR button to edit the Alarm Output settings, or
… click Status or the INFO button to view the current settings for the Alarm
Output:
NetClock User Reference Guide
337
APPENDIX
2. The Alarm Type options displayed/to choose from are:
None: Will not output for an alarm.
Minor : Will output on a minor alarm.
Major : Will output on a major alarm.
5.2.4
Gigabit Ethernet Module [Option 16]
This option module provides NetClock with three 10/100/1000 Base-T network interfaces, in
addition to the standard 10/100 Base-T network interface.
5.2.4.1
Gigabit Ethernet Module: Specifications
Inputs/Outputs : (3) Gigabit Ethernet (10/100/1000 Base-T)
Connectors : RJ-45 (3x)
Management: Enabled or Disabled (NTP server only)
Maximum Number of Cards : 1
Ordering Information: 1204-06: Gigabit Ethernet (3X) Module
338
NetClock User Reference Guide
APPENDIX
Figure 5-5: 1204-06 option module rear plate
5.2.4.2
Network Setup
To monitor and manage Ethernet on NetClock:
Navigate to MANAGEMENT > Network Setup. On the right side of the Network Setup
screen, the Ports panel will display the available Ethernet ports, and their connection
status:
Eth0 is the built-in NetClock Ethernet port. Eth1 through eth3 are the ports provided by
the 1204-06 card.
To learn more about Ethernet setup, see "Configuring Network Settings" on page 55.
5.2.4.3
Routing Tables
There are five (5) routing tables in the system: one for each network interface, and one main
routing table.
NetClock User Reference Guide
339
APPENDIX
Main Routing Table: This routing table is used when network traffic is generated from
the server. It will generally have the same default gateway as the routing table for eth0,
unless configured otherwise.
Interface Routing Tables : These routing tables are specific to each interface. They are
named t0 (for eth0 interface) though t3 (for eth3 interface).
The system is configured by default with rules to use the individual routing table for each
interface for all network traffic being received or transmitted from or to the cor
responding interface. For example, when an NTP request is received on interface eth2, it
is tagged as such and the response will use routing table t2 when sending the NTP
response packet.
Each routing table has a default gateway that is used when there is no explicit routing
table entry that matches the destination address for a given network packet.
For information on configuring routing tables see "Static Routes" on page 60, and see Spec
tracom Tech Note Routing of data across multiple networks.
Domains and Domain Name Servers (DNS)
Each network interface may exist on a separate domain and therefore have a different domain
name and domain name servers from the other interfaces.
The system supports a single domain name and up to 2 DNS addresses per network interface.
These may be assigned via DHCP or configured manually via the Web UI configuration screen
for each network interface.
Configuring Ethernet Ports
For information on configuring Ethernet ports, see "Network Ports" on page 57.
5.2.5
T1/E1 Out Module [Option 13]
The E1/T1 option modules provide 1.544 MHz or 2.048 MHz and E1 or T1 data outputs for
the NetClock platform (NetClock 9483 only). NetClock meets G.812 Type I when installed with
a Rubidium option, and G.811 when installed with a Rubidium option and synchronized with
GNSS.
Note: Rubidium oscillators are recommended for the E1/T1 option module.
340
NetClock User Reference Guide
APPENDIX
5.2.5.1
Module Option 13 E1/T1 (120 Ω): Specifications
Outputs :
(1) 1.544/2.048 MHz RS-485 Outputs
(2) Balanced E1/T1Outputs
T1 mode:
1.544 MHz (square wave) frequency output
(2) 1.544 Mb/sec data rate outputs:
Outputs are DS1 framed all ones
Supports Super Frame (SF or D4) and Extended Super Frame (ESF)
SSM support
E1 mode:
2.048 MHz (square wave) frequency output
(2) 2.048 Mb/sec data rate outputs:
Outputs are E1 frame all ones
Supports CRC4 and CAS Multiframe
SSM support
Connector and Signal Type: Terminal block
1.544/2.048 MHz RS-485
T1 according to GR-499-CORE (100 Ω)
E1 according to ITU-T G703 (120 Ω)
Maximum Number of Cards : 4
Ordering Information: Option 13: T1/E1 (100/120 Ω) module
Figure 5-6: Option 13 T1/E1 module rear plate
NetClock User Reference Guide
341
APPENDIX
Table 5-9: Option 13 pin assignments
Pin Assignments
Pin No.
5.2.5.2
Signal
Function
Ground
Description
1
GND
Ground
2
1.544MHz/2.048MHz RS-485 A Terminal Square wave
3
1.544MHz/2.048MHz RS-485 B Terminal
Square wave
4
GND
Ground
Ground
5
T1/E1 output A1
GR-499/G.703
Tip
6
T1/E1 output B1
GR-499/G.703
Ring
7
GND
Ground
Ground
8
T1/E1 output A2
GR-499/G.703
Tip
9
T1/E1 output B2
GR-499/G.703
Ring
10
GND
Ground
Ground
E1/T1 Output: Edit Window
To configure an E1/T1 data output , navigate to its Edit window. For instructions, see: "Con
figuring Option Module Inputs/Outputs" on page 322.
342
NetClock User Reference Guide
APPENDIX
The Edit window allows the configuration of the following settings:
Signature Control: Controls when the output will be present. For more information, see
"Signature Control" on page 136.
Mode: This option selects T1, E1, or disabled mode. For T1 mode, the clock output will
be 1.544 MHz, and for E1 the clock output will be 2.048 MHz.
SSM Enabled: Enables or disables Sync Status Messaging (SSM). T1 SSM is not valid
with D4/Superframe or AIS framing. E1 SSM is not valid with AIS framing.
E1 Encode: HDB3 only.
E1 Framing: This option selects the framing standard (CRC-4, No CRC-4, or AIS).
T1 Framing: This option selects the framing standard (D4/Superframe, Extended Super
frame [CRC-6/no CR C-6], or AIS).
T1 Encoding: This option selects the encoding method (B8ZS or AMI).
T1SSM Value: This option selects the SSM quality level transmitted when SSM is
enabled.
E1 SSM Value: This option selects the SSM quality level transmitted when SSM is
enabled.
NetClock User Reference Guide
343
APPENDIX
5.2.5.3
E1/T1 Output: Status Window
To view the configuration settings of the E1 OUT or T1 OUT output, go to its Status window.
For instructions, see: "Viewing Input/Output Configuration Settings" on page 321.
The E1/T1 Output 0 Status Screen will vary according to whether the output signal mode is E1
or T1.
The Status windows display the following settings:
Signature Control: Controls when the output will be present; see "Signature Control" on
page 136.
Mode: This option selects T1, E1, or disabled mode. For T1 mode, the clock output will
be 1.544 MHz, and for E1 the clock output will be 2.048 MHz.
SSM Enabled: Enables or disables Sync Status Messaging (SSM). T1 SSM is not valid
with D4/Superframe or AIS framing. E1 SSM is not valid with AIS framing.
E1 Encoding: HDB3 only.
E1 Framing: This option selects the framing standard (CRC-4, No CRC-4, or AIS).
T1 Framing: This option selects the framing standard (D4/Superframe, Extended Super
frame [CRC-6/no CR C-6], or AIS).
T1 Encoding: This option selects the encoding method (B8ZS or AMI).
T1 SSM Value: This option selects the SSM quality level transmitted when SSM is
enabled.
E1 SSM Value: This option selects the SSM quality level transmitted when SSM is
enabled.
344
NetClock User Reference Guide
APPENDIX
5.2.6
NetClock 9489 Outputs
Figure 5-7: Rear panel NetClock Model 9489
5.2.6.1
1PPS Output
The NetClock 9489 1PPS Output is identical to the NetClock 9483. See "1PPS Output" on
page 21.
5.2.6.2
ASCII RS-485 Outputs
NetClock 9489 provides two (2) ASCII RS-485 Outputs.
Table 5-10: ASCII RS-485 pin assignment
Pin
5.2.7
Signal
1
RS-485 TX+
2
RS-485 TX-
3
GND
4
RS-485 TX+
5
RS-485 TX-
6
GND
Function
ASCII Output 1
ASCII Output 2
PTP Grandmaster [1204-32]
Precision Time Protocol (PTP) is a protocol that can be used to synchronize computers on an Eth
ernet network. The Precision Time Protocol (PTP) option module supports PTP Version 2, as spe
cified in the IEEE 1588-2008 standard (PTP Version 1 is not supported), via one (1) Ethernet
port.
NetClock User Reference Guide
345
APPENDIX
The PTP option module implements a PTP Ordinary Clock that can be configured to run as a
Master Clock only. It transmits PTP packets via the Ethernet port, with information about the cur
rent time and synchronization reference selected by the NetClock device.
5.2.7.1
PTP Grandmaster [-32]: Specifications
Inputs/Outputs : (1) Configurable as Input or Output
Signal Type and Connector : Ethernet via SFP, and 1PPS Output via BNC
Management: Web UI
Resolution: 8ns (±4ns) packet time stamping resolution
Accuracy: 30 ns accuracy (3σ) Master to Slave, via crossover cable
Network Speeds : 100 Mb/s, or 1Gb/s, depending on SFP module used
PTP Version supported: PTP 2 (IEEE 1588-2008)
PTP Profiles supported: Default, Telecom, Enterprise
Transmission modes : Unicast [default], Multicast
Maximum Number of Cards : 6
Ordering Information: 1204-32: PTP/Precision Timing Protocol Option Module
Figure 5-8: Model 1204-32 option card rear plate
5.2.7.2
PTP Grandmaster [-32]: Edit Window
1. To configure this option card, go to its Edit window. For instructions, see "Configuring
Option Module Inputs/Outputs" on page 322.
346
NetClock User Reference Guide
APPENDIX
Note: If you have only one input or output of any type, NetClock will num
ber that input or output 0. Additional inputs or outputs will be numbered 1
or above.
2. The Gb PTP Edit window will display. It includes the top panel, and offers access to three
different tabs , described below:
NetClock User Reference Guide
347
APPENDIX
Top panel settings
Enable PTP: Enables/Disables PTP. Check the box to enable PTP. Uncheck it to disable
PTP.
Profile: offers a choice of:
Default (incl. Enterprise)
Telecom
Bottom panel: tabs
Main: These settings pertain to network connectivity.
Contract: These settings pertain to the unicast contract.
Advanced: These setting pertain to time Sync information.
Main tab settings
Domain Number : Sets the current PTP Domain Number, as defined in IEEE Std 15882008 Section 7.1
Clock Mode: PTP has two ways to transmit the initial T1 timestamp of the Sync packet
transmission from the Master to the Slave:
One-Step Master: The Sync packet is timestamped, then the timestamp is inserted
into the Sync packet in real-time, as it is transmitted.
348
NetClock User Reference Guide
APPENDIX
Two-Step Master : The Sync packet is timestamped, but the timestamp value in the
Sync packet is ignored. The actual T1 value is transmitted in a "Follow-Up" packet
after the Sync packet.
Note: PTP Masters must select one mode or the other to operate in.
The default mode is one-step.
Enable DHCP: This is a checkbox to enable or disable the delivery of IP addresses from
a DHCP Server. The default setting is enabled (the box is checked).
Static IP Address : When a DHCP server is not requested or is requested but not avail
able, the PTP Module will use this IP address. In the format “#.#.#.#” with no leading zer
oes or spaces, where each ‘#’ is a decimal integer from the range [0,255].
Network Mask : When a DHCP server is not requested or is requested but not available,
the PTP Module will use this Network Mask. In the format “#.#.#.#” with no leading zer
oes or spaces, where each ‘#’ is a decimal integer from the range [0,255].
Default Gateway: When a DHCP server is not requested or is requested but not avail
able, the PTP Module will use this Default Gateway. In the format “#.#.#.#” with no lead
ing zeroes or spaces, where each ‘#’ is a decimal integer from the range [0,255].
Contract tab settings
Note: The settings under this tab only apply to Unicast mode.
[Default settings in parenthesis]
Min Sync Interval: The minimum value of Sync interval granted by the Master Clock. In
packets per second. [128 Per Second]
Max Sync Duration: The maximum value of Sync interval granted by the Master Clock.
In seconds. [10000]
Min Announce Interval: The minimum value of the Announce interval granted by the
Master Clock. In packets per second. [128 Per Second
Max Announce Duration: The maximum value of the Announce interval granted by the
Master Clock. In seconds. [10000]
Min Delay_Req Interval: In packets per second. [128 Per Second]
Max Delay_Req Duration: In seconds. [10000]
Max Slaves : The maximum number of slaves the card will serve. [4000]
NetClock User Reference Guide
349
APPENDIX
Advanced tab settings
A bo ut… PT P
T r ans m i s s i o n
Mo des
The PTP Card is able to transmit the PTP packets in three transmission modes:
• Multicast Mode: This is the default mode. PTP packets are transmitted to all PTP Clocks by means
of Multicast IP addresses dedicated to the PTP protocol (224.0.1.129, 224.0.0.107). PTP packets
received by the PTP Clocks are then filtered from the Domain Number, the Port Identity (Clock Identity
+ Port Number) of the transmitter, the packet identifier (Sequenced). When the Master Clock is set in
Multicast mode, this module will deny the requests from the Slaves Clocks to run in Unicast mode.
When the Master Clock is set in Unicast mode, it doesn’t transmit any PTP messages until a Slave has
been granted to run in Unicast mode.
• Unicast Mode : This is a Point-to-Point transmission mode between two PTP Clocks by means of
the unique IP address assigned to each PTP Clock.
--------------------------------------------N O T E: The Unicast mode is only implemented for the following PTP packets:
Announce, Sync and Follow-Up, Delay_Req and Delay_Resp.
The Unicast mode is activated at the initiative of the Slaves. Each Slave, which wants to run in Unicast
mode, shall first negotiate Unicast contracts with the Master.
_______________
• Minicast/Hybrid Mode : The Minicast/Hybrid mode is a method to minimize the PTP packets
payload on the network, where: The transmissions initiated by the Master (Announce, Sync/FollowUp) run in Multicast mode.
The transmissions initiated by the Slaves (Delay_Req/Delay_Resp) run in Unicast mode.
Multicast Sync : Activating this option will cause the PTP Master to broadcast Sync and
Announce messages to the Multicast address (as long as it is the Best Master on the net
work). Deactivating this option will remove the messages. When the PTP module is set in
multicast mode, this will deny the requests from the Slaves Clocks to running in unicast
mode.
Checking this box will cause two additional fields to display that will allow you to
configure the:
Multicast Sync Rate
Multicast Announce Rate
350
NetClock User Reference Guide
APPENDIX
Multicast Delay_Req: Activating this option will cause the PTP Master to respond to mul
ticast Delay Requests (as long as it is the Best Master on the network). Deactivating this
option will prevent the Master from responding to these.
Unicast Sync : The PTP Master will always respond to attempts from Unicast slaves to com
municate with it, provided the Slaves use the proper Unicast Auto-Negotiation process.
This setting is always enabled.
Unicast Delay_Req: The PTP Master will always respond to attempts from Unicast slaves
to communicate with it, provided the Slaves use the proper Unicast Auto-Negotiation pro
cess. This setting is always enabled.
Transport Protocol: Selects the transport protocol used for PTP packets.
Clock Class Set: Parameter broadcast in a PTP profile, indicating the quality of the
attached reference; PTP [default], ARB, ITU [Telecom1] See also "ESMC Signal Control"
below.
Time To Live (Packet Lifespan): Sets the TTL field for PTP packets except for Peer-to-Peer
packets for which TTL is forced to 1 as specified in IEEE Std 1588-2008 Annex D.3.
1PPS Offset: The 1PPS signal of this option card can be offset from the main System
1PPS. This offset will be applied to all timestamps created by this card. It can be set in
8ns increments. Range is -500 ms to +500 ms.
Priority 1: See IEEE 1588-2008, Section 8.10.1, 8.10.2.
Priority 2: See IEEE 1588-2008, Section 8.10.1, 8.10.2.
Enable SyncE: If checked, allows access to the synchronous Ethernet settings. There will
always be an ESMC message broadcast if Enable SyncE is checked.
Enable ESMC : [checkbox]
ESMC Signal Control: Determines which SSM to use in the ESMC mes
sage. One of two messages will be broadcast: either the message selected
in the SSM Code dropdown or the QL_DNU code. The user may set one
of the following broadcasting options:
Output Always Enabled: Always broadcasts the selected SSM code,
even when NetClock is not synchronized to its references.
1The Telecom profile uses different clock class values than the default profile. It uses clock classes in the range from 80 to
110, and these values map to the SSM Quality level that is broadcast in the ESMC message, as defined in Section
6.7.3.1 of G8625.1. If the user enables Sync-E, and broadcasting of the ESMC message, the parameter that controls
which SSM quality level is broadcast when the unit is in sync is user-accessible. This will appear both in the ESMC mes
sage, and in the Clock Class (if the “Clock Class Set” is set to ITU). It is also possible to control whether the ESMC mes
sage chosen degrades to QL-DNU when out of sync.
NetClock User Reference Guide
351
APPENDIX
Output Enabled in Holdover : The output uses the selected SSM code
unless NetClock is not synchronized to its references (the output is
present while in the Holdover mode). While NetClock is not syn
chronized, QL-DNU SSM code will be broadcast.
Output Disabled in Holdover : The output uses the selected SSM
code unless the NetClock references are considered not qualified
and invalid (the output is not present while in the Holdover mode).
While references are invalid, QL-DNU SSM code will be broadcast.
Output Always Disabled: The output is not present, even if any
NetClock references are present and considered qualified. QL-DNU
SSM code is broadcast.
SSM Code: The Sync Status Messaging (SSM) code to be utilized. Choice
of code is made through the drop-down list.
Note: Some parameters define a PTP packets through
put. They use the “log2 seconds“, defined as follows.
Positive Value: n => 2n seconds between two successive PTP packets
Negative Value: -n => 2(-n) = (1/2n) => 2n PTP packets per second
5.2.7.3
PTP Grandmaster [-32]: Status Window
To view the status of a PTP interface, go to its Status window. For instructions, see "Viewing
Input/Output Configuration Settings" on page 321.
The GB PTP Status window contains two tabs: Main and Advanced.
352
NetClock User Reference Guide
APPENDIX
Main tab: Status information
Ethernet Status : Whether the module is connected to a network through Ethernet.
Green=Connected. The speed of the connection is indicated.
Orange=Not connected.
Port State: Reports the current state of the PTP State Machine:
Disabled: PTP Ethernet port is Disabled. See PTP Setup/Network page, PTP Net
work Settings options.
Initializing: Ethernet link is unplugged/PTP Module is in power-up state. A Master
Clock doesn’t leave this state while it can’t get the current time and syn
chronization references from the NetClock to synchronize with it.
Listening: PTP module is looking for a Master Clock.
Master : PTP Master has become the active Master Clock on the network.
Passive: PTP Module has become a Passive Master Clock. (There is another
Master Clock on the network with better quality or higher priority). This Master
will wait until the Best Master Clock Algorithm determines it should become the
best Master Clock, and then it will transition to the Master Clock state.
Uncalibrated: PTP Slave has selected a Master Clock on the network attempts to
synchronize with it using sync packets.
Number of Unicast Slaves : Number of PTP Slaves that have been granted by the PTP
Master to run in unicast mode (maximum = 4000 unicast contracts)
Profile: Whether the profile is the default or Telecom.
Domain Number : The current PTP Domain Number.
Clock Mode: See "Main tab settings" on page 348.
Current IP Address : The IP address currently being used by the PTP interface.
MAC Address : The MAC address currently being used by the PTP interface.
Advanced tab: Status information
Time Properties:
UTC Offset: The Master’s current offset between UTC time and TAI time. Units: seconds.
UTC Offset Valid: Indicates whether or not the Master’s UTC Offset is valid.
Leap Second: The Leap second correction as set on the Time Management page.
NetClock User Reference Guide
353
APPENDIX
Time Traceable: Indicates whether the Master’s time is traceable (Enabled) to a primary
reference or not (Disabled).
Frequency Traceable: Indicates whether the Master’s Frequency is traceable (Enabled) to
a primary reference or not (Disabled).
PTP Time Scale: Indicates the timescale that the Master is using to broadcast its time. TAI
is the default PTP timescale.
Time source: The Time Source that the Master is using. Refer to IEEE Standard 15882008, Section 7.6.2.6.
Clock Quality:
Clock Accuracy: A number describing the accuracy of the oscillator in the Master rel
ative to its UTC reference (see IEEE Standard 1588-2008, Section 7.6.2.5).
Offset Scaled Variance: A constant value based on the variance of the oscillator
installed in the NetClock unit.
Clock Class : A number describing the state of the time and 1pps references of the PTP
Clock.
See table below for Clock Class definitions (see also: IEEE Standard 1588-2008, Sec
tion 7.6.2.4, Table 5).
Table 5-11: Clock class definitions
PTP Arbitrary
Time
Time
Scale
Scale
Clock Class Definition
6
13
Time and 1pps references are synchronized with the host references and PTP clock shall
not be a slave to another clock in the domain.
7
14
Time and 1pps references are in holdover state, within specifications and PTP clock shall
not be a slave to another clock in the domain.
52
58
Time and 1pps references are in holdover state, not within specifications, and PTP clock
shall not be a slave to another clock in the domain. Then, applied to Master Clocks who
have just powered on and have not yet achieved a suitable TFOM value.
187
193
Time and 1pps references are in holdover state, not within specifications, and PTP clock
may be a slave to another clock in the domain.
255
255
Class assigned to “Slave-Only” clocks.
248
248
“Unknown” class.
Ethernet Status
Current IP Address : The IP address currently being used by the PTP interface.
354
NetClock User Reference Guide
APPENDIX
Note: If the PTP Module is set up for DHCP but fails to obtain an IP address, it will
use the Static IP instead. To reacquire a DHCP address, reset the module via the
Main tab in the PTP settings window.
Current Network Mask : The Network Mask currently being used by the PTP interface.
Current Gateway: The Gateway address currently being used by the PTP interface.
Port Status
Port State: Reports the current state of the PTP State Machine:
Disabled: PTP Ethernet port is Disabled. See PTP Setup/Network page, PTP Net
work Settings options.
Initializing: Ethernet link is unplugged/PTP Module is in power-up state. A Master
Clock doesn’t leave this state while it can’t get the current time and syn
chronization references from NetClock to synchronize with it.
Listening: PTP module is looking for a Master Clock.
Master : PTP Master has become the active Master Clock on the network.
Passive: PTP Module has become a Passive Master Clock. (There is another
Master Clock on the network with better quality or higher priority). This Master
will wait until the Best Master Clock Algorithm determines it should become the
best Master Clock, and then it will transition to the Master Clock state.
Uncalibrated: PTP Slave has selected a Master Clock on the network attempts to
synchronize with it using sync packets.
One Step Mode: Determines the number of steps in the PTP protocol. Will be one
of the following:
Disabled: Two-Step Mode is enabled
Enabled: One-Step Mode is enabled
[Default=Disabled]
Note: One-Step Mode is not supported with the Peer-to-Peer Delay
Mechanism.
The current implementation of one- step mode involves a software oriented
timestamping. The two-step mode imlements a hardware oriented timestamping,
NetClock User Reference Guide
355
APPENDIX
insensitive to software execution time variations. The Two- step mode is recom
mended, as it increases the PTP Clock's accuracy
Delay Mechanism : Will be one of the following:
E2E: End-to-End Delay Mechanism
P2P: Peer-to-Peer Mechanism
Disabled: No Delay Mechanism
Default setting: E2E
Note: Peer-to-Peer Delay Mechanism is only applicable on
networks equipped with Transparent Clocks (switches/routers
IEEE 1588 compatible). Peer-to-Peer Delay Mechanism is not
supported in Unicast transmission mode.
PPS Offset: See "Advanced tab settings" on page 350.
Module Information
Software Version: Version number of embedded software
Hardware Version: Version number
5.2.7.4
Configuration — General Steps
Ensure that NetClock's PTP port is connected to the network (check the Link Status in the
PTP Status/Network page).
Ensure the PTP port speed is 100 Mb/s (see: PTP Status page > Advanced tab > Port
Speed).
Be sure that valid time and 1PPS references are currently selected (go to
MANAGEMENT/OTHER/Time Management).
In order to operate properly as a Master Clock, NetClock must be synchronized to a non-PTP
reference. Confirm that the chosen reference transmits the following information (as reported
by the Time Properties on the PTP Status page, under the Advanced tab):
The proper TAI or UTC time (including the current year)
The current TAI to UTC offset (required even if the reference’s time is in TAI)
Pending leap second information at least a day in advance.
356
NetClock User Reference Guide
APPENDIX
If the reference does not transmit this information, it must be provided by the user in order for
the Master Clock to function properly.
The built-in GNSS reference provides all information needed with no user intervention.
5.2.7.5
Configuration — PTP-Specific Steps
Confirm that:
The PTP Port Activity is enabled (check the Port Status on the PTP Status page under the
Advanced tab). If not, enable it from the Port Activity of the PTP Setup/Network page).
The clock is set to be a Master-Only clock (check the Clock Mode on the PTP Setup/C
lock page).
A valid IP address is currently being used (check the Ethernet Settings on the PTP
Setup/Network page).
When the PTP Module is set to be a Master Clock, the module will immediately attempt to
become the active Master Clock on the network (PTP Port State = Master ). If it does, it will start
to transmit PTP packets (even if NetClock is not yet synchronized).
There are several reasons why the PTP Module may not become the active Master Clock, or
may not be broadcasting the correct time, even if it is set to be a Master Clock:
a. If using any reference other than self for 1PPS, NetClock will not become an active
Master Clock until the Time Figure of Merit (TFOM) value of the system is less than 15.
After first going into sync after power-up, it may take a minute or two for the Time Figure
of Merit (TFOM) value to fall to an acceptable level. The current Time Figure of Merit
(TFOM) value is available in the Time Properties panel under the Advanced tab on the
Status page.
b. PTP uses the TAI timescale to transfer time. Many timing references communicate time in
the UTC timescale. UTC is offset from TAI by a small amount which changes every time a
leap second occurs. The TAI to UTC Offset is part of the PTP Specification and must be
provided to a Master Clock. If no active reference can provide that information, the off
set must be provided by the Host. The TAI to UTC Offset can be set from the
MANAGEMENT/OTHER/Time Management page (while setting the GPS to UTC Off
set).
c. The PTP Protocol also provides for the transfer of Leap Second information. If the active
time reference does not provide Leap Second information, it must be added by the user
through the MANAGEMENT/OTHER/Time Management page. If this is not done, the
PTP network will have the incorrect UTC time after a leap second event.
d. If there are multiple multicast Master Clocks on the network, the PTP Module uses the Best
Master Clock (BMC) algorithm specified in the PTP Specification to decide whether or
NetClock User Reference Guide
357
APPENDIX
not to become the active Master Clock. The BMC algorithm selects the Best Master Clock
on the network from the following criteria:
i. The BMC algorithm first selects the clock having the higher Priority1 parameter (a
lowest value means a higher priority)
ii. If the BMC cannot be determined from the previous parameter, the BMC
algorithm selects the clock having the higher Clock Quality (Clock Class, Clock
Accuracy, Clock Variance)
iii. If the BMC cannot be determined from the previous parameters, the BMC
algorithm selects the clock having the higher Priority2 parameter
The Master Clock selected by the BMC algorithm as the Best Master Clock will transition into the
Master state to become the active Master Clock on the network. It will then start to transmit Sync
packets to the Slave Clocks. The other Master Clocks will transition into the Passive state.
Enabling PTP
To enable PTP:
1. Navigate to the Top panel of the GB PTP Edit window.
2. Check the Enable PTP box.
Configuring Multicast Mode
To enter Multicast mode, perform the following steps:
1. In the GB PTP Edit window, navigate to the Advanced tab.
2. Select the Multicast Sync checkbox.
3. Select the Multicast Sync Rate from the drop-down list.
358
NetClock User Reference Guide
APPENDIX
4. Select the Multicast Announce Rate from the drop-down list.
Configuring Unicast Mode
To enter the Unicast mode, perform the following steps:
1. In the GB PTP Edit window, navigate to the Advanced tab.
2. Confirm that Unicast Sync is checked. The 1204-32 PTP module should always respond
to unicast negotiations.
Configuring Minicast/Hybrid Mode
To enter the Minicast/Hybrid mode, perform the following steps:
1. In the GB PTP Edit window, navigate to the Advanced tab.
2. Select the Multicast Sync checkbox.
3. Select the Multicast Sync Rate from the drop-down list.
4. Select the Multicast Announce Rate from the drop-down list.
5. Confirm that the Unicast Sync checkbox is checked. The 1204-32 PTP module should
NetClock User Reference Guide
359
APPENDIX
always respond to unicast negotiations.
Configuring PTP on the Network
To configure PTP on the network:
1. In the GB PTP Edit window, navigate to the Main tab.
2. Under the Main tab of the GB PTP Edit window, make the following settings:
Domain Number : Sets the current PTP Domain Number, as defined in IEEE Std
1588-2008 Section 7.1
Clock Mode: See under "Main tab settings" on page 348.
Enable DHCP: This is a checkbox to enable or disable the delivery of IP
addresses from a DHCP Server. The default setting is enabled (the box is
checked).
Static IP Address : When a DHCP server is not requested or is requested but not
available, the PTP Module will use this IP address. In the format “#.#.#.#” with no
leading zeroes or spaces, where each ‘#’ is a decimal integer from the range
[0,255].
Network Mask : When a DHCP server is not requested or is requested but not
available, the PTP Module will use this Network Mask. In the format “#.#.#.#”
with no leading zeroes or spaces, where each ‘#’ is a decimal integer from the
range [0,255].
Default Gateway: When a DHCP server is not requested or is requested but not
available, the PTP Module will use this Default Gateway. In the format “#.#.#.#”
with no leading zeroes or spaces, where each ‘#’ is a decimal integer from the
range [0,255].
360
NetClock User Reference Guide
APPENDIX
Configuring PTP Contracts
1. Navigate to the Contract tab of the GB PTP Edit window.
2. Under the Contract tab of the GB PTP Edit window, make the following settings:
Min Sync Interval: The minimum value of Sync interval granted by the Master
Clock. In packets per second.
Max Sync Duration: The maximum value of Sync interval granted by the Master
Clock. In seconds.
Min Announce Interval: The minimum value of the Announce interval granted by
the Master Clock. In packets per second.
Max Announce Duration: The maximum value of the Announce interval granted
by the Master Clock. In seconds.
Min Delay_Req Interval: In packets per second.
Max Delay_Req Duration: In seconds.
Max Slaves : The maximum number of slaves to be served. The 1204-32 module
can serve up to 4000 slaves (unicast contracts).
5.3
Command-Line Interface
A terminal emulation program is used to emulate a video terminal, so as to access NetClock's
CLI (Command-Line Interface) remotely via a serial cable. This may be required, if no other
NetClock User Reference Guide
361
APPENDIX
means of remotely accessing NetClock are available, for example if Ethernet ports are used oth
erwise or have been disabled (for security reasons, or similar).
The following topics are included in this Chapter:
362
NetClock User Reference Guide
APPENDIX
5.3.1
Setting up a Terminal Emulator
If no other means are available to access NetClock, a terminal emulation program can be used
to carry out certain configuration changes by accessing NetClock's CLI (command-line inter
face) via a serial port connection. An application example for this scenario is to enable a net
work port so that the NetClock Web UI can be used. While it is also possible to retrieve
selected logs, a terminal emulator does not replace the NetClock Web UI.
Spectracom does not distribute or support its own terminal emulator, and newer Microsoft oper
ating systems no longer include HyperTerminal. However, there are several third-party opensource programs available, such as TeraTerm ® or PuTTY ® . The example below illustrates the
use of TeraTerm. The setup procedure is similar when using other terminal emulation programs.
Required tools and parts:
I. A standard, one-to-one pinned RS-232 serial cable; this cable has one male and one
female DB-9 connector. Do NOT use a Null Modem cable. If you do not have a stand
ard RS-232 cable at hand, follow the pin-out configuration described below when build
ing a cable. It is required to wire at least pins number 2, 3, and 5.
Figure 5-9: Serial port pin-out
II. Personal Computer with terminal emulator program installed.
Procedure:
1. Connect the personal computer to the front panel serial connectorUSB interface, using
the serial cable.
2. Configure your terminal emulation program, using the following settings:
Port: COM1
Bits per second: 9600
NetClock User Reference Guide
363
APPENDIX
Data bits : 8
Parity: None
Stop bits : 1
Flow control: None
3. Depending on which network protocol you are using (SSH, Telnet), you will need to
enter authentication upon establishment of the connection either in a separate authen
tication window, or the Terminal window: The default user name is spadmin, and the
password admin123.
4. Using the Terminal window, you can now submit commands; see "CLI Commands"
below for a list of commands.
5.3.2
CLI Commands
NetClock features a suite of command-line interface (CLI) commands that can be used to con
figure parameters and retrieve status information or log files via a remote connection, using the
telnet or ssh (if enabled) protocol.
This section includes a list of some of the supported commands.
Notes:
a. The command “helpcli” will provide a list of all available commands and their syn
tax (Note: Typing “help” will output bash shell help only and will not provide useful
information).
b. You can scroll up or scroll down through the output by using the Page Up/Page down
keys, or the arrow keys.
364
NetClock User Reference Guide
APPENDIX
c. Type “q” (lower-case) to quit.
d. Pressing the up/down keys scrolls through previously typed commands.
e. Commands need to be typed in all lower-case letters.
f. Where eth0 is the base network port and eth1 (and higher) are used with the
optional Gigabit Ethernet module for multiple network interfaces.
g. User accounts with “user” group permissions can perform “get” commands but cannot
perform any “set” commands or change/reset passwords. Only user accounts with
“admin” group permissions can perform “set” commands or change/reset password.
Refer to "Adding/Deleting/Changing User Accounts" on page 216 for user account
setup information.
Command
Description
clean
Restores NetClock configuration to factory defaults and reboots
cleanhalt
Restores NetClock configuration to factory defaults and halts
clearlogs
Clears all logs
clearstats
Clears all statistical data (NTP, and oscillator/disciplining)
dateget
Displays current date (for example, 15 APR 2015)
dateset
Used to set the current date
defcert
Used to create a new Spectracom self-signed SSL certificate for HTTPS in case of expir
ation of the original certificate
dhcp4get
Displays whether DHCP is enabled
dhcp4set
Used to enable or disable DHCP
dns4get
Displays the configured DNS servers
dns4set
Used to configure the DNS servers
dhcp6get
Displays whether DHCPv6 is enabled
dhcp6set
Used to enable or disable DHCPv6
doyget
Used to obtain the current Day of Year
doyset
Used to set the current Day of Year
gpsdop
Displays GNSS receiver positional accuracy estimates
gpsinfo
Applicable to SAASM-equipped NetClock units only
gpsloc
Displays GNSS latitude, longitude and antenna height
NetClock User Reference Guide
365
APPENDIX
Command
366
Description
gpsmdl
Displays the GNSS Manufacturer and Model
gpssat
Displays GNSS satellites tracked and maximum signal strength being received
gw4get
Displays IPv4 gateway addresses
gw4set
Used to configure the IPv4 gateway addresses
gw6get
Displays IPv6 gateway address
gw6set
Used to configure the IPv6 gateway address
halt
Used to Halt the system for shutdown
helpcli
Provides list of available commands and syntax
hostget
Displays the DNS hostname
hostset
Sets the DNS hostname
hotstart
Initiate a hot start operation on the SAASM GPS receiver
ip4get
Displays IPv4 Ethernet port information (IP address net mask and gateway)
ip4set
Used to set IPv4 Ethernet port information (IP address net mask and gateway)
ip6add
Used to add IPv6 Ethernet port information (IP address net mask and gateway)
ip6del
Used to delete IPv6 IP address
ip6get
Used to obtain the IPv6 IP address
iptables
See "Network Services" on page 59 for more information.
licenses
Displays configured licenses installed (if any)
list
Outputs a list of commands
loadconf
Restore a saved configuration and reboot
localget
Used to obtain the configured local clock
locallist
Used to display local clocks
localset
Used to configure local clocks
model
Displays the Serial Number of the unit
net
Displays network settings
netnum
Displays the number of general-purpose network interfaces
net4
Displays IPv4 network settings
net6
Displays IPv6 network settings
NetClock User Reference Guide
APPENDIX
Command
Description
options
Displays configured options installed (if any)
oscget
Displays the installed system oscillator
portget
Display whether network port is enabled (for example, "portget ETH2")
portset
Enable or disable a network port:
"portset x on" where "x" is the port number (for example, "ETH2")
"portset X off"
[NOTE: Available since Web UI Revision no. 5.1.2]
portstate
Display the current state for a network port
ppsctrl
Enable/disable individual 1PPS output signals
priorset
Sets the priority of an entry in the reference priority table
radius setretry
<value> Sets how many radius login retries will be attempted
radius getretry
<value> Gets the number of radius login retry attempts
radius server list
Lists radius servers
radius server
add
<host> <port> <key> <timeout>
Adds radius server
radius server del
<id> Deletes radius server number <id>
reboot
Used to warm-boot the unit without having to disconnect or reconnect power
reftable
Displays reference priority table
release4
Used with DHCP to release the IPv4 address
release6
Used with DHCPv6 to release the IPv6 address
renew4
Used with DHCP to renew the assigned IPv4 address
renew6
Used with DHCPv6 to renew the assigned IPv6 address
resetpw
Resets the administrator account (spadmin) password back to the default value
“admin123”
routes4
Displays the current IPv4 routing table(s)
routes6
Displays the current IPv6 routing table(s)
rt4add
Adds an IPv4 static route
rt4del
Deletes an IPv4 static route
rt4get
Displays the configured IPv4 static routes
rt6add
Adds an IPv6 static route
NetClock User Reference Guide
367
APPENDIX
Command
368
Description
rt6del
Deletes an IPv6 static route
rt6get
Displays the configured IPv6 static routes
saveconf
Generate archive of current configuration
savelog
Generate archive of all log files
scaleget
Displays configured system timescale
scaleset
Used to configure the system timescale
services
Displays the state of services (enabled/disabled)
servget
Displays the state of individual services
servset
Enable or disable specific services
slaacget
Displays whether SLAAC is enabled
slaacset
Used to enable or disable SLAAC
stateset
Enable or disable an entry in the reference priority table. index = 0...15. state = 0 (dis
able), 1 (enable)
status
Displays information about the oscillator disciplining
syncstate
Display timing system synchronization state
sysupgrade
Performs system upgrade using the update bundle provided
testevent
Generates SNMP events in the enterprise MIB
tfomget
Displays current estimated system time error (TFOM – Time Figure of Merit)
timeget
Displays current system time (time is displayed in the configured timescale – See
scaleget command to retrieve the configured timescale)
timeset
Used to manually set the current time (hours, minutes in seconds); time is entered based
on the configured timescale – See scaleget command to retrieve the configured
timescale
unrestrict
Used for clearing access control restrictions to NetClock
version
Displays the installed main NetClock and timing system software versions
yearget
Displays the current year
yearset
Used to set the current year
zeroize
Applicable to SAASM-equipped NetClock units only
NetClock User Reference Guide
APPENDIX
5.4
ASCII Time Code Data Formats
This section describes the different time code data format selections available for use with NetC
lock option cards that accept ASCII data streams as inputs or outputs via their RS-485 and RS232 interfaces.
Supported are formats like NMEA, BBC, Spectracom, GSSIP, and Endrun.
5.4.1
NMEA GGA Message
The GGA Format provides essential fix data which includes 3D location and accuracy data.
Ex am ple
m es s age:
$GPGGA,123519.00,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47
NOTE: The GGA format does not support precision timing and 1PPS functionality; the Web UI
may permit the selection of Message or PPS Pin as PPS Source, but the NMEA GGA Message
will not use either. If this data is required for your application, use the ZDA Message format
instead (see "NMEA ZDA Message" on the next page).
Where:
GGA
Global Positioning System Fix Data
123519.00
Fix taken at 12:35:19 UTC
4807.038,N
Latitude 48 deg 07.038' N
01131.000, E
Longitude 11 deg 31.000' E
1
Fix quality:
0 = Invalid
1 = GNSS fix (SPS)
2 = DGPS fix
3 = PPS fix
4 = Real Time Kinematic
6 = estimated (dead reckoning) (2.3 feature)
7 = Manual input mode
8 = Simulation mode
08
Number of satellites being tracked
0.9
Horizontal dilution of position
545.4,M
Altitude, Meters, above mean sea level
46.9,M
Height of geoid (mean sea level) above WGS84 ellipsoid
NetClock User Reference Guide
369
APPENDIX
5.4.2
(empty field)
Time in seconds since last DGPS update
(empty field)
DGPS station ID number
*47
Checksum data, always begins with *
NMEA RMC Message
NMEA Message Format RMC, (Recommended Minimum) provides fix information, speed over
ground and Magnetic Variance information.
Ex am ple
m es s age:
$GPRMC,123519.00,A,4807.038,N,01131.000,E,022.4,084.4,230394,003.1,W*6A
Where:
5.4.3
RMC
Recommended Minimum Sentence C
123519.00
Fix taken at 12:35:19 UTC
A
Status A=active or V=Void.
4807.038,N
Latitude 48 deg 07.038' N
01131.000,E
Longitude 11 deg 31.000' E
022.4
Speed over the ground in knots
084.4
Track angle in degrees True
230394
Date - 23rd of March 1994
003.1,W
Magnetic Variation
*6A
Checksum data, always begins with *
NMEA ZDA Message
The Format ZDA Data message provides Date and Time information.
Ex am ple
m es s age:
$GPZDA,HHMMSS.00,DD,MM,YYYY,XX,YY*CC
Where:
370
NetClock User Reference Guide
APPENDIX
5.4.4
HHMMSS.00
HrMinSec(UTC)
DD,MM,YYYY
Day, Month, Year
XX
Local zone hours -13…13
YY
Local zone minutes 0…59
*CC
Checksum
Spectracom Format 0
Format 0 is the universal NENA format, along with formats 1, 2, and 3. Format 0 includes a
time synchronization status character, day of year, time reflecting Time Zone Offset and DST
corrections when enabled. Format 0 also includes the DST/Standard Time indicator, and the
Time Zone Offset value. Format 0 data structure is shown below:
Ex am ple
m es s age:
CR LF I ^ ^ DDD ^ HH:MM:SS ^ DTZ=XX CR LF
Where:
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
^
Space separator
DDD
Day of Year (001-366)
HH
Hours (00-23)
:
Colon separator
MM
Minutes (00-59)
SS
Seconds (00- 60)
D
Daylight Saving Time indicator (S,I,D,O)
TZ
Time Zone
XX
Time Zone offset (00-23)
The leading edge of the first character (CR) marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
NetClock User Reference Guide
371
APPENDIX
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
The Daylight Saving Time indicator (D) is defined as:
S
During periods of Standard time for the selected DST schedule.
I
During the 24-hour period preceding the change into DST.
D
During periods of Daylight Saving Time for the selected DST schedule.
O
During the 24-hour period preceding the change out of DST.
Ex am ple:
271 12:45:36 DTZ=08
The example data stream provides the following information:
5.4.5
Sync Status
Time synchronized to GNSS
Date
Day 271
Time
12:45:36 Pacific Daylight Time
D
DST, Time Zone 08 = Pacific Time
Spectracom Format 1
Format 1 converts the received day of year data (001-366) to a date consisting of day of
week, month, and day of the month. Format 1 also contains a time synchronization status char
acter, year, and time reflecting time zone offset and DST correction when enabled.
Available Formats 1 and 1S are very similar to each other. Most external systems utilizing Data
Format 1 will look for a single-digit day of the month for day 1 through day 9, with a space in
front of each digit ( ^1, ^2, ^3 … 10, 11… ), whereas other systems need to see a two digit
day of the month for all days 1 through 9 with a leading 0 instead of a space (01, 02, 03…
10, 11…).
If your device requires the two digit day of the month for days 1 through 9 (i.e. 01, 02
etc.), select Format 1.
If your device requires the single digit day of the month for days 1 through 9 (i.e. ^1,
^2, etc.), select Format 1S instead. Refer to "Spectracom Format 1S" on page 374 for
information on Format 1S.
372
NetClock User Reference Guide
APPENDIX
F o r m at
1
data
s tr uc tur e:
CR LF I ^ WWW ^ DDMMMYY ^ HH:MM:SS CR LF
Where:
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
^
Space separator
WWW
Day of Week (SUN, MON, TUE, WED, THU, FRI, SAT)
DD
Numerical Day of Month (01-31)
MMM
Month (JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC)
YY
Year without century (99, 00, 01, etc.)
HH
Hours (00-23)
:
Colon separator
MM
Minutes (00-59)
SS
Seconds (00-60)
The leading edge of the first character (CR) marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
Ex am ple:
FRI 20APR01 12:45:36
The example data stream provides the following information:
NetClock User Reference Guide
373
APPENDIX
5.4.6
Sync
Status
The clock is not time synchronized to GNSS. Time is derived from the battery backed clock or
set manually
Date
Friday, April 23, 2015
Time
12:45:36
Spectracom Format 1S
Format 1S (Space) is very similar to Format 1, with the exception of a space being the first char
acter of Days 1 through 9 of each month (instead of the leading “0” which is present in Format
1).
Most external systems utilizing Data Format 1 will look for a single digit day of the month for
day 1 through day 9, with a space in front of each digit (^1, ^2, ^3 … 10, 11…) whereas
other systems need to see a two digit day of the month for all days 1 through 9 with a leading
0 instead of a space (01, 02, 03… 10, 11…).
If your device requires the single digit day of the month for days 1 through 9 (i.e. 1, 2,
etc.), select Format 1S.
If your device requires the two digit day of the month for days 1 through 9 (i.e. 01, 02,
etc.), select Format 1 instead. Refer to "Spectracom Format 1" on page 372 for inform
ation on Format 1.
Ex am ple
m es s age:
CR LF I ^ WWW ^ DDMMMYY ^ HH:MM:SS CR LF
Where:
374
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
^
Space separator
WWW
Day of Week (SUN, MON, TUE, WED, THU, FRI, SAT)
DD
Numerical Day of Month (1-31)
MMM
Month (JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC)
YY
Year without century (99, 00, 01, etc.)
HH
Hours (00-23)
:
Colon separator
NetClock User Reference Guide
APPENDIX
MM
Minutes (00-59)
SS
Seconds (00-60)
The leading edge of the first character (CR) marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
Ex am ple:
FRI 20APR15 12:45:36
The example data stream provides the following information:
5.4.7
Sync
Status
The clock is not time synchronized to GNSS. Time is derived from the battery backed clock or
set manually.
Date
Friday April, 23, 2015
Time
12:45:36
Spectracom Format 2
This format provides a time data stream with millisecond resolution. The Format 2 data stream
consists of indicators for time synchronization status, time quality, leap second and Daylight
Saving Time. Time data reflects UTC time and is in the 24-hour format. Format 2 data structure
is shown below:
Note: Format 2 cannot be configured for a Time Zone Offset or with automatic
Daylight Saving Time adjustment. Attempting to configure a Local clock using
Data Format 2 with either a Time Zone Offset or automatic DST rule will result in
an error message.
Ex am ple
m es s age:
CR LF IQYY ^ DDD ^ HH:MM:SS.SSS ^ LD
Where:
NetClock User Reference Guide
375
APPENDIX
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
Q
Quality Indicator (space, A, B, C, D)
YY
Year without century (99, 00, 01, etc.)
^
Space separator
DDD
Day of Year (001-366)
HH
Hours (00-23 UTC time)
:
Colon separator
MM
Minutes (00-59)
:
Colon separator
SS
(00-60)
.
Decimal separator
SSS
Milliseconds (000-999)
L
Leap Second indicator (space, L)
D
Daylight Saving Time Indicator (S,I,D,O)
The leading edge of the first character (CR) marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
The quality indicator ( Q ) provides an inaccuracy estimate of the output data stream. When the
receiver is unable to track any GNSS satellites, a timer is started. "Quality indicators" on the
facing page lists the quality indicators and the corresponding error estimates based upon the
GNSS receiver 1PPS stability, and the time elapsed tracking no satellites. The Tracking Zero
Satellites timer and the quality indicator reset when the receiver reacquires a satellite.
376
Quality Time (hours) TXCO Error (milliseconds)
OCXO Error Rubidium Error
(milliseconds) (microseconds)
Space
<0.01
Lock
<1
<0.3
NetClock User Reference Guide
APPENDIX
Quality Time (hours) TXCO Error (milliseconds)
OCXO Error Rubidium Error
(milliseconds) (microseconds)
A
<10
<10
<0.72
<1.8
B
<100
<100
<7.2
<18
C
<500
<500
<36
<90
D
>500
>500
>36
>90
Table 5-12: Quality indicators
The leap second indicator (L) is defined as:
(Space) When a leap second correction is not scheduled for the end of the month.
L
When a leap second correction is scheduled for the end of the month.
The Daylight Saving Time indicator (D) is defined as:
S
During periods of Standard time for the selected DST schedule.
I
During the 24-hour period preceding the change into DST.
D
During periods of Daylight Saving Time for the selected DST schedule.
O During the 24-hour period preceding the change out of DST.
Ex am ple:
?A15 271 12:45:36.123 S
The example data stream provides the following information:
5.4.8
Sync
Status
The clock has lost GNSS time sync. The inaccuracy code of “A” indicates the expected time
error is <10 milliseconds.
Date
Day 271 of year 2015.
Time
12:45:36 UTC time, Standard time is in effect.
Spectracom Format 3
Format 3 provides a format identifier, time synchronization status character, year, month, day,
time with time zone and DST corrections, time difference from UTC, Standard time/DST indic
ator, leap second indicator and on-time marker. The Format 3 data structure is shown below:
NetClock User Reference Guide
377
APPENDIX
Ex am ple
m es s age:
FFFFI^YYYYMMDD^HHMMSS±HHMMD L # CR LF
Where:
FFFF
Format Identifier (0003)
I
Time Sync Status (Space, ?, *)
^
Space separator
YYYY
Year (1999, 2000, 2001, etc.)
MM
Month Number (01-12)
DD
Day of the Month (01-31)
HH
Hours (00-23)
MM
Minutes (00-59)
SS
Seconds (00-60)
±
Positive or Negative UTC offset (+,-) Time Difference from UTC
HHMM UTC Time Difference Hours Minutes (00:00-23:00)
D
Daylight Saving Time Indicator (S,I,D,O)
L
Leap Second Indicator (space, L)
#
On time point
CR
Carriage Return
LF
Line Feed
The time synchronization status character (I) is defined as described below:
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
The time difference from UTC, ±HHMM, is selected when the Serial Com or Remote port is con
figured. A time difference of -0500 represents Eastern Time. UTC is represented by +0000.
The Daylight Saving Time indicator (D) is defined as:
S
378
During periods of Standard time for the selected DST schedule.
NetClock User Reference Guide
APPENDIX
I
During the 24-hour period preceding the change into DST.
D
During periods of Daylight Saving Time for the selected DST schedule.
O During the 24-hour period preceding the change out of DST.
The leap second indicator (L) is defined as:
(Space) When a leap second correction is not scheduled for the end of the month.
L
When a leap second correction is scheduled for the end of the month.
Ex am ple:
0003 20150415 124536-0500D #
The example data stream provides the following information:
Data Format
3
Sync Status
Day 271 of year 2015.
Date
April 15, 2015.
Time
12:45:36 EDT (Eastern Daylight Time). The time difference is 5 hours behind UTC.
Leap Second No leap second is scheduled for this month.
5.4.9
Spectracom Format 4
Format 4 provides a format indicator, time synchronization status character, modified Julian
date, time reflecting UTC with 0.1 millisecond resolution and a leap second indicator. Format 4
data structure is shown below:
Ex am ple:
FFFFIMJDXX^HHMMSS.SSSS^L CR LF
Where:
FFFF
Format Identifier (0004)
I
Time Sync Status (Space, ?, *)
MJDXX
Modified Julian Date
NetClock User Reference Guide
379
APPENDIX
^
Space separator
HH
Hours (00-23 UTC time)
MM
Minutes (00-59)
SS.SSSS
Seconds (00.0000-60.0000)
L
Leap Second Indicator (space, L)
CR
Carriage Return
LF
Line Feed
The start bit of the first character marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
The leap second indicator (L) is defined as:
(Space)
When a leap second correction is not scheduled for the end of the month.
L
When a leap second correction is scheduled for the end of the month.
Ex am ple:
0004 50085 124536.1942 L
The example data stream provides the following information:
Data format
4
Sync Status
Time synchronized to GNSS.
Modified Julian Date
50085
Time
12:45:36.1942 UTC
Leap Second
A leap second is scheduled at the end of the month.
5.4.10 Spectracom Format 7
This format provides a time data stream with millisecond resolution. The Format 7 data stream
consists of indicators for time synchronization status, leap second and Daylight Saving Time.
380
NetClock User Reference Guide
APPENDIX
Time data reflects UTC time and is in the 24-hour format. Format 7 data structure is shown
below:
Note: Format 7 cannot be configured for a Time Zone Offset or with automatic
Daylight Saving Time adjustment. Attempting to configure a Local clock using
Data Format 7 with either a Time Zone Offset or automatic DST rule will result in
an error message.
Ex am ple
m es s age:
CR LF I^YY^DDD^HH:MM:SS.SSSL^D CR LF
Where:
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
YY
Year without century (99, 00, 01, etc.)
^
Space separator
DDD
Day of Year (001-366)
HH
Hours (00-23 UTC time)
:
Colon separator
MM
Minutes (00-59)
SS
Seconds (00-60)
.
Decimal Separator
SSS
Milliseconds (000-999)
L
Leap Second Indicator (space, L)
D
Daylight Saving Time Indicator (S,I,D,O)
The leading edge of the first character (CR) marks the on-time point of the data stream.
The time synchronization status character (I) is defined as described below:
NetClock User Reference Guide
381
APPENDIX
?
When the receiver is unable to track any satellites and the time synchronization lamp is red.
* When the receiver time is derived from the battery backed clock or set manually through the Setup Port
Interface.
The leap second indicator (L) is defined as:
(Space)
When a leap second correction is not scheduled for the end of the month.
L
When a leap second correction is scheduled for the end of the month.
The Daylight Saving Time indicator (D) is defined as:
S
During periods of Standard time for the selected DST schedule.
I
During the 24-hour period preceding the change into DST.
D
During periods of Daylight Saving Time for the selected DST schedule.
O
During the 24-hour period preceding the change out of DST.
Ex am ple:
? 15 271 12:45:36.123 S
The example data stream provides the following information:
Sync Status
Date
Time
The clock has lost GNSS time sync.
Day 271 of year 2015.
12:45:36 UTC time, Standard time is in effect.
5.4.11 Spectracom Format 8
Format 8 includes a time synchronization status character, the four digit year, day of year, time
reflecting Time Zone Offset and DST corrections when enabled. Format 8 also includes the
DST/Standard Time indicator, and the Time Zone Offset value. Format 8 data structure is
shown below:
Ex am ple:
CR LF I ^ ^YYYY^ DDD ^ HH:MM:SS ^ D+XX CR LF
or
CR LF I ^ ^YYYY^ DDD ^ HH:MM:SS ^ D-XX CR LF
Where:
382
NetClock User Reference Guide
APPENDIX
CR
Carriage Return
LF
Line Feed
I
Time Sync Status (space, ?, *)
YYYY
Four digit year indication
^
Space separator
DDD
Day of Year (001-366)
HH
Hours (00-23)
:
Colon separator
MM
Minutes (00-59)
SS
Seconds (00-60)
D
Daylight Saving Time indicator (S,I,D,O)
XX
Time Zone Switch Setting (±00…12)
The leading edge of the first character ( CR ) marks the on-time point of the data stream. Time
sync status character (I) is described below:
(Space)
When NetClock is synchronized to UTC source.
*
When NetClock time is set manually.
?
When NetClock has not achieved or has lost synchronization to UTC source.
The time and date can be set to either local time or UTC time, depending upon the con
figuration of the output port.
5.4.12 Spectracom Format 9
Format 9 provides Day-of-Year and Time information.
Ex am ple
m es s age:
<SOH>DDD:HH:MM:SSQ<CR><LF>
Where:
SOH Start of header (ASCII Character 1)
DDD
Day of Year (001-366)
NetClock User Reference Guide
383
APPENDIX
:
Colon Separator
HH
Hours (00-23)
MM
Minutes (00-59)
SS
Seconds (00-59) (00-60 for leap second)
Q
Time Sync Status [as INPUT]
space = SYNC
‘.’ = SYNC
‘*’=NOT IN SYNC
‘#’ = NOT IN SYNC
“?” = NOT IN SYNC
Q
Time Sync Status [as OUTPUT]
space = Time error is less than time quality flag 1's threshold (TFOM < or = 3)
“.” = Time error has exceeded time quality flag 1's threshold (TFOM = 4)
“*” = Time error has exceeded time quality flag 2's threshold (TFOM = 5)
“#” = Time error has exceeded time quality flag 3's threshold (TFOM = 6)
“?” = Time error has exceeded time quality flag 4's threshold OR a reference source is unavailable
(TFOM >=7)
CR
Carriage Return (ASCII Character 13)
LF
Line Feed (ASCII Character 10)
The leading edge of the first character (CR) marks the on-time point of the data stream.
5.4.12.1 Format 9S
Format 9S is a variation of ASCII Format 9 that uses Sysplex compatible fields indicating
sychronization status:
384
NetClock User Reference Guide
APPENDIX
FL_SYNC_SYS_REF_NONE ('X')
Never been in sync
FL_SYNC_SYS_REF_YES (' ')
In sync with a reference
FL_SYNC_SYS_REF_LOST ('F')
Out of sync, lost reference
5.4.13 Spectracom Epsilon Formats
5.4.13.1 Spectracom Epsilon TOD 1
This message corresponds to the TOD 1 format provided by EPSILON 2S/3S Series products
on RS232/422 ports.
The structure of this format is as follows:
<space>DD/MM/YYYY<space>HH:MM:SST(CR)(LF)
Length=23 bytes
Where:
NetClock User Reference Guide
385
APPENDIX
<space>
separator
DD
2-digit Day of month
</>
separator
MM
2-digit Month
</>
separator
YYYY
4-digit Year
<space>
separator
HH
2-digit Hour
:
separator
MM
2-digit Minutes
:
separator
SS
2-digit Seconds
T
1-digit Timescale ( 'N' None, 'G' GPS, 'U' UTC, 'A' TAI, 'L' Local, 'M' Manual)
(CR)
Carriage Return (ASCII Character 13 0x0D)
(LF)
Line Feed (ASCII Character 10 0x0A)
5.4.13.2 Spectracom Epsilon TOD 3
This message corresponds to the TOD 3 format provided by EPSILON 2S/3S Series products
on RS232/422 ports.
The structure of this format is as follows:
<space>DOY/YYYY<space>HH:MM:SS<space>T(CR)(LF)
Length=22 bytes
Where:
386
<space>
separator
DOY
3-digit Day of year
</>
separator
YYYY
4-digit Year
</>
separator
YYYY
4-digit Year
NetClock User Reference Guide
APPENDIX
<space>
separator
HH
2-digit Hour
:
separator
MM
2-digit Minutes
:
separator
SS
2-digit Seconds
T
1-digit Timescale ( 'N' None, 'G' GPS, 'U' UTC, 'A' TAI, 'L' Local, 'M' Manual)
(CR)
Carriage Return (ASCII Character 13 0x0D)
(LF)
Line Feed (ASCII Character 10 0x0A)
5.4.14 BBC Message Formats
5.4.14.1 Format BBC-01
This format is based on string ASCII characters, and is sent once per second. It provides year,
month, day, day of week, day of month, hours, minutes, and seconds.
Number of characters: 24 (including CRLF and '.')
Ex am ple
m es s age:
T:ye:mo:da:dw:ho:mi:sc
Where:
NetClock User Reference Guide
387
APPENDIX
T
Indicates the synchronous moment for the time setting.
ye
Year (00-99)
mo
Month (01-12)
da
Day of month (01-31)
dw
Day of week (01=Monday to 7=Sunday)
ho
Hours (00-23)
mi
Minutes (00-59)
sc
Seconds (00-59)
5.4.14.2 Format BBC-02
This is a hexadecimal frame/message sent twice per second. The message should be sent such
that the final “99” occurs at 0 msec and 500 msec.
Number of bytes: 26
Format:
START
AA
Year
Month Day Hour Min Sec.
AA 07 DA 06
Millisecond
02
80 00 00
GPS Second
13
59
01
LeapLeapLeap- second
Daylight second
second
Month
Sign
Zone
Time
Zone
BA
16
00
00
00
GPS
Week
1A 2A
GPS to UTC Offset Check-sum END
09 3A 7E 12
FE
99 99
Where:
Leap Second Sign:
01=Positive
FF=Negative
00=No leap second
388
NetClock User Reference Guide
APPENDIX
Leap Second Month:
00=None scheduled
03=March
06=June
09=September
0C=December
Leap Second Zone:
0=Out of zone
1=Within zone
Zone is 15 minutes before to 15 minutes after a leap second.
GPS Week:
Up to FFFF
GPS Second:
Second of week 000000 up to 093A7F (604799 decimal)
GPS to UTC offset:
2’s complement binary signed integer, seconds
Checksum:
Sum of all bytes up to and including the checksum (sum includes the AAAA start identifier
but excludes the 9999 end identifier)
5.4.14.3 Format BBC-03 PSTN
The third format is a string ASCII characters and is sent on a received character.
The message should be advanced by an appropriate number such that the stop bit of each
<CR > occurs at the start of the next second. For example, at 300 baud, 8 data bits, 1 stop bit,
and no parity, each byte takes 10/300 s=33 ms, so the < CR > byte should be advanced by
33 ms in order for the <CR>’s stop bit to line up with the start of the next second.
Time information is available in UTC format or UK TOD format.
NetClock User Reference Guide
389
APPENDIX
‘t’ command
Input format: t<CR>
Output format:
Current Second Second + 1
<CR>
Second + 2
Second + 3
HHMMSS<CR> HHMMSS<CR> HHMMSS<CR>
Number of characters: 7 (including CR)
Each HHMMSS filed refers to the time at the start of the next second. The data transmitted by
NetClock is timed so that the stop bit of each <CR> ends at the start of the next second.
‘d’ command
NetClock transmits the date on request.
Input format: d<CR>
Output format: YYMMDD<CR>
Number of output characters: 7 (including CR)
‘s’ command
NetClock transmits the status information on request.
Input format: s<CR>
Output Format: status
Number of output characters: 1
Where returned, values for status are:
G = System Good
D = Failure of NetClock internal diagnostics
T = NetClock does not have correct time
‘l’ command
The loopback command will cause NetClockto echo the next character received back to the
caller. This may be used by a caller’s equipment to calculate the round trip delay across the
PSTN connection in order to apply a correction to the received time data.
Input format: l<CR>
Output format: (Next character received)
390
NetClock User Reference Guide
APPENDIX
‘hu’ command
The hang up command will cause NetClock to drop the line immediately and terminate the call.
Input format: hu<CR>
5.4.14.4 Format BBC-04
This format is a string of ASCII characters and is sent once per second.
Number of characters: 18 (including CRLF)
Ex am ple
m es s age:
T:ho:mi:sc:dw:da:mo:ye:lp:cs<CR><LF>
Where:
T
Indicates the synchronous moment for the time set
ting.
ho
Hours (00-23)
mi
Minutes (00-59)
sc
Seconds (00-59)
dw
Day of week (01=Monday to 7=Sunday)
da
Day of month (01-31)
mo
Month (01-12)
ye
Year (00-99)
lp
0 (for 60s, no leap) or 1 (for 61s, leap)
cs
Checksum. This is calculated from the start of the
message, including start identifier and excluding
CRLF. It is created by adding all the 1s. If the sum is
even, 0 is returned. If the sum is odd, 1 is returned.
This is mathematically the same as sequentially run
ning an XOR on each bit of each byte.
Standard Serial configuration is:
RS-232 format
9600 baud
8 data bits
NetClock User Reference Guide
391
APPENDIX
1 stop bit
No parity
5.4.14.5 Format BBC-05 (NMEA RMC Message)
The NMEA Message Format RMC, (Recommended Minimum) provides fix information, speed
over ground and Magnetic Variance information. Note that this RMC Message is not 100%
identical to the official NMEA RMC MESSAGE (that corresponds to the 3.01 NMEA 0183 stand
ard and is another time code format supported by NetClock.)
The BBC RMC message (BBC-05) corresponds to Version 2 of the NMEA 0183 standard, fol
lowing the description below:
Ex am ple
m es s age:
$GPRMC,123519,A,4807.038,N,01131.000,E,022.4,084.4,230394,003.1,W*6A
Where:
RMC
Recommended Minimum sentence C
123519
Fix taken at 12:35:19 UTC
A
Status: A=active or V=Void.
4807.038,N
Latitude 48 deg 07.038' N
01131.000,E
Longitude 11 deg 31.000' E
22.4
Speed over the ground in knots
84.4
Track angle in degrees True
230394
Date—23rd of March 1994
003.1,W
Magnetic Variation
*6A
The checksum data, always begins with *
5.4.15 GSSIP Message Format
The GSSIP1 format includes 3 ICD-GPS-153C messages which are used to support emulation of
a SAASM GPS used in a SINCGARS interface. The messages are the Buffer Box (253), Time
Transfer (5101), and the Current Status (5040).
1GSSIP = GPS STANDARD SERIAL INTERFACE PROTOCOL
392
NetClock User Reference Guide
APPENDIX
The ICD-GPS-153C protocol defines the format of these messages. The Current Status and Time
Transfer are sent once per second (1Hz). The Buffer Box is sent once every 6 seconds (1/6 Hz).
The purpose of these three messages is to emulate a SINCGARS interface connection to a
SAASM GPS. NetClock generates these messages emulating the Time and 1PPS transfer beha
vior of the SINCGARS interface. An external device compatible with the SINCGARS interface
can attach to an ASCII Output from NetClock and receive time and 1PPS as if communicating
with and ICD-GPS-153C compatible SAASM GPS.
These commands are emulated only and contain only time information; position and velocity
information is zeroed out. No controlled data is included in the messages, hence no SAASM
GPS receiver is required.
The ASCII Output supports two configurations for supporting SINCGARS:
A configuration of Time Transfer as Message Format1 and Current Status as Format2 causes the
SINCGARS protocol to be emulated and the machine state to be initializated.
Format1: Time Transfer (5101)
Format2: Current Status (5040)
Format3: Buffer Box (253)
A configuration of Current Status as Message Format1 and Time Transfer as Format2 results in
broadcasting of the messages Current Status (1Hz), Time Transfer (1Hz), and Buffer Box
(1/6Hz) at their default rates.
Format1: Current Status (5040)
Format2: Time Transfer (5101)
Format3: Buffer Box (253)
5.4.16 EndRun Formats
The following formats provide compatibility with EndRun technology.
5.4.16.1 EndRun Time Format
Ex am ple
m es s age:
T YYYY DDD HH:MM:SS zZZ m<CR><LF>
Where:
NetClock User Reference Guide
393
APPENDIX
T
Time Figure of Merit character (TFOM), limited to the range 6 to 9:
9 indicates error >±10 milliseconds, or unsynchronized condition
8 indicates error <±10 milliseconds
7 indicates error <±1 millisecond
6 indicates error <±100 microseconds
YYYY
Year
DDD
Day of Year (001-366)
HH
Hour of the day (00-23)
:
Colon Separator
MM
Minutes of the hour
SS
Seconds (00-59), (00-60 for leap second)
z
The sign of the offset to UTC, + implies time is ahead of UTC
ZZ
The magnitude of the offset to UTC in units of half-hours.
If ZZ = 0, then z = +
m
Time mode character, is one of:
G = GPS
L = Local
U = UTC
T = TAI
CR
Carriage Return
LF
Line Feed
5.4.16.2 EndRunX (Extended) Time 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.
T he f o llo wi ng ex am ple
o nc e eac h s ec o nd:
m es s age
s tr i ng
i s
s ent
T YYYY DDD HH:MM:SS zZZ m CC FF<CR><LF>
Where:
394
NetClock User Reference Guide
APPENDIX
T
Time Figure of Merit character (TFOM), limited to the range 6 to 9:
9 indicates error >±10 milliseconds, or unsynchronized condition
8 indicates error <±10 milliseconds
7 indicates error <±1 millisecond
6 indicates error <±100 microseconds
YYYY Year
DDD
Day of Year (001-366)
HH
Hour of the day (00-23)
:
Colon Separator
MM
Minutes of the hour
SS
Seconds (00-59), (00-60 for leap second)
z
The sign of the offset to UTC, + implies time is ahead of UTC
ZZ
The magnitude of the offset to UTC in units of half-hours.
If ZZ = 0, then z = +
m
Time mode character, is one of:
G = GPS
L = Local
U = UTC
T = TAI
CC
The current leap seconds
FF
The future leap seconds, which will show a leap second pending
24 hours in advance
CR
Carriage Return
LF
Line Feed
5.5
IRIG Standards and Specifications
5.5.1
About the IRIG Output Resolution
The IRIG output signals are generated from NetClock's System Time, which can be synced to
one or more external input references (such as GPS, IRIG, PTP, etc). The accuracy of the System
time to true UTC time is dependent upon what the selected external reference is (with GPS typ
ically being the most accurate reference for the system to sync with).
As for the four available IRIG outputs of the 1204-15 Option Card, outputting an IRIG DCLS
(Phase Modulation) signal provides much better and more accurate synchronization of another
NetClock User Reference Guide
395
APPENDIX
device than does an IRIG AM (Amplitude Modulation) signal. This is due to the faster rise-time
with the DCLS signal being able to provide a more “crisp” on-time point (more distinct, with
less jitter) than the slower rise-time of an AM modulated signal.
IRIG AM synchronization of a device to its IRIG source is typically measured in the tens of micro
seconds, while synchronization using a IRIG DCLS signal can typically provide around 100
nanoseconds or so (plus the cable delays between the SecureSync and the other device, as well
as the processing delays of the other system itself).
Note that each of the four IRIG outputs of the Model 1204-15 card has its own available ‘offset’
capability, which is configurable via NetClock’s Web UI, to help account for cabling and pro
cessing delays of the device each output is connected with.
5.5.2
IRIG Carrier Frequencies
Each IRIG code specifies a carrier frequency that is modulated to encode date and time, as well
as control bits to time-stamp events. Initially, IRIG applications were primarily military and gov
ernment associated. Today, IRIG is commonly used to synchronize voice loggers, recall record
ers, and sequential event loggers found in emergency dispatch centers and power utilities.
Table 5-13: Available IRIG output signals
Format
Encoding Modulation
Carrier
Coded Expressions
Bit rate
Time Frame Inter
val
IRIG-A
396
IRIG-A
A000
DCLS
N/A
BCDTOY, CF and SBS
1000 pps 0.1 sec
IRIG-A
A001
DCLS
N/A
BCDTOY, CF
1000 pps 0.1 sec
IRIG-A
A002
DCLS
N/A
BCDTOY
1000 pps 0.1 sec
IRIG-A
A003
DCLS
N/A
BCDTOY, SBS
1000 pps 0.1 sec
IRIG-A
A004
DCLS
N/A
BCDTOY, BCDYEAR, CF and
SBS
1000 pps 0.1 sec
IRIG-A
A005
DCLS
N/A
BCDTOY, BCDYEAR, and CF
1000 pps 0.1 sec
IRIG-A
A006
DCLS
N/A
BCDTOY, BCDYEAR
1000 pps 0.1 sec
IRIG-A
A007
DCLS
N/A
BCDTOY, BCDYEAR, and
SBS
1000 pps 0.1 sec
IRIG-A
A130
AM
10 kHz
BCDTOY, CF and SBS
1000 pps 0.1 sec
IRIG-A
A131
AM
10 kHz
BCDTOY, CF
1000 pps 0.1 sec
IRIG-A
A132
AM
10 kHz
BCDTOY
1000 pps 0.1 sec
NetClock User Reference Guide
APPENDIX
Format
Coded Expressions
Bit rate
Time Frame Inter
val
Encoding Modulation
Carrier
IRIG-A
A133
AM
10 kHz
BCDTOY, SBS
1000 pps 0.1 sec
IRIG-A
A134
AM
10 kHz
BCDTOY, BCDYEAR, CF and
SBS
1000 pps 0.1 sec
IRIG-A
A135
AM
10 kHz
BCDTOY, BCDYEAR, and CF
1000 pps 0.1 sec
IRIG-A
A136
AM
10 kHz
BCDTOY, BCDYEAR
1000 pps 0.1 sec
IRIG-A
A137
AM
10 kHz
BCDTOY, BCDYEAR, and
SBS
1000 pps 0.1 sec
IRIG-B
IRIG-B
B000
DCLS
N/A
BCDTOY, CF and SBS
100 pps
1 sec
IRIG-B
B001
DCLS
N/A
BCDTOY, CF
100 pps
1 sec
IRIG-B
B002
DCLS
N/A
BCDTOY
100 pps
1 sec
IRIG-B
B003
DCLS
N/A
BCDTOY, SBS
100 pps
1 sec
IRIG-B
B004
DCLS
N/A
BCDTOY, BCDYEAR, CF and
SBS
100 pps
1 sec
IRIG-B
B005
DCLS
N/A
BCDTOY, BCDYEAR, and CF
100 pps
1 sec
IRIG-B
B006
DCLS
N/A
BCDTOY, BCDYEAR
100 pps
1 sec
IRIG-B
B007
DCLS
N/A
BCDTOY, BCDYEAR, and
SBS
100 pps
1 sec
IRIG-B
B120
AM
1 kHz
BCDTOY, CF and SBS
100 pps
1 sec
IRIG-B
B121
AM
1 kHz
BCDTOY, CF
100 pps
1 sec
IRIG-B
B122
AM
1 kHz
BCDTOY
100 pps
1 sec
IRIG-B
B123
AM
1 kHz
BCDTOY, SBS
100 pps
1 sec
IRIG-B
B124
AM
1 kHz
BCDTOY, BCDYEAR, CF and
SBS
100 pps
1 sec
IRIG-B
B125
AM
1 kHz
BCDTOY, BCDYEAR, and CF
100 pps
1 sec
IRIG-B
B126
AM
1 kHz
BCDTOY, BCDYEAR
100 pps
1 sec
IRIG-B
B127
AM
1 kHz
BCDTOY, BCDYEAR, and
SBS
100 pps
1 sec
10 pps
1 sec
IRIG-E
IRIG-E
E000
DCLS
NetClock User Reference Guide
N/A
BCDTOY, CF and SBS
397
APPENDIX
Format
Coded Expressions
Bit rate
Time Frame Inter
val
Encoding Modulation
Carrier
IRIG-E
E001
DCLS
N/A
BCDTOY, CF
10 pps
1 sec
IRIG-E
E002
DCLS
N/A
BCDTOY
10 pps
1 sec
IRIG-E
E003
DCLS
N/A
BCDTOY, SBS
10 pps
1 sec
IRIG-E
E004
DCLS
N/A
BCDTOY, BCDYEAR, CF and
SBS
10 pps
1 sec
IRIG-E
E005
DCLS
N/A
BCDTOY, BCDYEAR, and CF
10 pps
1 sec
IRIG-E
E006
DCLS
N/A
BCDTOY, BCDYEAR
10 pps
1 sec
IRIG-E
E007
DCLS
N/A
BCDTOY, BCDYEAR, and
SBS
10 pps
1 sec
IRIG-E
E110
AM
100 Hz
BCDTOY, CF and SBS
10 pps
1 sec
IRIG-E
E111
AM
100 Hz
BCDTOY, CF
10 pps
1 sec
IRIG-E
E112
AM
100 Hz
BCDTOY
10 pps
1 sec
IRIG-E
E113
AM
100 Hz
BCDTOY, SBS
10 pps
1 sec
IRIG-E
E114
AM
100 Hz
BCDTOY, BCDYEAR, CF and
SBS
10 pps
1 sec
IRIG-E
E115
AM
100 Hz
BCDTOY, BCDYEAR, and CF
10 pps
1 sec
IRIG-E
E116
AM
100 Hz
BCDTOY, BCDYEAR
10 pps
1 sec
IRIG-E
E117
AM
100 Hz
BCDTOY, BCDYEAR, and
SBS
10 pps
1 sec
IRIG-E
E120
AM
100 Hz
BCDTOY, CF and SBS
10 pps
1 sec
IRIG-E
E121
AM
1kHz
BCDTOY, CF
10 pps
10 sec
IRIG-E
E122
AM
1kHz
BCDTOY
10 pps
10 sec
IRIG-E
E123
AM
1kHz
BCDTOY, SBS
10 pps
10 sec
IRIG-E
E124
AM
1kHz
BCDTOY, BCDYEAR, CF and
SBS
10 pps
10 sec
IRIG-E
E125
AM
1kHz
BCDTOY, BCDYEAR, and CF
10 pps
10 sec
IRIG-E
E126
AM
1kHz
BCDTOY, BCDYEAR
10 pps
10 sec
IRIG-E
E127
AM
1kHz
BCDTOY, BCDYEAR, and
SBS
10 pps
10 sec
IRIG-G
398
NetClock User Reference Guide
APPENDIX
Format
Coded Expressions
Bit rate
Time Frame Inter
val
Encoding Modulation
Carrier
IRIG-G
G001
DCLS
N/A
BCDTOY, CF
10000
pps
10 msec
IRIG-G
G002
DCLS
N/A
BCDTOY
10000
pps
10 msec
IRIG-G
G005
DCLS
N/A
BCDTOY, BCDYEAR, and CF
10000
pps
10 msec
IRIG-G
G006
DCLS
N/A
BCDTOY, BCDYEAR
10000
pps
10 msec
IRIG-G
G141
AM
100
kHz
BCDTOY, CF
10000
pps
10 msec
IRIG-G
G142
AM
100
kHz
BCDTOY
10000
pps
10 msec
IRIG-G
G145
AM
100
kHz
BCDTOY, BCDYEAR, and CF
10000
pps
10 msec
IRIG-G
G146
AM
100
kHz
BCDTOY, BCDYEAR
10000
pps
10 msec
NASA36
N/A
AM
1msec
UNKNOWN
100 pps
1 sec
NASA36
N/A
DCLS
10 msec UNKNOWN
100 pps
1 sec
The Spectracom IRIG formats use the control functions for BCD year information and a Time
Sync Status bit and in format E the control functions are used for straight binary seconds (SBS).
Refer to individual IRIG Time Code description figures and text. IRIG Standard 200-98 format B
had 27 control bits and format E had 45 bits for control functions. These control bits could be
used for any use and there was no defined function. Spectracom used the control function ele
ment at index count 55 as the TIME SYNC STATUS and the sub-frame after position identifiers
P6 and P7 as the year info and for format E the sub-frame after P8 and P9 for the straight bin
ary seconds (SBS). The position of the BCD year information does not conform to the newer
IRIG Standard 200-04. IRIG Standard 200-04 incorporated the year information after P5 and
reduced the allocated control bits to 18 for format B and 36 for format E.
Note: DCLS is DC Level Shifted output, pulse width modulated with a position
identifier having a positive pulse width equal to 0.8 of the reciprocal of the bit
rate, a binary one (1) having a positive pulse width equal to 0.5 of the reciprocal
NetClock User Reference Guide
399
APPENDIX
of the bit rate and a binary zero (0) having a positive pulse width equal to 0.2 of
the reciprocal of the bite rate.
NetClock can provide IRIG A, IRIG B, IRIG E and IRIG G code in amplitude modulated (AM) or
pulse width coded (TTL) formats. A signature control feature may be enabled for any IRIG out
put. Signature control removes the modulation code when a Time Sync Alarm is asserted.
5.5.3
IRIG B Output
The IRIG B Time Code description follows.
Figure 5-10: IRIG B time code description
The IRIG B code contains the Binary Coded Decimal (BCD) time of year, Control Function (CF)
field and the Straight Binary Seconds time of day. The following figure illustrates the IRIG B
400
NetClock User Reference Guide
APPENDIX
data structure. The BCD time of year provides the day of the year, 1-366, and the time of day
including seconds. The hour of the day is expressed in 24 hour format. The SBS time is the num
ber of seconds elapsed since midnight. The Control Function field contains year information
and a time synchronization status bit.
1. Time frame: 1.0 seconds.
2. Code digit weighting:
A. Binary Coded Decimal time-of-year.
Code word - 30 binary digits.
Seconds, minutes hours, and days.
Recycles yearly.
B. Straight Binary Seconds time-of-day.
Code word - 17 binary digits.
Seconds only, recycles daily.
3. Code word structure:
BCD: Word seconds digits begin at index count 1. Binary coded elements occur
between position identifier elements P0 and P5 (7 for seconds, 7 for minutes, 6
for hours, and 10 for days) until the code word is complete. An index marker
occurs between decimal digits in each group to provide separation for visual res
olution. Least significant digit occurs first.
CF : IRIG formats reserve a set of elements known as Control Functions (CF) for the
encoding of various control, identification, or other special purpose functions.
IRIG B has 27 Control Functions located between elements 50 and 78. The NetC
lock uses the Control Functions to encode year information and time syn
chronization status.
The table below lists the Control Function Field and the function of each element.
Element 55 is the time synchronization status bit. Element 55 is a Binary 1 when the unit
is in sync, and a Binary 0 when it is not.
Year information consists of the last two digits of the current year (i.e. 97, 98, 99 etc.).
Elements 60 through 63 contain the binary equivalent of year units. Elements 65 through
68 contain the binary equivalent of tens of years. In keeping with IRIG formats, the least
significant bit occurs first. All unused Control Functions are filled with a space (Binary 0).
SBS : Word begins at index count 80. Seventeen Straight Binary Coded elements occur
with a position identifier between the 9th and 10th binary coded elements. Least sig
nificant digit occurs first.
NetClock User Reference Guide
401
APPENDIX
Pulse rates:
Element rate: 100 per second.
Position identifier rate: 10 per second.
Reference marker rate: 1 per second.
Element identification: The "on time" reference point for all elements is the pulse leading
edge.
Index marker (Binary 0 or uncoded element): 2 millisecond duration.
Code digit (Binary 1): 5 millisecond duration.
Position identifier: 8 millisecond duration.
Reference marker, 1 per second. The reference marker appears as two consecutive pos
ition identifiers. The second position identifier marks the on-time point for the succeeding
code word.
Resolution:
Pulse width coded signal: 10 milliseconds.
Amplitude modulated signal: 1 millisecond.
Carrier frequency: 1kHz when modulated.
Table 5-14: IRIG B control function field
C.F. Element # Digit #
402
Function
50
1
Space
51
2
Space
52
3
Space
53
4
Space
54
5
Space
55
6
Time Sync Status
56
7
Space
57
8
Space
58
9
Space
59
PID P6
Position Identifier
60
10
Years Units Y1
61
11
Years Units Y2
NetClock User Reference Guide
APPENDIX
C.F. Element # Digit #
5.5.3.1
Function
62
12
Years Units Y4
63
13
Years Units Y8
64
14
Space
65
15
Years Tens Y10
66
16
Years Tens Y20
67
17
Years Tens Y40
68
18
Years Tens Y80
69
PID P7
Position Identifier
70
19
Space
71
20
Space
72
21
Space
73
22
Space
74
23
Space
75
24
Space
76
25
Space
77
26
Space
78
27
Space
FAA IRIG B Code Description
NetClock can be configured to provide IRIG timing, reflecting UTC or local time, with or
without daylight saving time corrections. Below is a detailed description of the FAA modified
IRIG B code. The FAA modified the IRIG B code by including satellite lock status and time error
flags in the Control Function Field. The error flags provide an inaccuracy estimate based on the
time elapsed since loss of GPS lock. In addition, the Straight Binary Seconds (SBS) data was
removed from the data stream. The SBS time is the number of seconds elapsed since midnight.
FAA IRIG B OUTPUT
The FAA IRIG B code contains the Binary Coded Decimal (BCD) time of year and a Control
Function (CF) field containing satellite lock status and time error flags. With the exception of the
position identifiers, all remaining code elements are set to a binary 0. Figure A-1 illustrates the
NetClock User Reference Guide
403
APPENDIX
FAA IRIG B data structure. The BCD time of year provides the day of the year, 001-366, and
the time of day including seconds. The hour of the day is expressed in 24-hour format.
FAA IRIG B General Description
1. Time frame: 1.0 seconds
2. Pulse rates:
A. Element rate: 100 per second
B. Position identifier rate: 10 per second
C. Reference marker rate: 1 per second
3. Element identification: The "on time" reference point for all elements is the pulse leading
edge.
A. Index marker (Binary 0 or uncoded element): 2 millisecond duration
B. Code digit (Binary 1): 5 millisecond duration
C. Position identifier: 8 millisecond duration
D. Reference marker, 1 per second. The reference marker appears as two con
secutive position identifiers. The second position identifier marks the on-time point
for the succeeding code word.
4. Resolution: 10 milliseconds
5. Code word structure:
BCD: Word seconds digits begin at index count 1. Binary coded elements occur
between position identifier elements P0 and P5 (7 for seconds, 7 for minutes, 6
for hours, and 10 for days) until the code word is complete. An index marker
occurs between decimal digits in each group to provide separation for visual res
olution. Least significant digit occurs first.
CF: IRIG formats reserve a set of elements known as Control Functions (CF) for the
encoding of various control, identification, or other special purpose functions.
IRIG B has 27 Control Functions located between elements 50 and 78. The FAA
IRIG B code uses five of the Control Function elements to encode satellite lock
status and time error flags. For a description of the status and error flag imple
mentation, refer to the table and the paragraphs below.
Element 53 (530 ms) is the time sync status bit. Element 53 is a Binary 1 when the
receiver locked to GPS, and a Binary 0 when the receiver is not locked to GPS.
404
NetClock User Reference Guide
APPENDIX
Element 55 (550 ms) is the ±1.0 millisecond error flag. Element 55 is set to Binary
1 when the expected time error is within +/- 1.0 millisecond, and a Binary 0 dur
ing all other conditions of operation.
Element 56 (560 ms) is the ±5.0 millisecond error flag. Element 56 is set to Binary
1 when the expected time error is within +/- 5.0 milliseconds. and a Binary 0 dur
ing all other conditions of operation.
Element 57 (570 ms) is the ±50 millisecond error flag. Element 57 is set to Binary
1 when the expected time error is within +/- 50 milliseconds, and a Binary 0 dur
ing all other conditions of operation.
Element 58 (580 ms) is the ±500 millisecond error flag. Element 58 is set to Bin
ary 1 when the expected time error is within ±500 milliseconds, and a Binary 0
during all other conditions of operation.
Table 5-15: FAA Time Error Indicators
Time Since Loss of Lock
Status/Error
Lock Indic
ator
±1ms ±5ms ±50 ms ±500 ms
N/A
Locked Error < 2μs
1
0
0
0
0
< 00:16:40
Unlocked Error < 1ms
0
1
0
0
0
00:16:41 to 01:23:39
Unlocked Error < 5ms
0
0
1
0
0
01:23:40 to 13:53:19
Unlocked Error < 50 ms
0
0
0
1
0
13:53:20 to 5 days
18:53:19
Unlocked Error < 500
ms
0
0
0
0
1
>5 days 18:53:20
Unlocked Error
Unknown
0
0
0
0
0
N/A
Power On
0
0
0
0
0
NetClock User Reference Guide
405
APPENDIX
Figure 5-11: FAA modified IRIG B
Notes
The beginning of each 1.0 second time frame is identified by two consecutive 8.0 ms elements
(P 0 and P 8 ). The leading edge of the second 8.0 ms element (P R ) is the "on time" reference
point for the succeeding time code. 10 pps position identifiers P0 , P1 , ..... P8 (8.0 ms duration)
occur 10 ms before 10 pps "on time" and refer to the leading edge of the succeeding element.
The time code word and the control functions presented during the time frame are pulse-width
coded. The binary "zero" and index markers have a duration of 2.0 ms, and the binary "one"
has a duration of 5.0 ms. The leading edge is the 100 pps "on time" reference point for all ele
ments.
The binary coded decimal (BCD) time-of-year code word consists of 30 digits beginning at
index count 1. The binary coded subword elements occur between position identifiers P 0 and
P 5 (7 for seconds; 7 for minutes; 6 for hours; 10 for days) until the code word is complete. An
index marker occurs between the decimal digits in each subword to provide separation for
visual resolution. The least significant digit occurs first. The BCD code recycles yearly.
Twenty-seven control functions occur between position identifiers P 5 and P 8 . FAA uses this field
to communicate satellite lock status and time error and indicators. The first flag element is at
530 ms which indicates satellite lock. The ±1ms error flag occurs at 550 ms. The ±5ms error
flag occurs at 560 ms. The ±50 ms error flag occurs at 570 ms. The ±500 ms error flag occurs
at 580 ms.
The straight binary (SB) time-of-day code word normally found between position identifiers P 8
and P0 is eliminated for FAA IRIG B. All elements between position identifiers P8 and P0 are set
to Binary 0.
406
NetClock User Reference Guide
APPENDIX
5.5.4
IRIG E Output
The IRIG E code contains the Binary Coded Decimal (BCD) time of year and Control Functions.
The figure IRIG E Time Code Description illustrates the IRIG E data structure. The BCD time of
year provides the day of year, 1-366, and time of day to tens of seconds. The hour of the day
is expressed in 24 hour format. The Control Function field includes a time synchronization
status bit, year information and SBS time of day.
Time frame: 10 seconds.
Code Digit Weighting:
Binary Coded Decimal time of year.
Code world - 26 binary digits.
Tens of seconds, minutes, hours, and days.
Recycles yearly.
Code Word Structure: BCD word tens of seconds digits begin at index count 6. Binary
coded elements occur between position identifier elements P0 and P5 (3 for seconds, 7
for minutes, 6 for hours, and 10 for days) until the code word is complete. An index
marker occurs between decimal digits in each group to provide separation for visual res
olution. Least significant digit occurs first.
Control Functions : IRIG formats reserve a set of elements known as Control Functions
(CF) for the encoding of various control, identification, or other special purpose func
tions. IRIG E has 45 Control Functions located between elements 50 and 98. The NetC
lock uses the Control Function field to encode year data, time synchronization status,
and SBS time data. Table B-2 lists the Control Function Field and each element's function.
Element 55 is the time synchronization status bit. Element 55 is a Binary 1 when the front panel
time synchronization lamp is green, and a Binary 0 when the lamp is red.
Year information consists of the last two digits of the current year (i.e. 98, 99, etc.). Elements 60
through 63 contain the binary equivalent of year units. Elements 65 through 68 contain the bin
ary equivalent of tens of years. In keeping with IRIG formats, the least significant bit occurs first.
Elements 80 through 97 are encoded with the Straight Binary Seconds (SBS) time data. The
SBS time data is incremented in 10-second steps and recycles every 24 hours.
Pulse rates:
Element rate: 10 per second.
Position identifier rate: 1 per second.
Reference marker rate: 1 per 10 seconds.
NetClock User Reference Guide
407
APPENDIX
Element identification: The "on time" reference point for all elements is the pulse leading
edge.
Index marker (Binary 0 or uncoded element): 20 millisecond duration.
Code digit (Binary 1): 50 millisecond duration.
Position identifier: 80 millisecond duration.
Reference marker: 80 millisecond duration, 1 per 10 seconds. The reference marker
appears as two consecutive position identifiers. The second position identifier or ref
erence marker is the on-time point for the succeeding code word.
Figure 5-12: IRIG E time code description
Additional information
The beginning of each 10 second time frame is identified by two consecutive 80 ms elements
(P0 and PR). The leading edge of the second 80 ms element (PR) is the "on time" reference point
for the succeeding time code. 1PPS position identifiers P 0 , P 1 … P 9 (80 ms duration) occur
0.1 s before 1PPS "on time" and refer to the leading edge of the succeeding element.
The time code word and the control functions presented during the time frame are pulse-width
coded. The binary "zero" and index markers have a duration of 20 ms, and the binary "one"
has a duration of 50 ms. The leading edge is the 10 pps "on time" reference point for all ele
ments.
408
NetClock User Reference Guide
APPENDIX
The binary coded decimal (BCD) time-of-year code word consists of 26 digits beginning at
index count 6. The binary coded subword elements occur between position identifiers P 0 and
P 5 (3 for seconds; 7 for minutes; 6 for hours; 10 for days) until the code word is complete. An
index marker occurs between the decimal digits in each subword to provide separation for
visual resolution. The least significant digit occurs first. The BCD code recycles yearly.
Forty-five control functions occur between position identifiers P 5 and P 0 . Any control function
element for combination of control function elements can be programmed to read a binary
"one" during any specified number of time frames. Each control element is identified on the
Control Function Field Table.
Table 5-16: IRIG E control function field
BIT No. CF ELEMENT No.
FUNCTION
50
1
SPACE
51
2
SPACE
52
3
SPACE
53
4
SPACE
54
5
SPACE
55
6
TIME SYNC_STATUS
56
7
SPACE
57
8
SPACE
58
9
SPACE
59
PID P6
POSITION IDENTIFIER
60
10
YEAR UNITS Y1
61
11
YEAR UNITS Y2
62
12
YEAR UNITS Y4
63
13
YEAR UNITS Y8
64
14
SPACE
65
15
YEAR TENS Y10
66
16
YEAR TENS Y20
67
17
YEAR TENS Y40
68
18
YEAR TENS Y80
69
PID P7
POSITION IDENTIFIER
NetClock User Reference Guide
409
APPENDIX
BIT No. CF ELEMENT No.
410
FUNCTION
70
19
SPACE
71
20
SPACE
72
21
SPACE
73
22
SPACE
74
23
SPACE
75
24
SPACE
76
25
SPACE
77
26
SPACE
78
27
SPACE
79
PID P8
POSITION IDENTIFIER
80
28
SBS 20
81
29
SBS 21
82
30
SBS 22
83
31
SBS 23
84
32
SBS 24
85
33
SBS 25
86
34
SBS 26
87
35
SBS 27
88
36
SBS 28
89
PID P9
POSITION IDENTIFIER
90
37
SBS 29
91
38
SBS 210
92
39
SBS 211
93
40
SBS 212
94
41
SBS 213
95
42
SBS 214
96
43
SBS 215
97
44
SBS 216
NetClock User Reference Guide
APPENDIX
BIT No. CF ELEMENT No.
5.5.5
FUNCTION
98
45
SPACE
99
PID P0
POSITION IDENTIFIER
IRIG Output Accuracy Specifications
The IRIG outputs of the Spectracom Option Cards 1204-15, -1E, -22, and 1204-05, -27 deliver
signals with the following 1PPS accuracy:
IRIC DCLS
Signal Category
Measured
Accuracy
IRIG A
30 ns
IRIG B
30 ns
IRIG G
30 ns
IRIG NASA
30 ns
IRIG E
30 ns
IRIG AM
5.6
Signal Category
Measured
Accuracy
IRIG A
200 ns
IRIG B
800 ns
IRIG G
200 ns
IRIG NASA
800 ns
IRIG E
1.5 μs
Technical Support
To request technical support for your NetClock unit, please go to the "Support" page of the
Spectracom Corporate website, where you can not only submit a support request, but also find
NetClock User Reference Guide
411
APPENDIX
additional technical documentation.
Phone support is available during regular office hours under the telephone numbers listed
below.
To speed up the diagnosis of your NetClock, please send us:
the current product configuration, and
the events log (see "Saving and Downloading Logs" on page 286).
Thank you for your cooperation.
5.6.1
Regional Contact
Spectracom operates globally and has offices in several locations around the world. Our main
offices are listed below:
Country
Location
Phone
China
Beijing
+86-10-8231 9601
France
Les Ulis, Cedex
+33 (0)1 6453 3980
USA
Rochester, NY
+1.585.321.5800
Table 5-17: Spectracom contact information
Additional regional contact information can be found on the Contact Us page of the Spec
tracom corporate website.
5.7
Return Shipments
Please contact Spectracom Technical Support before returning any equipment to Spectracom.
Technical Support must provide you with a Return Material Authorization Number (RMA#)
prior to shipment.
When contacting Technical Support, please be prepared to provide your equipment serial num
ber(s) and a description of the failure symptoms or issues you would like resolved.
Freight to Spectracom is to be prepaid by the customer.
412
NetClock User Reference Guide
APPENDIX
Note: Should there be a need to return equipment to Spectracom, it must be
shipped in its original packing material. Save all packaging material for this pur
pose.
5.8
License Notices
5.8.1
NTPv4.2.6p5
Copyright Notice
jpg "Clone me," says Dolly sheepishly.
Last update: 1-Jan-2011 08:34 UTC
_______________________________________________________
The following copyright notice applies to all files collectively called the Network Time Protocol Version 4 Dis
tribution. Unless specifically declared otherwise in an individual file, this notice applies as if the text was expli
citly included in the file.
***********************************************************************
* Copyright (c) University of Delaware 1992-2011 Permission to use, copy, modify, and distribute this software and its documentation for any purpose with or
without fee is hereby granted, provided that the above copyright notice appears in all copies and that both
the copyright notice and this permission notice appear in supporting documentation, and that the name
University of Delaware not be used in advertising or publicity pertaining to distribution of the software without
specific, written prior permission. The University of Delaware makes no representations about the suitability
this software for any purpose. It is provided "as is" without express or implied warranty.
***********************************************************************
The following individuals contributed in part to the Network Time Protocol Distribution Version 4 and are
acknowledged as authors of this work.
1. [1]Takao Abe <takao_abe@xurb.jp> Clock driver for JJY receivers
2. [2]Mark Andrews <mark_andrews@isc.org> Leitch atomic clock controller
3. [3]Bernd Altmeier <altmeier@atlsoft.de> hopf Elektronik serial line and PCI-bus devices
4. [4]Viraj Bais <vbais@mailman1.intel.com> and [5]Clayton Kirkwood <kirkwood@striderfm.intel.com>
port to WindowsNT 3.5
5. [6]Michael Barone <michael,barone@lmco.com> GPSVME fixes
6. [7]Karl Berry <karl@owl.HQ.ileaf.com> syslog to file option
7. [8]Greg Brackley <greg.brackley@bigfoot.com> Major rework of WINNT port. Clean up recvbuf and
iosignal code into separate modules.
8. [9]Marc Brett <Marc.Brett@westgeo.com> Magnavox GPS clock driver
9. [10]Piete Brooks <Piete.Brooks@cl.cam.ac.uk> MSF clock driver, Trimble PARSE support
10. [11]Nelson B Bolyard <nelson@bolyard.me> update and complete broadcast and crypto features in sntp
11. [12]Jean-Francois Boudreault <Jean-Francois.Boudreault@viagenie.qc.ca> IPv6 support
NetClock User Reference Guide
413
APPENDIX
12. [13]Reg Clemens <reg@dwf.com> Oncore driver (Current maintainer)
13. [14]Steve Clift <clift@ml.csiro.au> OMEGA clock driver
14. [15]Casey Crellin <casey@csc.co.za> vxWorks (Tornado) port and help with target configuration
15. [16]Sven Dietrich <sven_dietrich@trimble.com> Palisade reference clock driver, NT adj. residuals, integ
rated Greg's Winnt port.
16. [17]John A. Dundas III <dundas@salt.jpl.nasa.gov> Apple A/UX port
17. [18]Torsten Duwe <duwe@immd4.informatik.uni-erlangen.de> Linux port
18. [19]Dennis Ferguson <dennis@mrbill.canet.ca> foundation code for NTP Version 2 as specified in RFC1119
19. [20]John Hay <jhay@icomtek.csir.co.za> IPv6 support and testing
20. [21]Dave Hart <davehart@davehart.com> General maintenance, Windows port interpolation rewrite
21. [22]Claas Hilbrecht <neoclock4x@linum.com> NeoClock4X clock driver
22. [23]Glenn Hollinger <glenn@herald.usask.ca> GOES clock driver
23. [24]Mike Iglesias <iglesias@uci.edu> DEC Alpha port
24. [25]Jim Jagielski <jim@jagubox.gsfc.nasa.gov> A/UX port
25. [26]Jeff Johnson <jbj@chatham.usdesign.com> massive prototyping overhaul
26. [27]Hans Lambermont <Hans.Lambermont@nl.origin-it.com> or
[28]<H.Lambermont@chello.nl> ntpsweep
27. [29]Poul-Henning Kamp <phk@FreeBSD.ORG> Oncore driver (Original author)
28. [30]Frank Kardel [31]<kardel (at) ntp (dot) org> PARSE <GENERIC> driver (>14 reference clocks),
STREAMS modules for PARSE, support scripts, syslog cleanup, dynamic interface handling
29. [32]William L. Jones <jones@hermes.chpc.utexas.edu> RS/6000 AIX modifications, HPUX modifications
30. [33]Dave Katz <dkatz@cisco.com> RS/6000 AIX port
31. [34]Craig Leres <leres@ee.lbl.gov> 4.4BSD port, ppsclock, Magnavox GPS clock driver
32. [35]George Lindholm <lindholm@ucs.ubc.ca> SunOS 5.1 port
33. [36]Louis A. Mamakos <louie@ni.umd.edu> MD5-based authentication
34. [37]Lars H. Mathiesen <thorinn@diku.dk> adaptation of foundation code for Version 3 as specified in
RFC-1305
35. [38]Danny Mayer <mayer@ntp.org>Network I/O, Windows Port, Code Maintenance
36. [39]David L. Mills <mills@udel.edu> Version 4 foundation: clock discipline, authentication, precision ker
nel; clock drivers: Spectracom, Austron, Arbiter, Heath, ATOM, ACTS, KSI/Odetics; audio clock drivers:
CHU, WWV/H, IRIG
37. [40]Wolfgang Moeller <moeller@gwdgv1.dnet.gwdg.de> VMS port
38. [41]Jeffrey Mogul <mogul@pa.dec.com> ntptrace utility
39. [42]Tom Moore <tmoore@fievel.daytonoh.ncr.com> i386 svr4 port
40. [43]Kamal A Mostafa <kamal@whence.com> SCO OpenServer port
41. [44]Derek Mulcahy <derek@toybox.demon.co.uk> and [45]Damon Hart-Davis <d@hd.org> ARCRON
MSF clock driver
42. [46]Rob Neal <neal@ntp.org> Bancomm refclock and config/parse code maintenance
43. [47]Rainer Pruy <Rainer.Pruy@informatik.uni-erlangen.de> monitoring/trap scripts, statistics file handling
44. [48]Dirce Richards <dirce@zk3.dec.com> Digital UNIX V4.0 port
45. [49]Wilfredo Sánchez <wsanchez@apple.com> added support for NetInfo
46. [50]Nick Sayer <mrapple@quack.kfu.com> SunOS streams modules
414
NetClock User Reference Guide
APPENDIX
47. [51]Jack Sasportas <jack@innovativeinternet.com> Saved a Lot of space on the stuff in the html/pic/ sub
directory
48. [52]Ray Schnitzler <schnitz@unipress.com> Unixware1 port
49. [53]Michael Shields <shields@tembel.org> USNO clock driver
50. [54]Jeff Steinman <jss@pebbles.jpl.nasa.gov> Datum PTS clock driver
51. [55]Harlan Stenn <harlan@pfcs.com> GNU automake/autoconfigure makeover, various other bits (see
the ChangeLog)
52. [56]Kenneth Stone <ken@sdd.hp.com> HP-UX port
53. [57]Ajit Thyagarajan <ajit@ee.udel.edu>IP multicast/anycast support
54. [58]Tomoaki TSURUOKA <tsuruoka@nc.fukuoka-u.ac.jp>TRAK clock driver
55. [59]Paul A Vixie <vixie@vix.com> TrueTime GPS driver, generic TrueTime clock driver
56. [60]Ulrich Windl <Ulrich.Windl@rz.uni- regensburg.de> corrected and validated HTML documents
according to the HTML DTD
_______________________________________________________
References
1. mailto:%20takao_abe@xurb.jp
2. mailto:%20mark_andrews@isc.org
3. mailto:%20altmeier@atlsoft.de
4. mailto:%20vbais@mailman1.intel.co
5. mailto:%20kirkwood@striderfm.intel.com
6. mailto:%20michael.barone@lmco.com
7. mailto:%20karl@owl.HQ.ileaf.com
8. mailto:%20greg.brackley@bigfoot.com
9. mailto:%20Marc.Brett@westgeo.com
10. mailto:%20Piete.Brooks@cl.cam.ac.uk
11. mailto:%20nelson@bolyard.me
12. mailto:%20Jean-Francois.Boudreault@viagenie.qc.ca
13. mailto:%20reg@dwf.com
14. mailto:%20clift@ml.csiro.au
15. mailto:casey@csc.co.za
16. mailto:%20Sven_Dietrich@trimble.COM
17. mailto:%20dundas@salt.jpl.nasa.gov
18. mailto:%20duwe@immd4.informatik.uni-erlangen.de
19. mailto:%20dennis@mrbill.canet.ca
20. mailto:%20jhay@icomtek.csir.co.za
21. mailto:%20davehart@davehart.com
22. mailto:%20neoclock4x@linum.com
23. mailto:%20glenn@herald.usask.ca
24. mailto:%20iglesias@uci.edu
25. mailto:%20jagubox.gsfc.nasa.gov
26. mailto:%20jbj@chatham.usdesign.com
27. mailto:Hans.Lambermont@nl.origin-it.com
28. mailto:H.Lambermont@chello.nl
NetClock User Reference Guide
415
APPENDIX
29. mailto:%20phk@FreeBSD.ORG
30. http://www4.informatik.uni-erlangen.de/%7ekardel
31. mailto:%20kardel(at)ntp(dot)org
32. mailto:%20jones@hermes.chpc.utexas.edu
33. mailto:%20dkatz@cisco.com
34. mailto:%20leres@ee.lbl.gov
35. mailto:%20lindholm@ucs.ubc.ca
36. mailto:%20louie@ni.umd.edu
37. mailto:%20thorinn@diku.dk
38. mailto:%20mayer@ntp.org
39. mailto:%20mills@udel.edu
40. mailto:%20moeller@gwdgv1.dnet.gwdg.de
41. mailto:%20mogul@pa.dec.com
42. mailto:%20tmoore@fievel.daytonoh.ncr.com
43. mailto:%20kamal@whence.com
44. mailto:%20derek@toybox.demon.co.uk
45. mailto:%20d@hd.org
46. mailto:%20neal@ntp.org
47. mailto:%20Rainer.Pruy@informatik.uni-erlangen.de
48. mailto:%20dirce@zk3.dec.com
49. mailto:%20wsanchez@apple.com
50. mailto:%20mrapple@quack.kfu.com
51. mailto:%20jack@innovativeinternet.com
52. mailto:%20schnitz@unipress.com
53. mailto:%20shields@tembel.org
54. mailto:%20pebbles.jpl.nasa.gov
55. mailto:%20harlan@pfcs.com
56. mailto:%20ken@sdd.hp.com
57. mailto:%20ajit@ee.udel.edu
58. mailto:%20tsuruoka@nc.fukuoka-u.ac.jp
59. mailto:%20vixie@vix.com
60. mailto:%20Ulrich.Windl@rz.uni-regensburg.de
________________________________________________________________
[53]gif.
[54]David L. Mills <mills@udel.edu>
References
1. mailto:marka@syd.dms.csiro.au
2. mailto:altmeier@atlsoft.de
3. mailto:vbais@mailman1.intel.co
4. mailto:kirkwood@striderfm.intel.com
5. mailto:michael.barone@lmco.com
6. mailto:karl@owl.HQ.ileaf.com
416
NetClock User Reference Guide
APPENDIX
7. mailto:greg.brackley@bigfoot.com
8. mailto:Marc.Brett@westgeo.com
9. mailto:Piete.Brooks@cl.cam.ac.uk
10. mailto:reg@dwf.com
11. mailto:clift@ml.csiro.au
12. mailto:casey@csc.co.za
13. mailto:Sven_Dietrich@trimble.COM
14. mailto:dundas@salt.jpl.nasa.gov
15. mailto:duwe@immd4.informatik.uni-erlangen.de
16. mailto:dennis@mrbill.canet.ca
17. mailto:glenn@herald.usask.ca
18. mailto:iglesias@uci.edu
19. mailto:jagubox.gsfc.nasa.gov
20. mailto:jbj@chatham.usdesign.com
21. mailto:Hans.Lambermont@nl.origin-it.com
22. mailto:H.Lambermont@chello.nl
23. mailto:phk@FreeBSD.ORG
24. http://www4.informatik.uni-erlangen.de/~kardel
25. mailto:Frank.Kardel@informatik.uni-erlangen.de
26. mailto:jones@hermes.chpc.utexas.edu
27. mailto:dkatz@cisco.com
28. mailto:leres@ee.lbl.gov
29. mailto:lindholm@ucs.ubc.ca
30. mailto:louie@ni.umd.edu
31. mailto:thorinn@diku.dk
32. mailto:mills@udel.edu
33. mailto:moeller@gwdgv1.dnet.gwdg.de
34. mailto:mogul@pa.dec.com
35. mailto:tmoore@fievel.daytonoh.ncr.com
36. mailto:kamal@whence.com
37. mailto:derek@toybox.demon.co.uk
38. mailto:d@hd.org
39. mailto:Rainer.Pruy@informatik.uni-erlangen.de
40. mailto:dirce@zk3.dec.com
41. mailto:wsanchez@apple.com
42. mailto:mrapple@quack.kfu.com
43. mailto:jack@innovativeinternet.com
44. mailto:schnitz@unipress.com
45. mailto:shields@tembel.org
46. mailto:pebbles.jpl.nasa.gov
47. mailto:harlan@pfcs.com
48. mailto:ken@sdd.hp.com
NetClock User Reference Guide
417
APPENDIX
49. mailto:ajit@ee.udel.edu
50. mailto:tsuruoka@nc.fukuoka-u.ac.jp
51. mailto:vixie@vix.com
52. mailto:Ulrich.Windl@rz.uni-regensburg.de
53. file://localhost/backroom/ntp-stable/html/index.htm
54. mailto:mills@udel.edu
5.8.2
OpenSSH
This file is part of the OpenSSH software.
The licences which components of this software fall under are as follows. First, we will summarize and say
that all components are under a BSD licence, or a licence more free than that.
OpenSSH contains no GPL code.
1) Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
All rights reserved
As far as I am concerned, the code I have written for this software can be used freely for any purpose. Any
derived versions of this software must be clearly marked as such, and if the derived work is incompatible with
the protocol description in the RFC file, it must be called by a name other than "ssh" or "Secure Shell".
However, I am not implying to give any licenses to any patents or copyrights held by third parties, and the
software includes parts that are not under my direct control. As far as I know, all included source code is used
in accordance with the relevant license agreements and can be used freely for any purpose (the GNU license
being the most restrictive); see below for details. [However, none of that term is relevant at this point in time.
All of these restrictively licenced software components which he talks about have been removed from
OpenSSH, i.e.,
- RSA is no longer included, found in the OpenSSL library
- IDEA is no longer included, its use is deprecated
- DES is now external, in the OpenSSL library
- GMP is no longer used, and instead we call BN code from OpenSSL
- Zlib is now external, in a library
- The make-ssh-known-hosts script is no longer included
- TSS has been removed
- MD5 is now external, in the OpenSSL library
- RC4 support has been replaced with ARC4 support from OpenSSL
- Blowfish is now external, in the OpenSSL library
Note that any information and cryptographic algorithms used in this software are publicly available on the
Internet and at any major bookstore, scientific library, and patent office worldwide. More information can be
found e.g. at "http://www.cs.hut.fi/crypto".
The legal status of this program is some combination of all these permissions and restrictions. Use only at your
own responsibility. You will be responsible for any legal consequences yourself; I am not making any claims
whether possessing or using this is legal or not in your country, and I am not taking any responsibility on your
behalf.
NO WARRANTY
418
NetClock User Reference Guide
APPENDIX
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE
PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
2) The 32-bit CRC implementation in crc32.c is due to Gary S. Brown. Comments in the file indicate it may be
used for any purpose without restrictions: COPYRIGHT (C) 1986 Gary S. Brown. You may use this program,
or code or tables extracted from it, as desired without restriction.
3) The 32-bit CRC compensation attack detector in deattack.c was contributed by CORE SDI S.A. under a
BSD-style license. Cryptographic attack detector for ssh - source code Copyright (c) 1998 CORE SDI S.A.,
Buenos Aires, Argentina.
All rights reserved. Redistribution and use in source and binary forms, with or without modification, are per
mitted provided that this copyright notice is retained.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED.
IN NO EVENT SHALL CORE SDI S.A. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OR MISUSE OF THIS
SOFTWARE.
Ariel Futoransky <futo@core-sdi.com><http://www.core-sdi.com>
4) ssh- keygen was contributed by David Mazieres under a BSD- style license. Copyright 1995, 1996 by
David Mazieres <dm@lcs.mit.edu>.
Modification and redistribution in source and binary forms is permitted provided that due credit is given to the
author and the OpenBSD project by leaving this copyright notice intact.
5) The Rijndael implementation by Vincent Rijmen, Antoon Bosselaers and Paulo Barreto is in the public
domain and distributed with the following license: @version 3.0 (December 2000) Optimised ANSI C code
for the Rijndael cipher (now AES) @author Vincent Rijmen vincent.rijmen@esat.kuleuven.ac.be @author
Antoon Bosselaers antoon.bosselaers@esat.kuleuven.ac.be @author Paulo Barreto <paulo.bar
reto@terra.com.br>
This code is hereby placed in the public domain.
THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
NetClock User Reference Guide
419
APPENDIX
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
6) One component of the ssh source code is under a 4- clause BSD license, held by the University of Cali
fornia, since we pulled these parts from original Berkeley code. The Regents of the University of California
have declared that term 3 is no longer enforceable on their source code, but we retain that license as is.Copy
right (c) 1983, 1990, 1992, 1993, 1995 The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the fol
lowing disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the fol
lowing disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknow
ledgement: This product includes software developed by the University of California, Berkeley and its con
tributors.
4. Neither the name of the University nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
7) Remaining components of the software are provided under a standard 2- term BSD licence with the fol
lowing names as copyright holders:
Markus Friedl, Theo de Raadt, Niels Provos, Dug Song, Aaron Campbell, Damien Miller, Kevin Steves,
Daniel Kouril, Per Allansson
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the fol
lowing disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the fol
lowing disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS ORIMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIESOF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
420
NetClock User Reference Guide
APPENDIX
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
5.8.3
OpenSSL
LICENSE ISSUES
==============
The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the ori
ginal SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses are
BSD- style Open Source licenses. In case of any license issues related to OpenSSL please contact opensslcore@openssl.org.
OpenSSL License
====================================================================
Copyright (c) 1998-2003 The OpenSSL Project. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the fol
lowing disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the fol
lowing disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknow
ledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.
(http://www.openssl.org/)"
4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products
derived from this software without prior written permission. For written permission, please contact opensslcore@openssl.org.
5. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their
names without prior written permission of the OpenSSL Project.
6. Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/)"
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL
PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
====================================================================
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product
includes software written by Tim Hudson (tjh@cryptsoft.com).
NetClock User Reference Guide
421
APPENDIX
Original SSLeay License
----------------------/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved.
This package is an SSL implementation written by Eric Young (eay@cryptsoft.com).
The implementation was written so as to conform with Netscapes SSL.
This library is free for commercial and non-commercial use as long as the following conditions are aheared
to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, lhash, DES, etc.,
code; not just the SSL code. The SSL documentation included with this distribution is covered by the same
copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com).
Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this
package is used in a product, Eric Young should be given attribution as the author of the parts of the library
used. This can be in the form of a textual message at program startup or in documentation (online or textual)
provided with the package.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the following dis
claimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the fol
lowing disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknow
ledgement: "This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)" The
word 'cryptographic' can be left out if the rouines from the library being used are not cryptographic related
:-).
4. If you include any Windows specific code (or a derivative thereof) from the apps directory (application
code) you must include an acknowledgement: "This product includes software written by Tim Hudson
(tjh@cryptsoft.com)"
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The licence and distribution terms for any publically available version or derivative of this code cannot be
changed. i.e. this code cannot simply be copied and put under another distribution licence [including the
GNU Public Licence.]
---- Part 1: CMU/UCD copyright notice: (BSD like) ----Copyright 1989, 1991, 1992 by Carnegie Mellon University
Derivative Work - 1996, 1998-2000
Copyright 1996, 1998-2000 The Regents of the University of California
All Rights Reserved
422
NetClock User Reference Guide
APPENDIX
Permission to use, copy, modify and distribute this software and its documentation for any purpose and
without fee is hereby granted, provided that the above copyright notice appears in all copies and that both
that copyright notice and this permission notice appear in supporting documentation, and that the name of
CMU and The Regents of the University of California not be used in advertising or publicity pertaining to dis
tribution of the software without specific written permission.
CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIM ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL CMU OR THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
RESULTING FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
OR PERFORMANCE OF THIS SOFTWARE.
---- Part 2: Networks Associates Technology, Inc copyright notice (BSD) ----Copyright (c) 2001-2003, Networks Associates Technology, Inc
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met: Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the fol
lowing disclaimer in the documentation and/or other materials provided with the distribution. Neither the
name of the Networks Associates Technology, Inc nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---- Part 3: Cambridge Broadband Ltd. copyright notice (BSD) ----Portions of this code are copyright (c) 2001-2003, Cambridge Broadband Ltd. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met: Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copy
right notice, this list of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution. The name of Cambridge Broadband Ltd. may not be used to endorse or pro
mote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
NetClock User Reference Guide
423
APPENDIX
HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---- Part 4: Sun Microsystems, Inc. copyright notice (BSD) ----Copyright © 2003 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All
rights reserved.
Use is subject to license terms below.
This distribution may include materials developed by third parties. Sun, Sun Microsystems, the Sun logo and
Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met: Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copy
right notice, this list of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution. Neither the name of the Sun Microsystems, Inc. nor the names of its contributors
may be used to endorse or promote products derived from this software without specific prior written per
mission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---- Part 5: Sparta, Inc copyright notice (BSD) ----Copyright (c) 2003-2004, Sparta, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met: Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copy
right notice, this list of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution. Neither the name of the Networks Associates Technology, Inc nor the names of
its contributors may be used to endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
424
NetClock User Reference Guide
APPENDIX
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
This open software is available for at least three years, to give any third party, for a charge no more than
your cost of physically performing source distribution, a complete machine- readable copy of the cor
responding source code, to be distributed under the terms of Sections 1 and 2 above on a medium cus
tomarily used for software interchange.
5.9
List of Tables
Table 3-1: Reference priority titles
Table 3-2: Receiver dynamics, ~modes, ~ dynamics, ~ types
Table 3-3: Estimated Holdover time drifts
Table 3-4: Typical Holdover lengths in seconds
Table 3-5: TFOM è ETE conversion
Table 2-1: Safety symbols used in this document, or on the product
Table 2-2: Subnet mask values
Table 2-3: Required Network information
Table 2-4: Subnet mask values
Table 2-5: Default IP addresses
Table 2-6: System Time Message format
Table 2-7: System Time Message field descriptions
Table 2-8: Signature control output-presence states
Table 5-1: Troubleshooting NetClock, using the front panel Status LED indications
Table 5-2: Troubleshooting network connection issues
Table 5-3: Troubleshooting using the Web UI Status indications
Table 5-4: Troubleshooting 1PPS and/or 10 MHz outputs not being present
Table 5-5: Option Modules available for NetClock 9483
Table 5-6: NENA module specifications
Table 5-7: ASCII RS-232 Output connector pin assignments
Table 5-8: Relay/RS-485 outputs pin assignments
Table 5-9: Option 13 pin assignments
Table 5-10: ASCII RS-485 pin assignment
Table 5-11: Clock class definitions
Table 5-12: Quality indicators
Table 5-13: Available IRIG output signals
Table 5-14: IRIG B control function field
Table 5-15: FAA Time Error Indicators
Table 5-16: IRIG E control function field
NetClock User Reference Guide
157
175
192
193
196
31
52
54
55
59
89
90
137
309
312
314
316
327
328
330
331
342
345
354
377
396
402
405
409
425
APPENDIX
412
9
11
21
22
23
289
302
Table 5-17: Spectracom contact information
Table 1-1: Front panel status indications
Table 1-2: Status indicators, rear panel
Table 1-3: 1PPS Output accuracies
Table 1-4: 10 MHz output — oscillator types and accuracies
Table 1-5: 10 MHz output — oscillator stability
Table 4-1: Factory default facility and priority codes
Table 4-2: Default and recommended configurations
5.10
List of Images
Figure 3-1: How the System Time is derived
Figure 3-2: Host disciplining
Figure 2-1: NetClock front panel
Figure 2-2: IFF Autokey configuration example
Figure 2-3: All NTP Servers are synchronized
Figure 2-4: NTP Server 1 is out of sync
Figure 5-1: Option module navigation
Figure 5-2: Rear plate of NetClock 9483 NENA-compliant module
Figure 5-3: DB-9 connector "J2"
Figure 5-4: RS-485 connector "J3"
Figure 5-5: 1204-06 option module rear plate
Figure 5-6: Option 13 T1/E1 module rear plate
Figure 5-7: Rear panel NetClock Model 9489
Figure 5-8: Model 1204-32 option card rear plate
Figure 5-9: Serial port pin-out
Figure 5-10: IRIG B time code description
Figure 5-11: FAA modified IRIG B
Figure 5-12: IRIG E time code description
Figure 1-1: NetClock 9483 Series Front Panel Display
Figure 1-2: NetClock 9489 Front Panel
Figure 1-3: Keypad menu tree
Figure 1-4: NetClock 9483 rear panel
Figure 1-5: Rear panel of NENA-compliant module (NetClock 9483)
Figure 1-6: Rear panel of NetClock model 9489
Figure 4-1: NetClock front panel
Figure 4-2: Login banner (example)
Figure 4-3: Spectracom TV400 series display clock
426
141
194
41
109
119
119
320
328
329
331
339
341
345
346
363
400
406
408
6
6
8
11
12
12
204
244
246
NetClock User Reference Guide
APPENDIX
248
Figure 4-4: Wiring the RS-485 signal
5.11
Document Revision History
Rev
ECO
Description
Date
A
2698
First-generation of Instruction Manual for the NetClock
9483/9400 Product series
Sept.
2011
B
2827
Added updates that coincide with the release of NetC
lock Model 9489. Additional corrections and document
maintenance.
Jan. 2012
C
2973
Updates coinciding with latest software release and gen
eral document maintenance.
June 2012
D
3019
Updates coinciding with latest software release.
Updated warranty, feature, and specification inform
ation, PTP information sections, adjusted IRIG reference
information sections.
Sept.
2012
E
3103
General updates, enhancements coinciding with latest
software release
Dec.
2012
F
3250
General updates, enhancements coinciding with latest
release: Multi-GNSS, Failover option card, Option
Licensing, NTP update
Jan. 2013
G
3411
General updates to reflect new software release 5.1.2
April
2014
8
multiple
Changes pertaining to A-GPS/Software version 5.1.3
Web UI modifications, V 5.1.4:
Comprehensive overhaul of all existing content.
New content: NTP over Anycast, TimeKeeper, oscillator
disciplining features, option card installation procedure
Changed content: option card reference information,
consolidation of several UI procedures
Errata implementation.
March
2015
NetClock User Reference Guide
427
APPENDIX
Rev
428
ECO
Description
Date
9
0439
Implementation of newly released features under SW
release 5.2.1:
A-GPS Rinex Server functionality, tcpdump functionality,
Show Clock page, as well as minor corrections through
out the manual ("document maintenance").
May
2015
10
0486
Implementation of newly released features under SW
release 5.3.0:
AnyCast IPv6, GNSS receiver SW update, temperature
monitoring, host disciplining
Errata implementation
Aug.
2015
11
0693
Added topic "Temperature Management".
Content modifications under Notification Configuration.
Content modifications under GNSS receiver con
figuration.
Document maintenance and errata implementation.
Dec.
2015
12
DOCUpdates to include changes implemented in the latest soft May
000015 ware version.
2016
Content modifications: GNSS receiver specifications,
NTP throughput specifications; login timeout (new); Eth
ernet monitoring (new); NTP Peer preference; iptables
support (new); language support; NTP Autokey (not sup
ported under 4.2.8p6); configuration of network access
rules; NTP over Anycast: OSPF (changes), BGP (new),
configuration via Expert Mode (new).
12
980
Extensive re-design of Manual architecture and content.
Implementation of new SW features released under SW
V. 5.4.5
Aug.2016
13
DOC41
Document maintenance, errata implementation,
TACACS+ description added, modificaitons of the LDAP
configuration, following SW update V. 5.5.0.
Dec.
2016
NetClock User Reference Guide
INDEX
1
Border
Gateway
(BGP) 122
Browser support 311
Protocol
10 MHz 134
A
A-GPS 188
Access control 56
Access denied 239
Alarm threshold, GPS Notification
Alarm 211
Ancillary kit 29, 34
Anycast
Configuring 119-121
NTP over ... 118
Anycast, Advanced Configuration
via NTP Expert Mode 123
ASCII time code data formats 369
Assisted GPS 188
Authorized keys file 76
B
Battery 147
Battery Backed Time 146
BBC Message Formats 387
BGP
(Border
Gateway
Protocol) 122
NetClock User Reference Guide • INDEX
C
Cable delay 178
Cannot access Unit 239
Certificate, HTTPS 68
Clean and Halt 302
CLI 364
Command-line interpreter 363
Connector, DC power 37
contact, Spectracom 412
Cookies 53
D
Daylight Savings Time 153
DC connector 37
DC power connector 37
default IP address 42
Default IP addresses 59
disable 237
disk status
memory status 310
DNS, primary, secondary 59
DST 153
Duplex, FULL, HALF 257
i
INDEX
E
EMC compliance 25
Emissions
Electro-magnetic compliance 25
enable 237
EndRun Formats 393
Estimated Time Error 195
ETE 195
Ethernet
configuration 55
Expert Mode, Anycast 123
F
FCC compliance 24
Front panel
information display 6
keypad 6
status LEDs 8, 249
Fuse 36
G
GNSS
Connecting 39
GNSS receiver modes 173
GNSS reference, about 172
GSSIP Message Format 392
H
HALT command 205
Holdover 10 , 21 , 86 , 100- 101 , 120122, 126, 134, 137, 146, 156,
161- 162, 190, 194, 197, 200,
207, 209- 210, 251, 262, 279,
ii
308, 310, 312, 314, 316, 318,
352
mode 190
Host disciplining 127, 194
Host keys, SSH 72
HTTPS 62
I
Inaccessible, unit 239
IP address
static 43
IP address, static lease 59
IP addresses, default 59
IPv4 58
IRIG
output accuracy 411
Standards 395
IRIG Carrier Frequencies 396
K
keypad, front panel unlock 315
Keys, host 73
L
LDAP 224
Leap second 149, 356, 375, 377, 379380, 384, 388, 394
license file
applying 295
Local clock 152
Local System Input Reference 160
Locked out, regain access 239
Log entries 310
Logging into the Web UI 53
Login banner 56
NetClock User Reference Guide
INDEX
Login Web UI 53
Logs overview 284
M
Main Screen of Web UI 14
Manual time, setting (User) 143
memory status
disk status 310
MIB files 82
Mobile GNSS receiver mode 174
Mobile mode dynamics 174
Moving, unit 180
N
Netmask 59
Network port, enabling 58
Network services 59
Network setup 55
NMEA 369-370
Notifications 207
NTP 90, 118
autokey 107
Expert Mode 94, 128
Peers 100, 102, 105
Servers 100, 102-103
Setup screen 91
stratum 98
Symmetric Keys 113
time stamp 96
timescale 96
NTP Peer Preference 107
O
Offset 135
NetClock User Reference Guide
Offset, GNSS receiver 178
On-time point 135
Oscillator
accuracies 22
Oscillator configuration 195
OSPF IPv4 120
OSPF IPv6 121
P
Phase 255
Phase error limit 197
Phase Error Limit 197
PLL, external 195
Port, network, enabling 58
Power
connecting 35
consumption 18
DC connector, pin-out 35
Preferred NTP Peer 107
Preferred NTP Server 105
Primary Navigation menu 15
Private keys, SSH 74
PTP
one-step mode 355
two-step mode 355
Public keys, SSH 76
R
RADIUS 230
Real Time Clock 146
Recalibrate oscillator 198
Reference Priorities
Configuring 157
Reference Priority, examples 163
Registration, product 248
iii
INDEX
Regulatory compliance 24
Relocating, GNSS receiver 180
Resetting GNSS receiver position 180
Route, static, add 61
Routes, static 57
S
Safety
instructions
symbols 31
Symbols 31
Sanitization 181
SCP 78
Screen clock 245
Self survey 180
Self survey, GNSS position 180-181
Self survey, GNSS receiver 180
SFTP 78
Shipment, return 412
Show Clock 245
Signature control 136
Single satellite GNSS receiver mode 174
SNMP 79
SNMP traps 79
software version
version number, software 310
Specifications 18
Spectracom Format 371
SSH 70
SSH clients 79
SSH timeout 79
Standard GNSS receiver mode 173
Standards compliance 24
start
getting started 2
Static lease IP address 59
iv
Static Route, add 61
Static Routes 57
Subnet mask values 52, 55
Subnet, default 59
Summer Time 153
Survey, GNSS 173, 176, 180
Symmetric keys 93
Synchronizing Windows computers 249
System on-time point 135
System Time 101, 143
T
TACACS+ 237
TACACS+ Authentication 235
Technical support 411
Temperature 199, 262
operating, range 18
Terminal emulator 363
TFOM 195, 197
Time Figure of Merit 195
Timeout 56
Timeout, Web UI, automatic 239
Troubleshooting 310
U
Unicast 90
unlock keypad 315
Update, software 293
Upgrade, software 293
User time, manually setting 143
Usernames, rules 215
W
Web Interface Settings 240
NetClock User Reference Guide
INDEX
Web UI, opening 52
NetClock User Reference Guide
v
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising