Time Server
Time Server
6000100
Revision D
January 2, 2003
Symmetricom, Inc
Timing, Test, & Measurement Division
3750 Westwind Blvd.
Santa Rosa, Ca. 95403 USA
I declare that the equipment specified above conforms to the above Directives and Standards.
Symmetricom, Inc
Timing, Test, & Measurement Division
3750 Westwind Blvd.
Santa Rosa, Ca. 95403 USA
Electromagnetic Compatibility
89/336/EEC Electromagnetic Compatibility as amended by 92/31/EEC, 93/68/EEC, 98/13/EC
EN55022 (1994) EMC Emissions for ITE, Class A as amended by A1:1995 and A2:1995
EN55024 (1998) EMC Immunity for ITE, Class A
EN61000-3-2 (1995) Harmonic Current Emissions as amended by A1 (1998), A2 (1998)
EN61000-3-3 (1995) Voltage Fluctuation and Flicker Immunity
Note: The TimeVault is compliant with the supplied standard antenna configuration (Model 142-614-XXX).
If the TimeVault is supplied with a Model 142-6150 Antenna, it has its own CE Compliance Certification.
I declare that the equipment specified above conforms to the above Directives and Standards.
I declare that the equipment specified above conforms to the above Directives and Standards.
European Representative:
Company Name and Address
Record TimeVault network configuration for the NET port below, for quick reference.
Users Manual
Documentation Survey
Our Questions Your Answers
Check off the main reasons you consult a manual. General information
How to do certain things
Review, when needed
Emergencies
Other (please list)
When consulting the manual, can you find the informa- not easily very easily
tion you need? 1 2 3 4 5 6
(circle the number that fits)
Can you find the information you need quickly? hard to find quick and easy to find
(circle the number that fits) 1 2 3 4 5 6
Is the manual a useful size for you? much too large just right
(circle the number that fits.) 1 2 3 4 5 6
General Information 1 2 3 4 5 6
(including Specs)
Installation (cabling) 1 2 3 4 5 6
Quick Start Guide 1 2 3 4 5 6
Web/Telnet Access 1 2 3 4 5 6
Keypad Functions 1 2 3 4 5 6
Serial I/O Functions 1 2 3 4 5 6
Error (and other) Messages 1 2 3 4 5 6
Appendix A (NTP) 1 2 3 4 5 6
Appendix B (MD5) 1 2 3 4 5 6
Appendix C
(Time/Daytime Protocols) 1 2 3 4 5 6
Appendix D (SNMP) 1 2 3 4 5 6
Appendix E (ACTS) 1 2 3 4 5 6
Table of Contents 1 2 3 4 5 6
Index 1 2 3 4 5 6
Please also write down any other suggestions for improving this manual:
1 Table of Contents i
2 General Information 1
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview of TimeVault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Limited Warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Limitation Of Liability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Proprietary Notice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Physical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Power Input Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Certifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Internal Timing Performance Specifications . . . . . . . . . . . . . . . . . . . 5
Network Time Protocol Synchronization Specifications . . . . . . . . . 6
Front Panel Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Interface Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
NET Port Ethernet Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Utility Port (RS-232 I/O Interface) . . . . . . . . . . . . . . . . . . . . . . . 8
ACTS Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Remote Operation 31
Web Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Starting the Web Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Accessing TimeVaults Web Pages . . . . . . . . . . . . . . . . . . . . . . 32
Configuration Control Login Page . . . . . . . . . . . . . . . . . . . . . . 33
Remote Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Leaving the Control Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Leaving the Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Telnet Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Starting Telnet and Making a Connection . . . . . . . . . . . . . . . . . 40
Ending Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Serial Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Serial Line Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
HyperTerminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Session Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Utility Port Session Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Telnet Session Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Web Control Session Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6 TimeVault-Generated Messages 87
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
LED System Status Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Solid Red/Solid Orange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Informational Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Index
This manual provides you with all of the information necessary to properly install and
operate the TimeVault Time Server (hereafter referred to as TimeVault). Optimization
for time functionality means that accurate position readouts are not available. The
information in this manual includes any normal maintenance and adjustment data that may
be required to facilitate field repairs.
1.1 Conventions
<Key> = For input, referring to keys that are labeled on your keyboard.
For example, <Enter> means press the Enter key for a line
terminator; <SP> means press the spacebar to enter a space.
KEYPAD PUSH
BUTTONS = Used to indicate push-buttons on the unit: Press SAVE
Bold = Used to show messages, prompts, menus, items in selection
lists, etc., that appear on a computer screen and require action
on your part. For example, Press the Submit Changes button.
text = Used to display output character strings.
text = Used to indicate text you should enter with your keyboard,
exactly as printed.
By purchasing any product from Symmetricom, the Buyer consents to and agrees that the
Buyer's sole and exclusive remedy for any damages or losses incurred by the Buyer, as a
result of Symmetricom's breach of its one-year Limited Warranty for defects in materials
and workmanship or otherwise in connection with any claim respecting the product, shall
be limited to the repair or replacement of the product or a refund of the sales price of the
product.
In no event shall the Buyer be entitled to recover consequential damages or any other
damages of any kind or description whatsoever.
TimeVault fits in a standard 1U (1.75-inch [4.445-cm]) high, 19-inch (48.26 cm) rack
mount package (see page 2-11 for mounting instructions) and has the following physical
specifications:
TimeVault Chassis, with rails and handles
Standard Antenna
Type: RG-59
Attenuation at 1575.42 MHz should be no more than 10.5 dB per
100 feet (Belden 9104 or equivalent)
TimeVault requires a 12 V antenna and may severely damage any antenna that does not
support 12 V. For non-standard antenna types, contact Symmetricom for assistance.
Storage Temperature
Operating Humidity
Storage Humidity
Operating Altitude
Storage Altitude
48 VDC 36 to 60 VDC
(optional): 4 position Barrier Strip Connection
Fuse: 1A Slow-Blow (rear panel)
1.9 Certifications
FCC
CE (applies to base model only)
UL (applies to base model only)
The timing accuracy achievable with this product depends on several factors. The most
important is the method TimeVault employs to use the NTP information. It is widely
accepted that the uncertainty of any single NTP packet is on the order of 10 ms. However,
most NTP client programs perform averaging and filtering over several NTP transfers,
improving the accuracy and removing the systematic delays. The performance of the
various NTP clients varies widely, but some are able to achieve accuracies below 1 ms.
Inherent accuracy:
With GPS synchronization, approximately 125 s (this accuracy exceeds that which
the NTP protocol delivers over a network)
With ACTS synchronization, 5 ms.
In this case, the system accuracy is limited to the accuracy of the ACTS input.
With NTP client mode synchronization, the accuracy of the client software is the
limiting factor in determining the delivered time accuracy.
Accuracy of packet delivery time to network jack: <0.5 ms
MD5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .RFC-1321
SNTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .RFC-2030
HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RFC-2068 and 2616
DHCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .RFC-2132
* SMI = Structure of Management Information
** TimeVault does not implement the authenticator field of the NTP packet as
described in Appendix C of RFC-1305.
Complete RFC information is available at http://www.ietf.org/
An NTP or SNTP client, compatible with the computer platform you use and configured
to use TimeVaults NET Port IP address, is required for accurate network
synchronization. In this manual, refer to Appendix A and Appendix B for details about
NTP and SNTP protocols, and Appendix D for details about SNMP and MIB.
Note: A number of NTP-related programs, such as NTPDC and NTPQ, are not
supported, in the conventional sense, by Dr. Mills NTP, and therefore cannot be
supported by Symmetricom, Inc. (TrueTime, Inc. is now Symmetricom, Inc.). The user of
these programs does so at his or her own risk.
This section provides a general description of TimeVaults front panel input devices. For
details about how to enter commands and interpret display readouts, see Overview and
Format on page 4-49.
TimeVaults front panel is your primary interface with the system. Input is through six
keypad buttons (four directional, SET-UP and SAVE). Output is through the two-line,
20-character alphanumeric display (see Figure 1-1, below). The letter at the end of the
output date line indicates the synchronization source in use (G for GPS, A for ACTS and N
for NTP).
Two front panel mounted, tri-color LEDs reflect the status of TimeVault. The system
status indicator at the left end of the front panel has five different displays:
If the System Status Displays... It Means...
Possible causes and solutions for problems resulting in a solid red or solid orange display
are discussed in LED System Status Alerts on page 5-89.
The connection active indicator, labeled ACT and located to the right of the NET Ports
RJ-45 plug, indicates the connection speed on the NET Port.
Alphanumeric
NET Port Serial I/O Display SET-UP and SAVE Push-Button
Telnet HTTP
DHCP SNTP
TCP/IP SNMP
TFTP or FTP NTP and Broadcast NTP
The following chart shows pin assignments for the RS-232 connector:
Table 1-1 RS-232 Interface Pin Assignments
Pin Assignment
1 NC
2 RXD
3 TXD
4 NC
5 GND
6-9 NC
The ACTS modem requires a separate analog phone line. See Appendix E, Automated
Computer Time Service (ACTS), for more information about ACTS.
To securely mount TimeVault in any EIA standard 19-inch (48.26-cm) rack system, use
the equipment supplied in Symmetricoms Rack Mount Kit and follow the steps outlined
below.
The Rack Mount Kit contains:
2 mounting brackets (part number 206-719)
4 flat-head, Phillips screws (part number 241-008-005, 8-32 x 5/8)
To rack mount TimeVault:
1. Remove and discard the two factory-installed flat head (Phillips) screws from the front
end of a TimeVault side panel.
2. Place a rack mount bracket on the side panel, so that the countersunk screw holes in
the bracket line up with the screw holes in the panel.
3. Place 2 flat-head Phillips screws from the Rack Mount Kit through the holes in the
bracket and into TimeVault.
6. Place TimeVault in a 1 in (4.445 cm) opening in any EIA Standard 19-in rack sys-
tem, and position the unit so that the rack holes line up with the holes in the bracket.
TimeVault requires a 12 V antenna and may severely damage any antenna that does not support
12 V. For non-standard antenna types, contact Symmetricom for assistance.
Optionally, you can add an RS-232 serial interface for local control using a terminal
emulation program. This requires:
A serial interface device, either PC or dumb terminal capable of 9600 8N1
An RS-232 cable, and null modem connector, to connect the 9-pin D RS-232 port to
the serial device
TimeVault is capable of basic operation without an RS-232 connection, and retains all
configuration data in memory.
To run multiple units with a single 12 V antenna, use a splitter. Do not use a BNC T
connector, which doesnt provide the proper voltage the unit needs to operate.
Lead-In Cable
The L1 GPS antenna is designed to operate with up to 200 ft (60.96 m) of RG-59 coax
cable. The optional Down/Up Converter is designed to operate with up to 1,500 ft
(457.2 m) of RG-58 coaxial cable. For details and illustrations on cabling, see page 2-15.
When selecting a site for the standard outdoor antenna, find an outdoor location that
provides full 360-degree visibility of the horizon. In most cases, this means locating the
antenna as high as possible. Any obstruction will degrade unit performance by blocking
the satellite signal or causing a reflection that cancels some of the signal. Blocked signals
can significantly increase the time for satellite acquisition, or prevent acquisition all
together.
Mast Mounting
Mast top mounting is the preferred mounting method and
special brackets are provided to mount the antenna to a pipe or
the peak of a building. The antenna mounting mast should be
2-inch (5.08-cm) water pipe or conduit. The mast must be rigid
12 V GPS
and able to withstand high winds without flexing. Guy wires Antenna
may be used to stabilize a mast longer than 10 ft (3.048 m)
Multipath cancellation is caused by reflected signals that
arrive at the antenna out of phase with the direct signal.
Reflective interference is most pronounced at low elevation Mast
Note: Regardless of orientation, use the window with the best view of the sky.
Mount the antenna on the lower part of the window, where it has the best upward
visibility, by pressing the suction cup onto the window. Make sure the window and suction
cup surfaces are clean. Note that some windows have metallic glazing that blocks GPS
signals: this prevents GPS receivers from tracking satellites and determining the time.
B e s t W in d o w
12:00 NOON
2.2 Cabling
Refer to the figures below for TimeVault connector locations. The numbers in the
drawing refer to that connectors position in Table 2-1.
Connect the cables in the order listed in Table 2-1 below. In order to avoid network addressing
conflicts, be sure to configure network parameters before connecting the Ethernet cable.
100-240 VAC Power Input (4) Chassis Ground (3) ACTS Modem (2) 12 V Antenna (1)
36 to 60 VDC Terminal Strip (4) Chassis Ground (3) ACTS Modem (2) 12 V Antenna (1)
For the 48 VDC model, connect the rear panel chassis ground to your system ground, the
positive connection from the power supply to the + of the rear panel terminal strip, and
the negative connection from the power supply to the of the rear panel terminal strip.
Stop cabling at this point, enter network parameters as per Section 2.5 NET Port Network Parameters:
First Time Configuration on page 2-28, then resume cabling with Step 5.
2.3 Power-Up
System software initialization takes about 18 seconds, after which the display reads:
Software
Load Successful
Display initialization takes another 12 seconds, after which all synchronization modes
GPS, ACTS, and NTP simultaneously attempt to acquire and lock to their respective
sources. When display initialization is complete, you can enter data through TimeVaults
front panel keypad or serial/Telnet interface. Once TimeVault has synchronized itself,
then it is ready to respond to time requests it receives over the network through supported
protocols.
To avoid unnecessary long distance charges, TimeVault will not call out to ACTS if a higher
priority synchronization source is operational.
Consider the GPS mode operational once TimeVault tracks at least four satellites and
receives ephemeris, ionospheric, and leap seconds data from each. The process of satellite
acquisition is described below.
Once TimeVault starts searching for GPS satellites, the display reads:
Searching for
Satellites
Satellite acquisition may take up to 20 minutes. Display messages indicate the sequence,
such as:
Satellites
Tracked = 1
Satellite Acquisition
Satellite acquisition begins at power-up and continues until power-down. The length of
satellite acquisition time depends on many factors, some of which are described below.
When TimeVault performs initial acquisition of GPS satellite data, it listens for all
available GPS signals. After three satellites are acquired, the receiver locks onto GPS as a
reference source, and delivers UTC time. This procedure takes from 3 to 20 minutes,
depending upon current satellite visibility. Longer aquisition times may be needed for
window mounted GPS antennas that have very poor visibility.
After initial acquisition, and the TimeVault has saved its current average position, and
recent ephemeris/almanac information, it can typically lock to GPS as a reference source
in 3 to 5 minutes. The TimeVault needs an intermittent fix on three satellelites several
times per day in order to maintain current position/ephemeris/almanac information.
Provided with current position/ephemeris/almanac information, the TimeVault can
maintain GPS as its reference source by tracking only one satellite. If the number of GPS
satellites being tracked drops to zero, the unit remains locked GPS as a reference source
for approximately 5 minutes while it attempts to re-acquire another GPS satellite.
Because the TimeVault is optimized for time functionality, accurate position readouts are
not available.
If the current position is unknown or in error by more than 1 km (0.62 miles), acquisition
typically requires from 3 to 20 additional minutes to locate current antenna position,
reacquire satellite almanac and ephemeris data, and deliver UTC time.
Requires continuous lock on four satellite Requires intermittent fix from three satel-
signals to maintain GPS as the reference lite signals (several times a day). Will
source. hold lock on one satellite signal to main-
tain GPS as the reference source.
Operates with roof mounted antennas. Operates with window and roof mounted
antennas.
If the number of current satellite signals If the number of satellite signals drops to
drops to 1 or 2, the unit uses GPS as refer- zero, the unit keeps GPS as the reference
ence source for 10 minutes. source for 5 minutes while it locks onto
another GPS satellite signal.
Consider the ACTS mode operational once TimeVault has successfully dialed out to the
ACTS service and received time (see Appendix E for details).
TimeVaults NTP subsystem can be either a server to downstream clocks in the system, or
a client to another NTP server. After display initialization, TimeVault begins requesting
time through NTP from a user-defined server list. TimeVault polls each server in turn
until it receives a valid NTP response. Consider the NTP client mode operational once
TimeVault receives six valid NTP responses from at least one NTP server from the list.
This may take 8-10 minutes.
TimeVault only enters NTP mode if both GPS and ACTS are not operational.
Operational Non-Operational
GPS TimeVault has tracked at least four TimeVault has either not been able to
satellites during the preceding 15 minutes, track at least four satellites during the
and has received numerically consistent preceding 15 minutes, or has tracked at
date/time from them for the preceding least four satellites but has not received
15 minutes numerically consistent date/time for the
preceding 15 minutes
ACTS TimeVaults ACTS modem has detected TimeVaults ACTS modem has not
dial tone when off-hook, has successfully detected dial tone when off-hook, has not
reached ACTS, and has received time been able to reach ACTS in the preceding
update 15 minutes, or has reached ACTS but has
not received a time update since the last
ACTS service
NTP TimeVault has received a response from TimeVault has not received any NTP data
at least one of the NTP servers on the packet response from any of the NTP
user-designated server list, and has servers of the user-designated server list
received six valid NTP packet time for the preceding 15 minutes.
responses from it during the preceding
15 minutes
During this procedure, TimeVaults front panel display alternates between an initializing
message and notification of which satellites have been newly acquired. NTP stabilization
usually takes place between acquisition of the 5th and 6th satellites.
During NTP stabilization, the display reads:
Initializing
TimeVault...
Satellites
Tracked = X
where:
X = the number of the next satellite TimeVault acquires.
Once stabilized, NTP displays UTC time and the current date on the front panel display in
the following default format:
UTC: DDD;HH:MM:SS
ddd<SP>mmm<SP>nn<SP>yyyy...
where:
DDD = day of year
HH = hour
MM = minutes
SS = seconds
ddd = day of the week (abbreviations are: Sun, Mon, Tue,
Wed, Thurs, Fri, Sat
mmm = month (abbreviations are: Jan, Feb, Mar, Apr, May,
Jun, Jul, Aug, Sep, Oct, Nov, Dec)
nn = day of month
yyyy = year
Start-Up GPS
Secondary Good
Primary Good
ACTS
Tertiary Good
NTP
Although TimeVault is not designed to resist a denial of service attack from a hostile source, an
excessive number of NTP requests in a short period of time will not cause the system to crash or
lock up.
The TimeVault front panel provides input through 6 keypad push-buttons (four directional
keys, SET-UP, and SAVE), and output through the two-line, 32-character alphanumeric
LCD. The letter at the end of the output date line indicates the synchronization source in
use (G for GPS, A for ACTS and N for NTP).
Use the keypad for initial system configuration (see page 2-28).
Current UTC Date and Time (in real Normal Operation Default*
time, as illustrated above) *If another display is active
during normal operation,
press SET-UP repeatedly
until the UTC display
appears
Unless you press SAVE after entering data, your entries will be lost.
The values illustrated below are examples only. If you are ready to configure TimeVault for
the first time, go now to Section 2.5 NET Port Network Parameters: First Time
Configuration on page 2-28.
1. IP Address.
An example of the display is:
255.054.000.034
IP ADDRESS
2. Subnet Mask.
An example of the display is:
255.054.000.034
SUBNET MASK
3. Default Gateway.
An example of the display is:
255.054.000.034
DEFAULT GATEWAY
4. DHCP.
An example of the display is:
DHCP Status
OFF
5. Remote Control.
An example of the display is:
Remote Control
Unlocked
6. Display Security.
An example of the display is:
Display Security
OFF
Display Security
Logout
Whenever you save changes to any network parameter in this sequence, TimeVault
automatically reboots (this does not include the DHCP, Remote Control, and Display
Security functions).
The Remote Control feature determines the availability of remote access to TimeVault.
The default setting is Unlocked, which allows use of the Telnet or web interface for
set-up and control operations (see Chapter 3 for how to set up Telnet, and Chapter 4 for
how to issue F-series function commands). You can lock TimeVault from a remote
location using the F100 LOCK command, but after having done so, you can not remotely
unlock it. You can only unlock TimeVault from the keypad. For more information, see
Keypad Entry Guidelines above, and Section 4.4.13 F100 LOCK Remote Lockout
on page 4-76.
The Display Security feature prevents unauthorized users from setting or modifying
TimeVault parameters. When you first receive the unit, the security setting is off (factory
default).
To view the current security setting, scroll through the parameter list using the SET-UP
push-button until Display Security appears. To enable Display Security, press any
directional push-button. The security setting changes from OFF to ON. You can now
enter your user ID and password, as per the procedure described below.
Once you enable the Display Security feature, it remains ON until you manually disable it.
Enter user IDs and passwords with the front panel directional push-buttons, as follows:
Press the directional push-button to start at the letter i and move backwards
through the alphabet, symbols and numbers.
Press the directional push-button to start at the letter r and move forward
through the alphabet, symbols and numbers.
Press the or directional push-buttons to reposition the cursor. During
password entry, pressing the directional push-button not only advances the
cursor position, but also changes the previously entered character to a *. If you
make an incorrect entry, reposition the cursor and re-enter the character.
To enter the user ID and password, follow these steps:
1. Press the SET-UP push-button until ID:/Password: appears, with the cursor posi-
tioned on the ID: line (the SET-UP push-button toggles cursor position between the
two lines).
Further Precautions
After 10 minutes without any front panel push-button activity, TimeVault automatically
times out the security feature. You must re-enter user ID and password to review or
modify system parameters through the front panel alphanumeric display.
However, under circumstances when you must protect TimeVault before the 10-minute
time out, you can do this manually with the Display Security Logout feature.
To manually logout of Display Security:
1. Press the SET-UP push-button to scroll through the parameter list until
Display Security Logout appears.
2. Press the SAVE push-button.
The default UTC time and date display appears.
After logging out, you must re-enter the user ID and password to review or modify system
parameters through the front panel alphanumeric display.
Disabling Security
The Display Security feature remains ON until you manually disable it. To disable the
Display Security feature:
1. Press the SET-UP push-button until Display Security appears.
2. Press any directional push-button to change the security setting from ON to OFF.
3. Press the SAVE push-button.
The default UTC time and date display appears, and system parameters can now be
reviewed or modified by anyone.
After connecting the GPS antenna, supplying power to TimeVault, and achieving
successful stabilization, stop cabling and configure the network parameters and functions
for the first time. Then connect the Ethernet cable and, optionally, the serial cable.
Observing this order of events ensures that the IP Address is correct and sets operating
speed at 10Base-T.
To change the maximum operating speed to negotiate between 10/100Base-T on networks
that support the higher speed, see Step 9 below.
The configurable NET Port network parameters and functions are:
Display Security
IP Address
Subnet Mask
Default Gateway
DHCP
Remote Control
Upon arrival, TimeVaults Display Security feature is off (factory default), and you can set
parameters according to the procedure below, without entering or using a user ID or
password. If you wish to secure the front panel display first, follow the steps on page 2-26
in the section Entering the User ID and Password.
For the first configuration, enter the appropriate parameter values and function settings
through the front panel keypad. Optionally, you could use the serial port (referred to in
this manual as the Utility Port) through a serial device connected at 9600 8N1.
Subsequently, you can edit parameter values and function settings through the keypad, the
web interface, the Utility Port, or using Telnet (see Section 4.4 Extended Function
Commands on page 4-59).
To set the NET Port network parameter values and function settings for the first time:
1. Press the SET-UP push-button to display the IP Address.
2. Position the cursor under the digit you want to change using the and buttons.
3. Increase or decrease the value with the or buttons.
4. Press the SAVE push-button to store the new values and proceed to the next screen.
If you do not press SAVE, your entry will be lost.
5. Use Steps 2 4 above to set and store a new Subnet Mask value.
6. Use Steps 2 4 above to set and store a new Default Gateway value.
7. Review the current DHCP function setting, then use Steps 3 4 above to set and store
a new DHCP setting, if appropriate (see DHCP Configuration before changing this
setting).
The directional push-buttons toggle between setting options.
8. Review the current Remote Control function setting, then use Steps 3 4 above to set
and store a new setting.
The directional push-buttons toggle between setting options.
The easiest way to configure the network parameters is via Dynamic Host Configuration
Protocol (DHCP). If your network has a DHCP server installed (check with your system
administrator), you can use this service to set up your TimeVault. The TimeVault is
shipped with DHCP turned off. To enable DHCP, use the following procedure:
1. Press the SETUP button several times until the message DHCP status OFF is displayed.
2. Use the and buttons to turn DHCP on.
3. Press the SAVE button to store the new setting.
4. Press SAVE again to scroll through the remaining messages.
5. The TimeVault will then reset itself. During the boot process, it will request network
settings from the DHCP server, and then will be available on the network.
6. Press the SETUP button to find the assigned IP address. Then go to the section
Verify Functionality to verify the operation of the TimeVault.
When the LAN interfaces are operational and time is being reported, the unit has achieved
its basic level of functionality. For quick start information, see the Quick Start card that
came packaged with this manual. For remote operation, see Chapter 3. For details on
serial/Telnet commands, see Chapter 4.
If you wish to configure NTP client mode, or to use SNMP (TimeVault supports a SNMP
version 1 agent with the MIB II and Enterprise MIB databases), you must first edit the
ntp.conf and snmp.conf files (see Section 4.4.12 F100 CONFIG FTP Configuration of
NTP, SNMP & ACTS Parameters on page 4-67 for details).
Symmetricoms TimeVault is an advanced time server that provides trusted, accurate time
from multiple time sources over an Ethernet connection to multiple client sites. One of
TimeVaults great strengths is its remote control capability. You can configure
parameters through command line input using Telnet from a distant terminal, or use
TimeVaults web interface to program the unit over the Internet, from anywhere in the
world.
TimeVault reports time with extreme accuracy, using GPS as a synchronization source.
Optimization for time functionality means that accurate position readouts are not
available.
The main feature of TimeVaults web interface is its ability to perform setup and control
operations from a remote location, using the Internet or TCP/IP LAN. The protocol used
is either Telnet or HTTP. Telnet is a standard Internet communications program that is
bundled with Windows 95/98/NT and connects to TimeVault through its NET Port.
HTTP access is provided via any standard Web Browser (such as Microsofts Internet
Explorer or Netscapes Navigator/Communicator).
You can also disable remote control capability and secure TimeVault from a remote
location, (see F100 LOCK Remote Lockout on page 4-76). However, once you have
issued this command, you can not remotely unlock the unit. You can only unlock the unit
from the keypad.
To use the web interface, launch any Java-capable and frames-compatible web browser
such as Microsoft Internet Explorer (IE version 3.0 or later, available at
www.microsoft.com), Netscape Navigator (version 3.0 or later) or Netscape
Communicator (any version; Netscape browsers are available at www.netscape.com).
In the Location field (Netscape), the Address: field (IE), or the equivalent field in the
window of a different web browser, enter the IP address assigned to TimeVaults NET Port
in the following format:
http://<ipaddress>
An example of an TimeVaults NET Port IP address is:
http://192.168.1.1
After entering the NET Port IP address, Symmetricoms home page appears in the browser
window. The Home page, which always displays UTC time and date, as well as the
current clock source, is your access to all the other web pages. For future quick access,
you can bookmark the Home page (in Netscape), or add it to your browser favorites (in
IE). Use the buttons that always appear in the left portion of the Symmetricom web
interface window to navigate from page to page.
The following list shows all the available web pages and how to find them. An
indentation means you get to that particular page from the page just above it. For
example, you reach the Satellite Status page from the GPS Status page:
Home (links to...)
Time Status (click Time)
GPS Status (click GPS; links to...)
Satellite Status
ACTS Status (click ACTS)
Network Status (click Network)
Configuration Control Login (click Controls; links to...)
Time Control
GPS Control
Satellite Control
ACTS Control
Network Control (links to...)
NTP Configuration (links to...)
SNMP Configuration
MD5 Keys
View NTP Log
SNMP Configuration (links back to...)
NTP Configuration
Home
All values displayed on these pages are static, that is, they do not reflect changes that
occurred following the initial display of the page. For example, the current clock source
and UTC time and date, which always appear on the Home and Time Status pages, are
frozen at the instant the web page first displayed and do not automatically update. For the
most recent values, click Reload or Refresh on the tool bar at the top of your web
browser, or right click the area around the parameter display and select Reload Frame or
Refresh from the menu that appears.
Accessed from the Home page (click Controls), the Configuration Control Login page
is your gateway to remote query and configuration of TimeVault. After successfully
logging in, when you display this page, or any of the control pages, navigation buttons for
all control pages appear at the left of the window.
After any reset, do not submit further parameter changes until the unit fully reinitializes, that
is, until you see the correct time and date on the front panel display.
To log in, enter the user name operator (you will not be able to edit parameters if you
log in any other way) and the default password mercury in the corresponding fields on
this page, then click Press to Continue, located just below the password box. The page
instantly refreshes. Look in the Status Message Window for the Login passed.
message to see whether or not the login was successful (you may have to scroll down to
see it). If the Status Message Window shows that login failed, re-enter the user name and
default password and click Press to Continue again.
As with all password protection, to ensure security, please change the default password as soon
as possible using the F100 P command (see page 4-64). Password changes can only be made
using the serial or Telnet interface. Maximum password size is 10 characters.
Once you have logged in from the Configuration Control Login page, you can edit
TimeVault parameters. To edit ACTS parameters, go to the ACTS Control page. To edit
NTP or SNMP parameters, go to the Network Control page and click either NTP
Configuration or SNMP Configuration to reach their respective remote control pages.
where:
number = the ACTS telephone number, including area code;
this example shows the NIST service in Boulder,
CO, U.S.A.
line = access digit for an outside dial tone
inter = prefix for international and long distance service (up
to 9-digits)
type = tone or pulse dialing
retry = number of times the modem tries to reach ACTS
timeout = after sending a command to the modem, the time
interval, in seconds, that TimeVault waits for a
modem response before timing out
duration = duration, in seconds, of a single ACTS session,
starting after the modem detects a carrier
delay = reserved for factory calibration only; do not change
period = time interval, in minutes, between call attempts
flag = set to ON by default; do not change
speed = baud rate, set to 9600 by default; reserved for
factory calibration only; do not change
fudge = reserved for factory calibration only; do not change
pollcounter = determines time precision vs. risk of unsuccessful
call; reserved for factory calibration only; do not
change
center = calibration of the phone line; reserved for factory
calibration only; do not change
modemInit = modem initialization string; reserved for factory
calibration only; do not change
3. Edit the file.
4. Press <Enter> or click Submit Changes just below the display of parameter values.
TimeVault takes a moment to reset, during which time the parameter display goes
blank. When TimeVault starts up again, the new parameters are in place. If the unit
does not reset, check the status message to see why, re-enter the values, then click
Submit Changes again.
# Uncommenting the line below enables NTP broadcast mode with MD5 using key 1.
# The key is optional and adds security. If a key is used a corresponding
# key entry must appear in the NTP keys file. A maximum of 20 keys can be
# defined on this line.
#
#broadcast 192.168.1.255 key 1
# The line below defines current trusted keys. See the NTP keys file for
# the keys and corresponding key numbers. Keys 1 and 2 are listed for example.
# All keys listed must appear in the NTP keys file. Note remember to change
# keys regularly. A maximum of 20 trusted keys can be defined on this line.
#
trustedkey 1 2
#Id M Value
#---- --- --------
1 M Symmetricom
2 M TTnts200
where 1 and 2 are key identifiers (for maximum security, use a unique combination of
32 letters and numbers for each key identifier).
If the window is empty, be sure you logged in correctly (the keys file is password protected),
then, if it is still empty, click Reload or Refresh at the top of your web browser tool bar to reload
the page.
For correct configuration, do not use zero as a key identifier. Zero means the key identification
will not be used.
If the window is empty, be sure you logged in correctly (the SNMP file is password protected),
then click Reload or Refresh at the top of your web browser tool bar to reload the page.
Community Names
Access: W for read/write (R = read only)
IP Addresses
4. Click Submit Changes, located just below the display of parameter values.
TimeVault takes a moment to reset, during which time the parameter display goes
blank. When TimeVault starts up again, the new parameters are in place. If the unit
does not reset, check the status message to see why, re-enter the values, then click
Submit Changes again.
The control session, activated with a successful login, ends under the following
circumstances:
Inactivity: no page navigation or submission of changes in the last three minutes.
Location change: navigation to a status page or the home page.
If inadvertently logged out, navigate to the Configuration Control Login page (by
clicking Controls at the left of the window) from the home page or any status page, then
log in again (see page 3-33).
To terminate the web interface, exit your web browser, or enter a new Internet address.
TimeVault can perform setup and control operations sent from a remote location through
the Internet. The protocol used for Internet access to TimeVault is Telnet, a standard
Internet communications program, with an ASCII character-based interface, that is
bundled with Windows 95/98/NT and connects to TimeVaults NET Port. Use Telnet just
like Procomm, or any other serial interface program, by entering F-series commands, to
which TimeVault responds.
The Utility Port takes precedence over the Telnet session. If the Utility Port is active,
either Telnet login will fail or, if already logged in, trying to send any Telnet command
generates the response:
NOTICE: Cannot respond to command because Utility Port
session has priority.
Telnet sessions have a 15 minute session timer. If there is no activity on the Telnet
session, the timer automatically terminates the session.
1. Press Start on the task bar in the lower left corner of your screen.
3. Click OK.
The Telnet (None) window appears:
4. Click Connect, the first item on the Telnet menu bar, then select Remote System.
The Connect dialog box appears:
If an hourglass appears instead, it means the connection was not successful and
you should repeat steps 1-5.
8. Enter the default password truetime (one word, all lower case).
A welcome message appears if the login and password are approved:
The RS-232 connector provides serial access. The RS-232 connector is located between
the NET Port and the front panel display (see Figure 1-1 on page 1-7). This connector is
labeled Serial I/O, and is referred to as the Utility Port. Table 3-1 below describes the
Utility Ports RS-232 pinouts and signal levels.
Serial I/O settings are factory set and cannot be changed. The default serial format is:
Data Rates: 9600 bits/second
Word Length: 8 bits
Parity: None
Stop Bits: 1
The Utility Port can be connected either to a terminal or to a computer, using a null
modem cable, and used in conjunction with any serial access (terminal emulation)
software program, such as Procomm or HyperTerminal. The following section illustrates
a terminal connection, using HyperTerminal, a popular Windows-based application. All
commands are input using conventional F-series type commands (see Command List on
page 4-51).
These examples apply only to systems using Windows 95/98/NT. Check with your System
Administrator if you are using a different operating system (such as Macintosh or UNIX).
3.3.2 HyperTerminal
Starting HyperTerminal
To start HyperTerminal:
1. Click Start on the task bar in the lower left corner of your screen.
3. Enter a name (in this example, we have used NTS) for this connection in the
Name box and click OK.
The Connect To dialog box appears:
4. In the Connect using box, use the drop-down menu to select your modems Com
port (COM1 in this example), then click OK.
The COM1 Properties dialog box appears, showing the Port Settings tab:
6. Click OK.
TimeVaults HyperTerminal window appears, indicating that TimeVault is now
connected through the Utility Port:
2. Select the Settings tab and click the Terminal keys radio button:
3. In the Emulation box, use the drop-down menu to select VT100 terminal type (do
not select the Auto detect option).
4. Click Terminal Setup and configure the terminal by selecting the appropriate
options in the Terminal Settings dialog box (with a VT100 terminal, the
recommended settings are pictured below):
5. Click OK.
TimeVaults Properties dialog box is reactivated.
8. Click OK.
This returns you to TimeVaults Properties dialog box.
9. Click OK.
This returns you to your HyperTerminal session window, where you can enter
F series commands. Press the Return key to get a > prompt.
10. When exiting HyperTerminal, click Yes when prompted to save the current
session:
The next time you launch HyperTerminal from the Start menu, you can reconnect to
the session you just created.
There are timers on Utility Port, Telnet, and web control sessions that terminate them if
there is a lack of activity. Any action you take during a session automatically resets the
timer, and it starts all over again. The timers and their interactions are described below.
The Utility Port Session Timer starts upon receipt of a character from the Utility Port. The
timer is reset upon receipt of every character. If no characters are received for 15
consecutive minutes, the session terminates.
When a Utility Port Session is in progress, Telnet cannot execute any commands to
TimeVault. The Utility Port Session must end before full Telnet access is possible.
The Telnet Session Timer starts upon receipt of a command line from Telnet, via the NET
Port. The timer is reset upon receipt of every command line. If no lines are received for
15 consecutive minutes, the session terminates.
Terminating a Telnet session drops the connection to the remote host. You can
immediately activate a new session by re-connecting and logging in again.
Once you are logged in to any Control Page, you can send HTTP requests from a web
browser, via the NET Port. The Web Control Session Timer starts as soon as it receives
such a request. The timer is reset upon receipt of every HTTP request. If no HTTP
requests are received for five consecutive minutes, the session terminates.
Terminating a Web Control session causes TimeVault to deny any further requests you
make for changes. You can immediately activate a new session by logging in again.
Shortly after power-up, the utility port will be ready to receive commands. To ensure the
unit receives data input accurately, wait until the message Searching for
Satellites... has been on the front panel before entering any serial or Telnet
commands.
You can send data to, or request data from, the unit by sending serial or Telnet commands
using ASCII character strings. The general form of these commands is:
F<FUNC#><Enter>
where:
F = ASCII character F
<FUNC#> = two-digit function number
<Enter> = input line terminator
More specifically, the data input and output formats are:
F<FUNC#>[<SP><FIELD>]<Enter> (input)
or
F<FUNC#>[<SP><FIELD>]<CR><LF> (output)
where:
F = ASCII character F
<FUNC#> = function number
<SP> = space
<FIELD> = data entry or request
<CR><LF> = output line terminator
[] = encloses a phrase that is repeated as often as
necessary
Output strings are kept to fixed lengths whenever possible. This means that numeric
values often contain many leading blanks. This users guide represents output strings in a
fixed font. For example:
F60 prn 14 good enabled sig level= +21.37<CR><LF>
The formats of the output strings are designed so that it is possible to request the state of a
function and save the response string. Later that string can be sent to the unit to restore the
original state of that function.
Input strings sent to the unit may vary in length. The manual represents what you should
type in the same fixed font, with a bold typeface. It represents the necessary keyboard
action differently, however, as per the manual conventions (page 1-1). For example:
F03<Enter>
The number of separators between fields may vary. You can enter numeric values with or
without leading zeros. When entering positive quantities, you can omit the plus sign.
String fields (such as on or off) may be entered in upper or lower case, as can the F
that starts all serial or Telnet commands. Some fields of some commands are optional and
may be replaced by a semicolon. In that case, the corresponding value is unchanged.
End all input strings by pressing the <Enter> or <Return> key on your keyboard.
An incorrect entry may result in an error message, as described in Error Messages on
page 5-87. The unit responds to correct entries with:
OK<CR><LF>
In addition to the regular F-series commands, there is also a set of F100 commands,
known collectively as Extended Function Commands. With certain F100 commands, you
can reconfigure network parameters, such as IP Address, or modify function settings like
Remote Lockout. These commands include F100 BASET, IP / SM / G / CONFIG (set
commands) / DHCP and LOCK. Changes to any of these settings, except F100 LOCK,
cause the unit to reset automatically.
After making changes to values in any of these parameters/functions, a confirmation
prompt appears (Are you sure?). For safety, the default response to this prompt is
negative. The unit will not execute the command unless you respond affirmatively by
entering the letter y within 10 seconds. Within that time period, any other response,
including no response, results in the unit canceling the command.
The following table lists all serial/Telnet commands that are used to operate, administer,
and maintain the unit. The Utility Port is ready to receive these commands once the
power-up sequence is complete. The F100 series is used mainly to request or set unit NET
Port parameters. Configuration of the IP Address, Subnet Mask, Default Gateway, and
DHCP parameters is also available through the front panel keypad. Changing any
network parameter causes the unit to reboot.
Use the front panel keypad to set initial system configuration values at first installation.
F100 CONFIG NTP, SNMP and ACTS Configuration GET , SET, NTP, SNMP, ACTS, IP
ADDRESS, YES, NO, W, R
(change requires confirmation within 10 seconds)
Additional F100 Extended Function commands are available for updating software,
changing passwords, pinging remote units, and displaying UTC time in seconds.
Table 4-2 F-Series Additional F100 Extended Function Commands
F100 BH Burn Host FTP host address, file path, file name
F100 BU Burn
F100BLS Burn Host Lock Set (change requires confirmation within 10 seconds)
F100 BLR Burn Host Lock Reset (change requires confirmation within 10 seconds)
F100 K I L L Reboot
F100 PLS Password Lock Set (change requires confirmation within 10 seconds)
F100 PLR Password Lock Reset (change requires confirmation within 10 seconds)
Function commands and unit responses contain common elements which are defined in
the following table:
Table 4-3: Definitions of Common Elements in Serial Commands and Responses
Element Definition
<CR><LF> Line terminator, a carriage return (0x0D) and line feed (0x0A)
Use Function F03 to request time and date. The response is UTC date and time.
To request TIME AND DATE, send the following command:
F03<Enter>
The unit responds:
F03<SP><mm>/<dd>/<yyyy><SP><HH>:<MM>:<SS><CR><LF>
where
F = ASCII character F
03 = function number
<SP> = space
<mm> = one- or two-digit month
/ = ASCII character slash
<dd> = one- or two-digit day
<yyyy> = four-digit year (if you manually entered this data)
<HH> = one- or two-digit hours
: = ASCII character for a colon
<MM> = two-digit minutes
<SS> = two-digit seconds
; = replacement character
<Enter> = input line terminator
<CR><LF> = output line terminator
Sample Entry: F03<Enter>
The response might be: F03 UTC 01/07/1996 02:48:29<CR><LF>
Use Version Request to query the software version number of the unit. The version
number is factory set and cannot be changed. This command is for backwards
compatibility and is identical to the F100 VER command (see page 4-66).
Use Function F36 to request or set network parameters. Changes require the unit to reset.
F36 commands are for backward compatibility and are identical to the F100 function
command series used for the same purpose (see the sections starting on page 4-59).
F36 commands are for backward compatibility with previous Symmetricom products. F36
and F100 commands can both be used to query or change specific NET Port network
parameters.
The F36 EA (and F100 EA) command reports in the Ethernet address IEEE format, which may
result in numbers which differ from those reported by your system. Since the Ethernet address
is a fixed value, as long as the unit is up and running (you can ping the unit to be sure), you can
safely ignore these differences.
Use Function F53 to verify the number of satellites currently being tracked. F53 also
reports the units operating mode, which is always Survey Static.
To see the number of tracked satellites, send the following command:
F53<Enter>
The unit responds:
F53<SP><MODE>:<SP><#><SP>SATS<CR><LF>
where
F = ASCII character F
53 = function number
<SP> = space
<MODE> = SURVEY STATIC
: = ASCII colon
<#> = number of satellites being tracked
<Enter> = input line terminator
<CR><LF> = output line terminator
Sample entry: F53<Enter>
The response might be: F53 SURVEY STATIC SATS: 6<CR><LF>
Use Function 60 to list current satellites and to see the relative signal strength of satellites
the unit is tracking. Signal strength is given in units in the range of 0 to +25.
The unit monitors five variables: the prn number, good/bad, enabled/disabled, tracked, and
current.
To request the list, send the following command:
F60<Enter>
where
F = ASCII character F
60 = function number
<Enter> = input line terminator
The unit responds:
F60<SP>prn NN<SP>good<SP>enabled<SP>tracked<SP>current<SP>
sig<SP>level<SP>= +<LEVEL><CR><LF>
where
prn NN = pseudo-random number; the prn number is a unique
identifier for a particular satellites communication
path; for example, satellite 3 might have the prn
number 15; if that satellite is recalled to Earth and
replaced by satellite 42, the communication path of
satellite 42 might also be assigned prn 15
enabled/disabled = Enabled refers to a factory default configuration
value that allows the GPS to track all satellites on
the F60 list
good/bad = Good means all three of the following apply:
the satellite is visible, and
the satellites ephemeris and almanac data report
the satellites health as good, and
the satellite reports its own health as good
Bad means at least one of the following applies:
the satellite is not visible, or
the satellites ephemeris and almanac data report
the satellites health as bad, or
the satellite reports its own health as bad (for
example, during maintenance periods)
tracked = Tracked means that the unit is tracking this
particular satellite
current = Current means that the unit is both tracking this
satellite and using the satellites communication to
calculate accurate time; an example from the list is
prn 3
<CR><LF> = line terminator
You can see from the sample list below that enabled, good, and tracked satellites are
current. That means that the unit does not use any satellite with questionable
communication to calculate time, even if that satellite is enabled, visible and being
tracked.
Sample entry: F60<Enter>
The response is a current list, an example of which is:
F60 prn 1 bad enabled sig level= +0.00
F60 prn 2 bad enabled sig level= +0.00
F60 prn 3 good enabled tracked current sig level=+13.64
F60 prn 4 bad enabled sig level= +0.00
F60 prn 5 bad enabled sig level= +0.00
F60 prn 6 good enabled sig level= +0.00
F60 prn 7 bad enabled sig level= +0.00
F60 prn 8 bad enabled sig level= +0.00
F60 prn 9 bad enabled sig level= +0.00
F60 prn 10 bad enabled sig level= +0.00
F60 prn 11 bad enabled tracked sig level= +3.00
F60 prn 12 bad enabled sig level= +0.00
F60 prn 13 bad enabled sig level= +0.00
F60 prn 14 bad enabled sig level= +0.00
F60 prn 15 good enabled tracked current sig level=+22.77
F60 prn 16 bad enabled sig level= +0.00
F60 prn 17 good enabled sig level= +0.00
F60 prn 18 bad enabled sig level= +0.00
F60 prn 19 bad enabled sig level= +0.00
F60 prn 20 bad enabled tracked sig level= +3.00
F60 prn 21 good enabled tracked current sig level=+20.15
F60 prn 22 good enabled sig level= +0.00
F60 prn 23 good enabled tracked current sig level=+15.27
F60 prn 24 bad enabled sig level= +0.00
F60 prn 25 bad enabled tracked sig level= +3.47
F60 prn 26 good enabled sig level= +0.00
F60 prn 27 bad enabled sig level= +0.00
F60 prn 28 bad enabled sig level= +0.00
F60 prn 29 good enabled tracked current sig level=+21.46
F60 prn 30 bad enabled sig level= +0.00
F60 prn 31 good enabled tracked current sig level=+18.10
F60 prn 32 bad enabled sig level= +0.00
Use Function F72 to display the status of the antenna feed circuit, and GPS lock status
fault detectors within the unit.
To display the status of the fault detectors, send the following command:
F72<Enter>
The unit responds:
F72<SP>Antenna: <ANT STATUS> GPS: <GPS STATUS><CR><LF>
where:
F = ASCII character F
72 = function number
<SP> = space
<ANT STATUS> = OPEN, GOOD or SHORTED
<GPS STATUS> = LOCKED, UNLOCKED
<CR><LF> = output line terminator
Sample entry: F72<Enter>
The response might be: F72 Antenna: OK GPS: Locked<CR><LF>
The F100 command series is known collectively as Extended Function Commands. With
certain F100 commands, you can reconfigure network parameters, such as IP Address, or
modify function settings like Remote Lockout. The main commands include F100
BASET, IP / SM / G / CONFIG (set commands) / DHCP, LOCK, UNLOCK and L.
Changes to any of these settings, except F100 LOCK, cause the unit to reset automatically
after you respond to a confirmation prompt. Other commands are available for changing
passwords (PN, PR, PRESETALL, PL, PLS, PLR) and updating software (J, BH, BU,
BUB, BF, BL, BLS, BLR), as well as pinging remote hosts (PI) and displaying UTC time
in seconds (PT).
For safety, the default response to the confirmation prompt is negative. The unit will not
execute the command unless you respond affirmatively (enter the letter y) within 10
seconds. Within that time period, any other response, including no response, results in the
unit canceling the command.
In those sections below where it is not already stated, <Enter> = input line terminator
and <CR><LF> = output line terminator.
Use the BASET command to query the current Base-T setting. If you set the unit to
10Base-T, it operates only at that speed. If you set the unit to 100Base-T, it negotiates
between 10/100Base-T. This does not necessarily mean the unit will connect at
100Base-T, but will connect at the fastest possible speed. Any change to the current
Base-T setting causes the unit to reset.
To query the maximum Base-T speed, send the following command:
F100<SP>BASET<Enter>
where
F = ASCII character F
100 = unit function number
<SP> = space
BASET = specify Base-T command
<Enter> = input line terminator
An example of the response is:
F100 BASET 100T
To set the maximum connection speed to 100Base-T, send the following command:
F100<SP>BASET<SP>100<Enter>
where:
100 = set maximum Base-T speed to 100
To set the maximum connection speed to 10Base-T, send the following command:
F100<SP>BASET<SP>10<Enter>
where
10 = set maximum Base-T speed to 10
In both these cases, the unit responds:
Are you sure? (y/N)
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
For details about an initial 100Base-T setting, see NET Port Network Parameters: First
Time Configuration on page 2-28.
Use F100 DHCP to enable or disable Dynamic Host Configuration Protocol. DHCP
allows the unit to auto-configure its network address, provided that you have enabled
DHCP, and that the unit is installed on, and connected to at power-up, an Ethernet LAN
with a DHCP server. If these conditions are not met, the unit reverts to those network
parameters in use at the last power-down. By default, DHCP is off at initial installation.
Disable DHCP before changing any Network parameter. Changing DHCP status causes a
software reset of the unit. DHCP status can be queried without rebooting the unit.
The Ethernet address is assigned at the factory. It is a fixed, six-byte, hexadecimal value
specific to the unit NET Port. The first three bytes are registered to Symmetricom Inc.;
the last three bytes are the hex value identifying the NET Port.
To request the Ethernet address of the unit NET Port, send the following command:
F100 EA<Enter>
The unit responds:
F100 EA:00-A0-69-xx-xx-xx<CR><LF>
where xx-xx-xx are the six hex digits of the units unique address.
An example of the response is:
F100 EA:00-A0-69-00-06-2A
Attempts to set this field will be rejected with a syntax error message.
The F100 EA (and F36EA) command reports in the Ethernet address IEEE format, which may
result in numbers which differ from those reported by your system. Since the Ethernet address
is a fixed value, as long as the unit is up and running (you can ping the unit to be sure), you can
safely ignore these differences.
To obtain the IP address of the unit NET Port, send the following command:
F100 IP<Enter>
The unit responds:
F100 IP:nnn.nnn.nnn.nnn<CR><LF>
where nnn.nnn.nnn.nnn is the dotted decimal address notation.
An example of the response is:
F100 IP:206.54.0.33
Changing the IP Address requires the unit to reset. A verification prompt appears
prior to execution.
To set the IP address and restart the unit, send the following command:
F100 IP:nnn.nnn.nnn.nnn<Enter>
Sample entry: F100 IP:206.54.0.21<Enter>
The response is: Are you sure? (y/N)
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
To return the subnet mask of the NET Port, send the following command:
F100 SM<Enter>
The unit responds:
F100 SM:nnn.nnn.nnn.nnn<CR><LF>
An example of the response is:
F100 SM:255.255.255.125
Changing the Subnet Mask requires the unit to reset. A verification prompt appears
prior to execution.
To set the subnet mask and restart the unit, send the following command:
F100 SM:nnn.nnn.nnn.nnn<Enter>
Sample entry: F100 SM:255.255.255.240<Enter>
The response is: Are you sure?(y/N)<CR><LF>
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
To obtain the Default Gateway of the unit NET Port, send the following command:
F100 G<Enter>
The unit responds:
F100 G:nnn.nnn.nnn.nnn<CR><LF>
An example of the response is:
F100 G:206.54.0.1
Changing the Default Gateway requires the unit to reset. A verification prompt
appears prior to execution.
To set the Default Gateway and restart the unit, send the following command:
F100 G:nnn.nnn.nnn.nnn<Enter>
Sample entry: F100 G:206.54.0.17<Enter>
The response is: Are you sure?(y/N)<CR><LF>
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
To review the entire NET Port network configuration, send the following command:
F100<SP>IC<Enter>
An example of the response is:
F100 IP:206.54.0.21 SM:255.255.255.240
G:206.54.0.17N:E<CR><LF>
where N:E denotes Ethernet DIX.
If you want to change a password, you must log in as the user for whom you want to
change the password (also see page 4-86). The maximum password size is ten characters.
To change the user password, send the following command:
F100<SP>P<Enter>
where:
F = ASCII character F
100 = unit function number
<SP> = space
P = specify Password command
<Enter> = input line terminator
The unit responds:
Enter new user password:
When you enter a new password, the unit responds with:
Enter it again:
Enter the same new password again, to confirm the spelling. If the same new
password has been entered twice, the unit responds with:
OK<CR><LF>
In this case, the new password will be used for the next login (serial or Telnet).
However, if the new password is entered differently the second time, the unit responds
with:
ERROR: Passwords do NOT match. New password rejected.
In this case, the old password will be used for the next login (serial or Telnet).
If you have forgotten your user name and/or password, you can go into bootloader
mode and reset them. In bootloader mode the unit recognizes the default user name
and password. You can then use F100 PR (see page 4-83) or F100 PRESETALL (see
page 4-82) to change the user name and password to defaults for use in the normal
mode, or you can use F100 PN (see page 4-82) and F100 P (the above command) to
change the user name and password to whatever you want. Then you can go back into
normal mode the and the user name and password you just set will work.
Use Self Test Status to query the status of the power-up tests. The response contains the
PASS/FAIL status of the flash memory checksum test, RAM test, Utility Port test, and
version check.
To query the self-test status, send the following command:
F100<SP>ST<Enter>
where:
F = ASCII character F
100 = unit function number
<SP> = space
ST = specify ST command
<Enter> = input line terminator
The unit responds:
F100<SP>ST<SP>FLASH/CRC<SP>:<SP><STATUS>,<SP>RAM<SP>:
<SP><STATUS>,<SP>SERIAL<SP>:<SP><STATUS>,<SP>VER<SP>:
<SP><STATUS><CR><LF>
where:
F = ASCII character F
100 = unit function number
<SP> = space
ST = specify ST command
FLASH/CRC = specify flash checksum result
RAM = specify RAM test result
SERIAL = specify Utility Port test result.
VER = specify version test result. This test compares the
version of the code against the version recorded in
Non-Volatile memory
<STATUS> = is either ASCII PASS or FAIL
, = ASCII comma
: = ASCII colon
<CR><LF> = output line terminator
An example of the response is:
F100 ST flash/CRC : PASS, Ram : PASS, Serial : PASS, Ver :
PASS<CR><LF>
Use Version Request to obtain the software version number of the unit. The version
number is set at compile time, and cannot be changed. It may only be queried.
To query the version number send the following command:
F100<SP>VER<Enter>
where:
F = ASCII character F
100 = unit function number
<SP> = space
VER = specify Version Request command
<Enter> = input line terminator
An example of the response is:
>f100 VER
f100 VER
BOOTLOADER 182-9006v008
SOFTWARE 182-9007v008
FILE SYSTEM 182-9008v008
NVRAM VER 2
Use Current Time Source Request to know which time source TimeVault is currently
using.
To query the current time source, send the following command:
F100<SP>T<Enter>
where:
F = ASCII character F
100 = TimeVault function number
<SP> = space
T = specify Current Time Source Request command
<Enter> = input line terminator
An example of the response is:
F100 T GPS <CR><LF>
4.4.12 F100 CONFIG FTP Configuration of NTP, SNMP & ACTS Parameters
Although you can change the NTP, SNMP and ACTS parameters contained in the temp/
directory through FTP and a text editor, it is much faster and easier to do this over the
Internet (see Web Access on page 3-31 for details).
For more information about NTP and NTP broadcast mode, see Appendix A and Appendix B.
For details on SNMP, see Appendix D.
Use a get command to retrieve data from the unit and have it delivered, through the FTP
software, to a specified directory on your C drive. You must use the UNIX format with
forward slashes to specify your IP address and the target directory. The FTP software
delivers the data in a configuration file. Once this file is in the directory, use any text
editor to modify it.
In a get command line, you can enter the elements ntp, snmp, and get in any order. If
you want to configure both NTP and SNMP at the same time, place both elements in the
command line.
Use a set command to transfer the modified data from the configuration file in your
directory back to the unit. Once again, you must specify your IP address and the directory
on your hard drive that contains the configuration file. Set commands cause the unit to
reboot. A confirmation prompt appears, to which you must respond affirmatively (y)
within 10 seconds, before the unit executes the command and resets.
In a set command line, you can enter the elements ntp, snmp, and get in any order. If
you want to configure both NTP and SNMP at the same time, place both elements in the
command line.
server 192.168.1.35
The line below lists the currently trusted keys. See the NTP keys
file for the actual keys and their corresponding key numbers.
Keys 1 and 2 are listed as an example. All keys listed must
appear in the NTP keys file. Note= to ensure maximum security,
remember to change the keys on a regular basis. A maximum of 20
trusted keys can be defined on this line.
trustedkey 1 2
2. Edit the data in the ntp.conf file by adding or renaming servers from this list.
When sending a set command, the last number in the unit response (70 in this example)
represents file length. Depending on the parameters you configure, this number may vary.
The NTP client ntp.keys file is identical to the one on the NTP server. For the specific
keys used by the NTP server, the NTP client must have the identical line in its version of
the file. Youll want to use your own hard-to-guess key names, using random letters. The
critical lines of the ntp.keys file are:
Id M Value
---- --- --------
1 M Symmetricom
2 M xyz123
For maximum security, use a unique combination of 32 letters and numbers for each key
identifier. For correct configuration, do not use zero as a key identifier. Zero means the key
identification will not be used.
where:
MIB = for future use only
GenTraps = switches on/off all traps
sysContact,
sysName, and
sysLocation = standard MIB II variables for system name,
location, and contact personnel
NAME, VIND,
TRAP (yes/no),
ACCESS (read/write),
and IP address = configurable SNMP community variables
2. Configure any of the following parameters:
GenTraps: set to YES if you want SNMP traps to be generated
If you do not use SNMP on your network, set GenTraps to NO.
Community Names
Access: W for read/write (R = read only)
IP Addresses
3. Return the revised data to the unit by sending a set command:
F100 config set snmp host:192.168.1.14
dir:temp
The unit responds: Are you sure? (y/N)
If you answer y, the unit responds:
Source file temp/snmp.conf bytes read: 1274
Dest File /config/snmp.conf bytes written: 1274
Configuration files transferred successfully!
2. Edit the data in the acts.conf file by adding or renaming servers from this list.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which TimeVault
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in TimeVault canceling the command.
When sending a set command, the last number in TimeVaults response (149 in this
example) represents file length. Depending on your parameters, this number may vary.
Use Remote Lockout to disable remote control capability and secure the unit from Telnet
access. You can issue this command from Telnet or the serial port, or from the front panel.
The default setting is Unlocked. To once again activate remote access via Telnet, you
must unlock the unit using the front panel (see Keypad Entry Guidelines and NET Port
Network Parameters: First Time Configuration in Chapter 2).
To lock the unit from a remote location, send the following command:
F100 LOCK<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
If you are using Telnet when you issue this command and answer y and press Enter, the
TimeVault executes the command by saying Goodbye and closing the Telnet session.
Use Lock Display to view the lock setting state for remote Telnet access.
To view the lock setting for remote access, send the following command:
F100 L<Enter>
An example unit response:
UNIT_REMOTE_DISABLE_BIT = 0
This example shows that the unit is unlocked (0), so remote access is allowed.
Important Note:
The following commands related to sofware upgrades (F100 J, BH, BU, BUB, BF and K I L L)
are not the normal commands used for uploading firmware. Symmetricom provides these
commands for flexibility in supporting special case situations. Normal firmware upgrades use
an easy-to-use upgrade program provided with the firmware.
Use F100 PT to display the state of jumper JP5, which is reserved for future use. This
function also displays the security flag bits and disable bits.
To display the state of jumper J5, send the following command:
F100 J<Enter>
An example unit response:
Jumper JP5 = 0
Security flags = 0x00000000
FPC_SECURITY_BIT = 0
BURN_DISABLE_BIT = 0
UNIT_REMOTE_DISABLE_BIT = 0
PASSWORD_SETTING_DISABLE_BIT = 0
JP5 is located near the middle of the printed circuit board, beside the two flashing LEDs
and the NetARM microprocessor.
Use Burn Host when upgrading software, to select the FTP host and the file to be
transferred.
To select the FTP host and file for upgrading, send the following command:
F100 BH <FTP host IP address><SP><Upgrade file path>/
<file name><Enter>
Use UNIX style forward slashes / in path and do not describe the drive (for example, C) in
the path.
For example:
F100 BH 10.1.7.20 Lassen/Rel/REL20010518/nts200/192-9004v001.BIN
The unit responds:
Burn host is ready
This command can be disabled by the Burn Host Lock command, which denies serial and
Telnet access. However, if you enter BootLoader mode, this command is always available.
Use Burn when upgrading software, to write the file selected with F100 BH to the flash
memory. Flash memory is checked to ensure that the correct file is used.
To write the file to the flash, send the F100 BH command with the FTP host, file
path and name, and then send the following command:
F100 BU<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
Unit example execution:
Burning Prog1
Burning file 182-9004v001.bin with size 688052 to
partition 1: sector :6
Sec: 6 re: 0
Sec: 7 re: 0
Sec: 8 re: 0
Sec: 9 re: 0
Sec: 10 re: 0
Sec: 11 re: 0
Sec: 12 re: 0
Sec: 13 re: 0
Sec: 14 re: 0
Sec: 15 re: 0
Sec: 16 re: 0
Flash successfully programmed CRC32 = 0x88841B88
Use Burn BootLoader when upgrading software, to write the BootLoader to flash memory.
To write the BootLoader to the flash, send the F100 BH command with the FTP
host, file path and name, and then send the following command:
F100 BUB<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
unit example execution:
Burning Boot
Burning file 182-9003v001.BT with size 342860 to
partition 0: sector :0
Sec: 0 re: 0
Sec: 1 re: 0
Sec: 2 re: 0
Sec: 3 re: 0
Sec: 4 re: 0
Sec: 5 re: 0
Flash successfully programmed CRC32 = 0xE3E0ECAE
If more than six flash sectors are written during this process, you must rewrite both the
bootloader sectors (0 to 5) and the program binary sectors (6 to 16).
Use Burn File System when upgrading software, to write a file system to the flash
memory.
To write the file system to the flash, send the F100 BH command with the FTP
host, file path and name, and then send the following command:
F100 BF<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
K I L L is a case-sensitive command. When entering this command, use all capital letters. You
also must put spaces between each letter.
Use Burn Host Lock to display whether or not software upgrades via serial or Telnet
connections can be performed in the normal mode.
To display the burn host lock state, send the following command:
F100 BL<Enter>
An example unit response:
BURN_DISABLE_BIT = 0
If the lock is set to 1, upgrading is not possible via serial or Telnet connections in the
normal mode (the burn host lock has been set). If the lock is set to 0, upgrading is possible
(the burn host lock has been reset).
Use Burn Host Lock Set to prevent unauthorized upgrading of software via serial or Telnet
connections.
To set the burn host lock, send the following command:
F100 BLS<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
Unit example execution:
BURN_DISABLE_BIT = 1
Use Burn Host Lock Reset to reset the lock and allow software upgrades via serial and
Telnet connections. You must be in bootloader mode to access this function.
To reset the burn host lock, send the following command:
F100 BLR<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
Unit example execution:
RESET BURN_DISABLE_BIT = 0
If you are in normal mode and you try to reset the burn host lock, you will get a friendly
reminder:
Command Canceled
BURN_DISABLE_BIT = 1
Bootloader Mode Required
Reboot while holding SAVE key
Use Password Reset All when you want to set passwords back to the factory defaults.
PRESETALL is a case-sensitive command. When entering this command, use all capital
letters.
To reset all the passwords to factory defaults, send the following command:
F100 PRESETALL<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
Unit example execution:
Flash memory writing in progress:
Default user name and password set: 2
Default user name and password set: 1
Use Password System User Name when changing the login user name.
To change the login user name, send the following command:
F100 PN<Enter>
The unit responds:
User Name Change for xyz123
Enter new user name:
When you enter a new user name, the unit responds with:
Confirm new user name:
Enter the same new user name again, to confirm the spelling.
If the same new user name has been entered twice, the TimeVault responds with:
User name change for xyz123 successfully changed
In this case, the new user name will be used for the next Telnet login. However, if the
new user name is entered differently the second time, the TimeVault responds with:
ERROR: User names do NOT match. New user name rejected.
In this case, the old user name will be used for the next Telnet login.
Use Password Reset when changing the current login user name and password to their
defaults.
To reset the passwords to factory defaults, send the following command:
F100 PR<Enter>
The unit responds:
Are you sure? (y/N)
If you answer y and press Enter, the unit executes the command.
As a safety feature, after sending this command, you have 10 seconds to respond
affirmatively (enter the letter y) to the confirmation prompt, after which the unit
executes the command and resets. Within that 10 second time period, any other response,
including no response, results in the unit canceling the command.
Unit example execution:
Default user name and password set : 2
Use Password Lock to view the password changing lockout setting for Telnet sessions.
To display the password lockout state, send the following command:
F100 PL<Enter>
An example unit response:
PASSWORD_SETTING_DISABLE_BIT = 0
If the lock is set to 1, changing the password is not possible (the password lock has been
set). If the lock is set to 0, changing the password is possible (the password lock has been
reset).
Use Peer List to view the NTP peers being polled every 64 seconds.
To display the peers, send the following command:
F100 PE LIST<Enter>
An example unit response:
Peer no: 001 127.127.001.000
Peer no: 002 206.254.000.020
Use Peer Add to temporarily add an NTP peer node to be polled. After logging out, when
you log back in the original peer settings will be active.
To add a peer, send the following command:
F100 PE ADD<IP Address><Enter>
For example:
F100 PE ADD 206.254.000.021<Enter>
Use Peer Remove to temporarily remove an NTP peer node from the polling list. After
logging out, when you log back in the original peer settings will be active.
To remove a peer, send the following command:
F100 PE REM<IP Address><Enter>
For example:
F100 PE REM 206.254.000.021<Enter>
4.5 Login/Logout
Use the Operator login to run function requests and entries, change settings and perform
software updates. As shipped, and whenever the unit is started in BootLoader Mode, you
can access the Operator level with:
User Name: operator
Password: mercury
To maintain security, change the Operator password at installation.
If you are logged in as operator, the only serial or Telnet function that you cannot
perform is to change the Guest password.
Use the guest login to view function requests. As shipped, you can access the Guest level
with:
User Name: guest
Password: truetime
To maintain security, change the Guest password at installation.
If you try to use a function that is not accessible from the guest login, you will see a
message such as Access denied or Command canceled.
4.5.3 Logout
You can logout using any of the standard logout commands, as follows:
logout
logoff
exit
quit
Meaning: You have entered a valid command, with an invalid parameter value.
Recovery Action: Re-enter the command, using a valid parameter.
Meaning: You have entered a valid command with a minor syntax error. The
NET Port network interface software has detected the error.
Recovery Action: Re-enter the command, using valid syntax.
Meaning: TimeVault can not create the device needed to map the host to a drive.
Recovery Action: Restart the Unit. If this error message persists, contact Symmetricom
Technical Customer Service.
Meaning: You have omitted the get or set parameter from the F100 NTP
Configuration command.
Recovery Action: Re-enter the command, specifying the desired action.
Meaning: Data from the source file cannot be copied to the destination file.
Recovery Action: Check file location and directory names to verify the path is accurate,
then re-enter the command.
Meaning: Solid Red means there is no signal from the time sources, or that a
major alarm fault has been detected.
Messages in this section inform you of events and do not require any action on your part.
Meaning: Your last action deleted the previously set IP host address.
5.3.2 NOTICE: Cannot respond to command because Utility Port session has priority.
Meaning: A Utility Port session has started and takes precedence. Wait until it
is over before logging in or expecting a response to an entered Telnet
command.
Meaning: A command has just been executed that requires a soft restart of
TimeVault. The restart happens immediately after this message is
sent.
Meaning: You have just successfully entered the Enable DHCP command.
Meaning: You have just successfully entered the Disable DHCP command.
5.3.9 OK
5.3.10 Goodbye.
TimeVault fully supports NTP version 4, (backwards compatible with NTP version 2,
RFC-1119, and version 3, RFC-1305), and SNTP as per RFC 2030.
All RFCs are published with approval of the Internet Activities Board, found on the
Internet by running any search engine and typing RFC in the search field (or
RFC-#### if you have the number). Two such search engines can be found at the
following Internet addresses:
http://www.lycos.com/
http://www.altavista.com/
The layout of the NTP data packet information following the UDP header is shown below,
and each element is described on the following pages:
Reference Timestamp
Originate Timestamp
Receive Timestamp
Transmit Timestamp
Authenticator
Leap Indicator
The leap indicator is a 2 bit code that signals an impending leap second to be added or
subtracted in the last minute of the current day. Leap year codes and their corresponding
meanings are shown in Table A-1 below:
Table A-1 Leap Year Codes
0 0 Normal Operation
Version Number
The version number is a three bit integer that specifies the NTP version. TimeVault will
copy this field from the client requesting packet and return it in this field if it is equal to
either 2 or 3. NTP version 1 packets are not supported.
Mode
The mode is a three bit integer that determines the functions TimeVault performs.
TimeVault operates in mode four or server mode. Mode four operation allows the module
to synchronize hosts but will not allow the module to be synchronized by another host.
Stratum
The stratum is an eight bit integer providing the stratum level of the time source.
TimeVault operates in stratum 1, denoting a primary reference.
Poll Interval
The poll interval is a signed eight bit integer used as the exponent of two to yield in
seconds the minimum interval between consecutive messages. For example, a poll
interval value of six implies a minimum interval of 64 seconds. TimeVault does not alter
the setting of this field.
Precision
The precision is a signed eight bit integer used as the exponent of two to yield in seconds
the precision of the local time source and any other hardware affecting the base level
jitter of the time server. This field is set to approximate TimeVaults time stamping
resolution, which is 10 s. So the precision byte is set to 16, which is equivalent to a
precision of 15.26 s.
GPS "GPS"
ACTS "ACTS"
NTP "NTP"
Reference Timestamp
The reference timestamp is a 64 bit timestamp format representing the local time at the
last update. TimeVaults reference timestamp is the last time that a valid synchronization
source signal was present.
Originate Timestamp
The originate timestamp is a 64 bit timestamp format representing the time that the request
left the client host.
Receive Timestamp
The receive timestamp is a 64 bit timestamp format representing the time that the request
arrived at the service host.
Transmit Timestamp
The transmit timestamp is a 64 bit timestamp format representing the time that the reply
left the service host.
Authenticator
This is a 96-bit field containing the authenticator information as described in Appendix C
of RFC-1305. This field is not implemented by TimeVault.
When TimeVault replies to requests from SNTP clients, the packet format is the same as
the NTP packet format described above, with the following differences:
Leap Indicator
TimeVault sets these 2 bits to either 0 (normal) or 3 (unsynchronized) only
Version Number
TimeVault copies this field from the client request packet and returns it in this field.
Reference Timestamp
This field is set to the time that the reply left TimeVaults server host.
Receive Timestamp
This field is set to the time that the reply left TimeVaults server host.
Transmit Timestamp
This field is set to the time that the reply left TimeVaults server host.
Authenticator
This field is not used in SNTP.
Note: A number of NTP-related programs, such as NTPDC and NTPQ, are not
supported, in the conventional sense, by Dr. Mills NTP, and therefore cannot be
supported by Symmetricom, Inc. (TrueTime, Inc. is now Symmetricom, Inc.) The user of
these programs does so at his or her own risk.
NTPQ and NTPDC are query programs used to obtain TimeVaults offset, relative to any
server for which the unit is configured (page 3-36 or page 4-69 show where this list is
located in the "ntp.conf" file), as well as information about any of the units
synchronization sources, such as ACTS. A separate SNMP alarm (trapMsg7, see )
notifies you when the TimeVault offset is greater than 1 second relative to the first NTP
server in the ntp.conf file list, and the server is not otherwise in an alarm condition.
If you enable TimeVaults Remote Lock feature, you disable all settable features of NTPQ and
NTPDC.
A.3.1 NTPQ
NTPQ is a query program that uses the standard protocol defined in RFC-1305 to
diagnose and repair problems that affect the operation of NTP. NTPQ uses NTP mode 6
(control mode) packets to query NTP servers (and any compatible servers on the network
that permit it) about current state, as well as to request changes in that state. NTPQ can
also obtain and print a list of peers in a common format by sending multiple queries to the
server.
A.3.2 NTPDC
NTPDC is a special query program that uses NTP mode 7 (private mode) packets to
provide extensive state and statistics information and can be used to set configuration
options at run time.
The NTP daemon sends information about the current calculated offset between its time
and the time of each of its NTP peers. The NTPDC command formats the information on
the standard output.
TimeVault uses NTP v. 4.0. Do not mix NTP v. 3.0 and NTP v. 4.0 utilities and daemons. For
example, the NTPDC program cannot be used to monitor the XNTP daemon. To monitor the
XNTP daemon, use either NTPQ or XNTPDC. However, do not use XNTPDC to monitor NTP
use NTPDC instead.
NTPQ and NTPDC are fully documented at the following Internet sites:
NTPQ: http://www.eecis.udel.edu/~ntp/ntp_spool/html/ntpq.htm
and
http://www.doc.ic.ac.uk/~mac/manuals/hpux-manual-pages/hpux/usr/local/man/man8/ntpq.8.html
NTPDC: http://www.eecis.udel.edu/~ntp/ntp_spool/html/ntpdc.htm,
http://hoth.stsci.edu/man/man1M/ntpdc.html
and
http://www.unix.digital.com/faqs/publications/base_doc/DOCUMENTATION/V40F_HTML/MAN/M
AN8/0218____.HTM.
The MD5 message digest is 16 bytes in length and it follows the key identifier in the
signature. A server authenticates the NTP packet from a client by first looking up the key
by reference to the key identifier. It then generates the MD5 message digest based on the
key and the NTP data and compares the resulting message digest to the client packets
MD5 message digest. If the two compare, a NTP reply packet is generated with a new
MD5 signature. If the MD5 message digests do not agree, then the NTP client packet is
ignored by the Symmetricom server.
To use NTP Broadcast mode, you also need the following information:
Maximum number of user definable MD5 keys in the ntp.keys file: 24
Maximum number of trusted keys that can be defined in an ntp.conf file: 20
Maximum number of keys that can be used in NTP broadcast mode: 20
Maximum text length of MD5 key value in ntp.keys file: 32 ASCII characters
For more technical information on MD5, see the MD5 RFC-1321, NTP RFC-1305, and
the release notes for NTP client software furnished by Dr. David Mills web site located at
the following Internet addresses at the University of Delaware:
http://www.eecis.udel.edu/~ntp
or
http://www.eecis.udel.edu/~ntp/software.html
All RFCs are published with approval of the Internet Activities Board, found on the Internet by
running any search engine and typing RFC in the search field (or RFC-#### if you have the
number). Two such search engines can be found at the following Internet addresses:
http://www.lycos.com/
http://www.altavista.com/
An NTP broadcast timeserver with an NTP broadcast time client can be used for NTP
version 4 with authentication.
The MD5 authentication protocol is optionally available for NTP versions 3 and 4. When
a packet is received by NTP, it checks the key identification number in the packet against
the private key in the ntp.keys file, then calculates the MD5 digest number and
compares this number to the one sent in the packet. If the digest numbers do not agree,
then the packet is ignored. Thus, only servers with trusted MD5 keys may send time to a
client. The keys are known to both the NTP client and server through separate key files,
usually named ntp.keys in the /etc directory. The name of the file and its location are
determined by the k option when the NTP program is invoked.
In actual practice, for normal NTP client-to-server communications using explicit IP
addresses with multiple servers, it is not necessary to use MD5. That is because the NTP
client spends a great deal of time filtering out packets with incorrect time. Anyone
attempting to send false time to a NTP client would be discarded. However, when
broadcast time is used, then the client accepts the packet more readily and in this case can
be fooled. The same is true if only one NTP server is used to synchronize an NTP client
and a network attacker substitutes a false NTP server for the good one. Under these
conditions, the NTP client has nothing to judge the time against and, if the false
information is persistent, then the client will be forced to eventually reset its time. In this
case it is worth the extra processing load to use MD5.
Setting up an NTP broadcast server and NTP client using MD5 authentication requires
modifications to the ntp.keys file.
Editing MD5 keys is covered in Chapter 4 (see the sections starting on page 4-70). The
following discussion covers the use of an NTP broadcast timeserver with an NTP
broadcast time client for NTP version 4 without authentication.
Authentication was configured off by default for NTP version 3, but is configured on by
default for version 4. This means that NTP version 4 must use authentication, like MD5,
for broadcast time to work. To have it otherwise, you must specifically turn
authentication off in the ntp.conf file of the NTP time client.
The method outlined below should only be used when the LAN that the two NTP hosts are on is
a secure network. Otherwise, it is all too easy for an NTP time imposter to broadcast the
incorrect time to the NTP time client.
For the NTP timeserver, authentication may be on or off - it does not matter. As an
example, here is a sample ntp.conf file.
server 192.168.1.49
server 206.54.0.20
server 206.54.0.21
broadcast 192.168.1.255
This file is stored on the Symmetricom timeserver in its Flash disk drive in the /etc
directory.
The critical line is: broadcast 192.168.1.255.
This line turns on the periodic broadcast of NTP time packets to the local LAN.
This IP address (the first three octets: 192.168.1) is a network address.
The LAN portion of the address, the last octet in this case, is set to all ones. You
may use all zeros for most LANs as the LAN address, instead of all ones. This
address allows NTP time packets to be received by all hosts on the local LAN
including the NTP time client. Ask your system administrator what your LAN
broadcast address is for your particular network and substitute it for the address in
this example.
Authentication status is critical on the time client. If MD5 is not used, authentication must
be off for broadcast mode to work. Here is a sample ntp.conf file used in the time client,
plus a sample command line of the NTP program invocation:
server 192.168.1.49
server 206.54.0.20
server 206.54.0.21
disable auth
This file is stored in the /etc directory on the time client or the same directory that
ntp.conf is stored if your directory is different from the standard NTP default directory.
The critical line is: disable auth.
The line disable auth turns off system authentication and tells the system to not
use authentication for received NTP time broadcast packets.
When you invoke the NTP client at the command line, use the following options:
b
to turn on broadcast packet reception
d
to turn on debug mode at a sufficient level to verify that broadcast packets are
indeed being used:
ntpd d d d b
Once you have completed debugging your system, you can prevent incoming messages from
appearing on the command line by turning off the debug option flags.
TIME protocol provides a site-independent, machine readable date and time. The TIME
service sends back to the originating source the UTC time in seconds since midnight on
January 1, 1900.
This protocol may be used either above the Transmission Control Protocol (TCP) or above
the User Datagram Protocol (UDP).
When used via UDP, the TIME service works as follows:
Server:Listen on port 37 (45 octal).
Client:Send an empty datagram to port 37.
Server:Send a datagram containing the UTC time as a 32 bit binary number.
Client:Receive the TIME datagram.
The server listens for a datagram on port 37. When a datagram arrives, the server returns
a datagram containing the 32-bit time value. If the server is unable to determine the time
at its site, it should discard the arriving datagram and make no reply.
The time is the number of seconds since 00:00 (midnight) 1 January 1900 UTC, such that
the time 1 is 12:00:01 AM on January 1, 1900 UTC; this base will serve until the year
2036.
This daytime service is defined as a datagram based application on UDP. A server listens
for UDP datagrams on UDP port 13. When a datagram is received, an answering
datagram is sent containing the current date and time as a ASCII character string (the data
in the received datagram is ignored).
The string format for the DAYTIME Protocol conforms to the Unix workstation time
expression, except the time is in UTC rather than local time. The syntax is as follows:
DDD, MMM, XX, YYYY, HH:MM:SS-UTC
where
DDD = the day: Sun, Mon, Tue, Wed, Thus,
Fri, Sat
MMM = the month: Jan, Feb, Mar, Apr, May,
Jun, Jul, Aug, Sep, Oct, Nov, Dec
XX = day of the month
HH = hour (24 hour format) of that day
MM = minutes of that hour
SS = seconds of that minute
SNMP management software allows a network user to remotely monitor and configure an
IP host that supports an SNMP agent. An SNMP agent is protected from unauthorized use
through a security scheme. TimeVault supports a SNMP version 1 agent with the MIB II
and Enterprise MIB databases.
The material in this section assumes you already have an understanding of SNMP. If that
is not the case, we recommend SNMP, SNMPv2 and CMIP written by William Stallings
and published by Addison-Wesley Publishing Company. This book is considered by the
community to be the definitive introduction to SNMP. Another good reference is How
To Manage Your Network Using SNMP, by Marshal T. Rose and Keith McClogurie. For
more technical references, see RFC-1157 (the definition of SNMPv1), RFC-1213 (the
definition of MIB II) and RFC-1354 (the IP Forwarding table addition to MIB II). All
RFCs are published with approval of the Internet Activities Board, found on the Internet
by running any search engine and typing RFC in the search field (or RFC-#### if you
have the number). Two such search engines can be found at the following Internet
addresses:
http://www.lycos.com/
http://www.altavista.com/
Two sites in particular that have basic information on SNMP are:
The Simple Web: http://snmp.cs.utwente.nl/
Basic SNMP Information: http://www.skyweb.net/~parsons/snmp-links.html
SNMP offers a security authentication scheme that is based on a common password shared
by the management station and a group of agents. A group of hosts are known as a
community. Any management station or agent can be a member of any combination of
communities. Typically a manager will need to change the SNMP community
information from Symmetricoms SNMP agent factory defaults for security purposes.
However, the factory default SNMP community settings are chosen to make the
Symmetricom SNMP immediately usable. Symmetricoms SNMP agent recognizes up to
five separate SNMP communities. These communities are configured through the serial
or Telnet interface using the F100 NTP command, where the menus referred to in this
section appear. Each community has several configurable parameters that are defined in
Table D-1.
Table D-1: SNMP Community Configurable Parameters
Community The name of this community. The name is limited to up to 32 ASCII letters, numbers or
Name punctuation letters. This is the name that a management SNMP PDU (packet) specifies. If
the community name of an incoming PDU does not match any of the five community
names, the packet is ignored and an optional authentication trap message can be
generated. See traps below. An empty string field disables the community name.
Trusted IP If the Use Trusted IP flag is set to yes, then this is the table of IP host addresses that this
Address community recognizes as valid SNMP management hosts. Even if the community name of
an incoming PDU matches this community, the source IP address must match one of the
IP addresses in this table, or the packet is ignored and an optional authentication error trap
message is issued. Setting an IP address to all zeros turns off that IP address entry. In
addition, this table also serves as the list of hosts that SNMP trap messages are sent to
regardless of the state of the Use Trusted IP flag.
Use If this flag is set to yes, then the Trusted IP Address table is used in addition to the
Trusted IP Community Name for authentication of incoming PDUs).
R/W For a particular community, the SNMP variables are set to read only, or normal SNMP
Access access. This allows the manager to have a public known community from which anyone
may read the SNMP data base and a separate private community that has full normal read
and write access to the SNMP database.
Note: SNMP MIB II does not define all variables to be writeable. SNMP variables defined
by RFC-1213 as read-only remain read-only, regardless of the state of this R/W Access
flag.
Trap When this flag is set to yes, trap messages are issued for this community.
Enable
Note: This enables/disables all traps (both coldstart and authentication).
Trap Port A trap port other than the normal SNMP trap port of 162 may be specified.
Note: This address must be chosen carefully, or conflicts with other protocols may occur.
Save When any setting is changed, this becomes visible and answering yes immediately saves
Settings the changes to Symmetricoms SNMP. Answering No will negate the changes.
Table D-2 and Table D-3 define SNMP configurable parameters that are applied globally
to all SNMP communities (this menu appears after the last community menu), and the
Symmetricom SNMP factory default settings.
Table D-2: SNMP Community Global Parameters
KeyWord Definition
SNMP When set to yes, all authentication failure traps are disabled. This flag overrides the Trap
Global Enable flag set for each community and directly sets the value of the SNMP variable
Enable Traps snmpEnableAuthenTraps.0.
Note: The state of this flag has no effect on the issue of coldstart trap messages.
Save settings When SNMP Global Enable Traps is changed, this becomes visible and answering yes
immediately saves the change to Symmetricoms SNMP. Answering No negates the
change.
Community 1
Use Trusted IP No
Trap Enable No
Community 2
Use Trusted IP No
Trap Enable No
Community 3 to 5
Community Name
Use Trusted IP No
Trap Enable No
The factory default settings are summarized as follows: community one is called public
and is set to read-only access for the SNMP MIB; community two is named system and it
has normal access to the SNMP database; all other communities are disabled. All traps are
disabled. Many SNMP management utilities are written with these default assumptions
and thus the Symmetricom SNMP is immediately usable without configuration.
Use Serial or Telnet Function F100 CONFIG to obtain information about the current
SNMP/NTP configuration, or to change the IP addresses, traps, read/write access, or
community names and parameters. For details, see Configuration of SNMP Parameters
Using FTP on page 4-72. Although this option is available, it is much faster and easier to
configure SNMP parameters over the Internet. For details, see Remote SNMP
Configuration on page 3-38.
Introduction
A Management Information Base (MIB) is a database of managed objects that have a
hierarchical structure. There are common or vendor-specific managed objects. The
Internet community has over 1,000 objects registered. The objects themselves are
representations of real physical network properties or information.
Using a TCP/IP network and Symmetricom's SNMP Enterprise MIB, you can remotely
obtain information on the health and status of the NTP application and the primary time
synchronization source using the SNMP version 1 protocol. The Enterprise MIB database
has five variable groups: the Trap Message Group, the Network Time Protocol Group, the
Network Time Server Control Group, the GPS Group, and the ACTS Group. Presently,
the control group is preliminary and is not implemented in the current version of software.
Traps are sent on Change of Status (COS). There are three types of traps: NTP Status,
GPS Status, and GPS Antenna Status. All of them report failures, as well as the return to
active status. The settings are as follows:
NTP Status: NTP Client Mode*
NTP Unlocked
NTP Locked
GPS Status: GPS Locked
GPS Unlocked
GPS Antenna Status: GPS Antenna Fault
GPS Antenna OK
*In NTP Client Mode, NTP is using another NTP server as its timing reference, instead of GPS.
The trap message group holds the ASCII string data to send whenever an SNMP trap
message is transmitted. The NTS agent sends SNMP trap messages to SNMP
management hosts notifying them of some critical event at the NTS agent. The NTS
issues three types of trap messages. The first type is a cold start trap message indicating
when the box boots or re-initializes. The second type of trap message is issued when the
NTS estimated time error has exceeded the minimum time accuracy threshold. The third
trap message is issued when a packet received by the NTS agent fails SNMP
authentication. The second feature notifies a network administrator immediately if the
time server lost its ability to tell accurate time.
The NTP Enterprise Group furnishes information on the Network Time Protocol. This
group provides packet information for the number of received, rejected, and transmitted
NTP packets exchanged between the UDP transport and the NTP application layers.
Packets are rejected when they are malformed or the MD5 encryption authentication
failed. In addition, time quality can be assessed by looking at the current estimated time
error and comparing it with the time accuracy threshold. Finally, all of the NTP control
information transmitted by the NTS in an NTP packet is available in this enterprise group.
One important variable in this group is ntpSysLeap because it is the clearest indication if
the NTS is telling correct time.
When GPS is used as the time synchronization source, the GPS Enterprise MIB Group
provides detailed information about the satellites used by the NTS. Complete GPS
satellite information exists on the number of satellites tracked and used for timing
purposes, their signal strengths, the tracking mode, altitude, longitude, and latitude of the
GPS antenna. This information allows you to properly set up the GPS antenna and to use
the unit for time information.
When ACTS is used as the time synchronization source (see Appendix E for details), the
ACTS Enterprise MIB Group provides detailed information on the ACTS dial-up modem
time service. Complete information on the number and success of the ACTS phone calls
as well as a detailed break down of the various possible modem and line failures that can
occur. This information allows you to fine tune calling frequency with the desired time
accuracy and assess the telephone line quality of the connection to the ACTS service.
Obtaining the enterprise MIB information requires you to have an SNMP management
program running on your computer.
Variable Definitions
This section contains a complete and formal definition of Symmetricoms SNMP
enterprise MIB group, including all the variables in Symmetricom's Enterprise MIB, along
with the MIB OID address and data types.
An electronic form of this file was included with this manual. If the disk has been
misplaced or corrupted, a copy can be obtained from Symmetricoms web site
(www.truetime.net). Select Products and Literature>Reference Material to get there.
The files name is TrueTime.MIB, and should compile for virtually any SNMP
management software. It has been verified to work for Suns Solaris X-SNMP and
Hewlett Packards OpenView management software packages.
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, Integer32
FROM SNMPv2-SMI
CounterFROM RFC1155-SMI
DisplayStringFROM SNMPv2-TC
TRAP-TYPEFROM RFC-1215;
TrueTime MODULE-IDENTITY
LAST-UPDATED 9906190000Z
ORGANIZATION TRUETIME INC.
CONTACT-INFO Technical Support
DESCRIPTION TrueTime Enterprise MIB
::= { trueTimeEnt 0 }
trapMsgColdStart OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP port 162 (or user defined) when
the TrueTime time server reinitializes. The message is Cold Start Trap
PDU from: ###.###.###.###. Where ###.###.###.### is the doted
decimal notation of the IP address of the booting unit.
::= { trapMsg 1 }
trapMsgNtpAlarm OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII-string sent to the UDP-trap port 162 (or user defined)
when the TrueTime time servers detects change of the NTP-status. This
could be due to a line breakage in the timing source, loss of GPS
satellites, etc. The message is NTP Status aaaaaaaa, where aaaaaaaaa can
be NTP UNLOCKED, NTP client mode or NTP LOCKED.
::= { trapMsg 2 }
trapMsgSnmpAuthFail OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP port 162 (or user defined) when
the TrueTime time server determines the SNMP authentication for a SNMP
PDU is in correct. The message is SNMP Authentication Failure Trap
PDU from: ###.###.###.###. Where ###.###.###.### is the doted
decimal notation of the IP address of the unit attempting the invalid
access.
::= { trapMsg 3 }
trapMsgGpsAntennaFault OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP trap port (162 or user defined) when
the TrueTime time servers GPS detects change of the GPS status. The
message is GPS Antenna: *****************, from ###.###.###.###. Where
***************** is either GPS Antenna OK, GPS Antenna Open or GPS Antenna
Short and ###.###.###.### is the doted decimal notation of the IP address
of the unit reporting the change.
::= { trapMsg 4 }
trapMsgGpsUnlocked OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP trap port (162 or user defined) when
the TrueTime time servers GPS detects change of the GPS status. The
message is GPS Status: ********, from ###.###.###.###. Where ******** is
either LOCKED or UNLOCKED and ###.###.###.### is the doted decimal notation
of the IP address of the unit reporting the change.
::= { trapMsg 5 }
trapMsgNewSyncType OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP trap port (162 or user defined) when
the TrueTime time servers GPS detects change of the GPS status. The
message is Time synchronization type is now ****, from ###.###.###.###.
Where **** can be GPS, ACTS or NTP and ###.###.###.### is the doted decimal
notation of the IP address of the unit reporting the change.
::= { trapMsg 6 }
trapMsgCrossCheckAlarm OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an ASCII string sent to UDP trap port (162 or user defined) when
the TrueTime time servers detects an offset in time equal to, or greater
than, one second from the cross check server and itself and the server is
not otherwise in a system alarm condition. The message is Cross Check
Status: *****, from ###.###.###.###. Where **** can be OK or Alarm and
###.###.###.### is the doted decimal notation of the IP address of the unit
reporting the change.
::= { trapMsg 7 }
ntpInPkts OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Total number of NTP packets delivered to the NTP application
layer from the transport layer.
::= { ntp 1 }
ntpOutPkts OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Total number of NTP packets passed from the NTP application
layer to the transport layer.
::= { ntp 2 }
ntpInErrors OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Total number of NTP packets reject for any reason by NTP
application layer.
::= { ntp 3 }
ntpAuthFail OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Total number of authentication failures. This is a subset of
ntpInErrors.
::= { ntp 4 }
ntpDesiredAcc OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The desired (worst case time) accuracy in microseconds that the
time server will attempt to steer to. This variable is related to
ntpEstError. Should ntpEstError be greater than ntpDesiredAcc, the
NTP alarm condition will be set (ntpSysLeap will be equal to 3).
Note: outgoing NTP packets will have their leap indicator field set to
ntpSysLeap.
::= { ntp 5 }
ntpEstErr OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The current estimated (time) error in microseconds of the time
server. This variable is related to ntpEstError. Usually, this value
is small and constant for a given type of time server. However, when
primary synchronization is lost, this value will slowly increase with
time as the time servers oscillator flywheels away from true time.
Should ntpEstError be greater than ntpDesiredAcc, the NTP alarm
condition will be set (ntpSysLeap will be equal to 3).
Note: a primary time servers outgoing NTP packets will have its leap
indicator field set to ntpSysLeap.
::= { ntp 6 }
ntpSysLeap OBJECT-TYPE
SYNTAX INTEGER
{
noLeapWarningAndTimeIsSynchronized (0),
lastMinuteHas61SecondsAndTimeIsSynchronized (1),
lastMinuteHas59SecondsAndTimeIsSynchronized (2),
alarmConditionAndLossOfTimeSynchronization (3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is a status code indicating normal operation, a leap second to
be inserted in the last minute of the current day, a leap second to be
deleted in the last second of the day or an alarm condition indicating
the loss of timing synchronization. Note: a primary time servers
outgoing NTP packet will have its leap indicator field set to
ntpSysLeap.
::= { ntp 7 }
ntpSysHostMode OBJECT-TYPE
SYNTAX INTEGER
{
hostModeIsReserved0 (0),
hostModeIsSymmetricActive (1),
hostModeIsSymmetricPassive (2),
hostModeIsClient (3),
hostModeIsServer (4),
hostModeIsBroadcast (5),
hostModeIsReserved6 (6),
hostModeIsReserved7 (7)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The value of this variable indicates the mode that the host is
operating in. Note: this is the value of the time servers outgoing
NTP packet mode field.
::= { ntp 8 }
ntpSysStratum OBJECT-TYPE
SYNTAX INTEGER (1..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an integer that ranges from 1 to 255 indicating the stratum
level of the local clock. Note: a primary time server sets outgoing NTP
packets stratum field and ntpSysStratum to 1.
::= { ntp 9 }
ntpSysPoll OBJECT-TYPE
SYNTAX INTEGER (6..10)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
When the time server is in NTP broadcast mode, this is an integer
indicating the maximum interval between successive NTP messages, in
seconds to the nearest power of two. For example a value of 6 means
2^6 or 64 seconds. Note: a primary time servers outgoing NTP packet
will have its poll field set to ntpSysPoll. Note: this field is equal
to 0 when not in NTP broadcast mode. Note, unless this is a time
server initiated NTP packet the value of the poll equals the value set
in the in coming packet.
::= { ntp 10 }
ntpSysPrecision OBJECT-TYPE
SYNTAX INTEGER (-127..127)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is an integer indicating the ultimate precision of the
synchronizing clock, in seconds to the nearest power of two. Note: a
primary time servers outgoing NTP packet will have its precision
field set to ntpSysPrecision.
::= { ntp 11 }
ntpSysRootDelay OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is a raw 32 bit number representing a signed fixed point 32-bit
number indicating the total round-trip delay to the primary
synchronization clock source in seconds with the fraction point
between bits 15 and 16. Note that this variable can take on both
positive and negative values, depending on clock precision and skew.
Note: a primary time servers outgoing NTP packet will have its root
delay field set to ntpSysRootDelay.
::= { ntp 12 }
ntpSysRootDisp OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is a raw 32 bit number representing a signed 32-bit fixed-point
number indicating the maximum error relative to the primary reference
source, in seconds with fraction point between bits 15 and 16. Only
positive values greater than zero are possible. Note: a primary time
servers outgoing NTP packet will have its root dispersion field set
to ntpSysRootDisp.
::= { ntp 13 }
ntpSysRefClockIdent OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..4))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is a four byte ASCII string identifying the particular reference
clock. In the case of stratum 0 (unspecified) or stratum 1 (primary
reference), this is a four-octet, left-justified, zero-padded ASCII
string. While not enumerated as part of the NTP specification, the
following are suggested ASCII identifiers:
Note, for TrueTime time servers only GPS, ACTS and IRIG are presently
used. Further, a primary time servers outgoing NTP packet will have
its reference identifier field set to ntpSysRefClockIdent.
::= { ntp 14 }
ntpControlInput OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
This variable emulates TrueTimes serial function command strings.
The same commands issued to the serial port can be sent to this
string. Use this variable for SNMP sets of functions strings.
Note, setting this variable clears ntpControlOutput to the null string.
See ntpControlOutput below.
::= { ntsControl 1 }
ntpControlOutput OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This variable emulates TrueTimes serial function command strings.
The same commands issued to the serial port can be sent to this string.
This variable holds the output result string from the last setting of
the above ntpControlInput variable. Use this variable for SNMP gets
of function strings. See ntpControlInput above.
::= { ntsControl 2 }
gpsGroupValid OBJECT-TYPE
SYNTAX INTEGER
{
gpsGroupIsInvalid (0),
gpsGroupIsValid (1)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
A test flag indicating if data contained in this SNMP GPS group is
valid or not. This flag equals 1 when GPS is used as the time
synchronization source and 0 for all other sources.
::= { gps 1 }
gpsNumTrackSats OBJECT-TYPE
SYNTAX INTEGER (0..8)
MAX-ACCESS read-only
STATUS current
DESCRIPTION The number of GPS satellites tracked.
::= { gps 2 }
gpsNumCurrentSats OBJECT-TYPE
SYNTAX INTEGER (0..8)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Current number of GPS satellites used in position and time fix
calculations. The number of satellites available depends on how long
the time server has been up, the time of day and the total amount of
clear sky as seen from the GPS antenna. Because of the high frequency
of GPS radio signals, GPS antennas must have unobstructed line of sight
from the antenna to the satellite to receive data.
::= { gps 3 }
gpsSatTrackMode OBJECT-TYPE
SYNTAX INTEGER
{
automaticMode (0),
timeMode (1),
surveyStaticMode (2),
surveyDynamicMode (3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Mode of operation for satellite tracking. See section 3.20 of the
users manual for a complete description of these modes. Generally,
modes 0 and 1 are used for time applications. Mode 2 is useful for
more accurate position information when the unit is stationary, or
slowly moving and mode 3 is for accurate position information when the
unit is moving quickly.
::= { gps 4 }
gpsSatMaxSigStrength OBJECT-TYPE
SYNTAX INTEGER (0..30)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Strongest signal strength of all tracking satellites in positive scaled
decibel units. Generally, this number should be 5 or greater for good
reception.
::= { gps 5 }
gpsAltitude OBJECT-TYPE
SYNTAX INTEGER (-2147483647..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Altitude of the GPS antenna in centimeters above, or below the
WGS-84 reference ellipsoid. The reference ellipsoid is a rotated
ellipse that is centered on the Earths center of mass. The surface
of the ellipsoid is not necessarily the same as sea level. The
ellipsoid surface may be as much as 100 meters different from actual
sea level.
::= { gps 6 }
gpsLongitude OBJECT-TYPE
SYNTAX INTEGER (-2147483647..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Longitude location of GPS antenna where: +2147483647 is
maximum east longitude, -2147483647 is maximum west longitude and 0 is
Greenwich England. To calculate the longitude in radians use the
following formula (gpsLongitude * PI) / ((2^31)-1) = longitude in
radians. For degrees: (gpsLongitude * 180) / ((2^31)-1) = longitude
in degrees. Note: longitude varies from -PI to +PI in radians and
-180 to +180 in degrees.
::= { gps 7 }
gpsLatitude OBJECT-TYPE
SYNTAX INTEGER (-2147483647..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Latitude location of GPS antenna where: +2147483647 is the
North Pole, -2147483647 is the South Pole and 0 is the equator. To
calculate the latitude in radians use the following formula
(gpsLatitude * PI) / (2*((2^31)-1)) = longitude in radians. For
degrees: (gpsLatitude * 90) / ((2^31)-1) = latitude in degrees.
Note: latitude varies from -PI/2 to +PI/2 in radians and -90 to +90 in
degrees.
::= { gps 8 }
actsGroupValid OBJECT-TYPE
SYNTAX INTEGER
{
actsGroupIsInvalid (0),
actsGroupIsValid (1)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
A test flag indicating if data contained in this SNMP ACTS group is
valid or not. This flag equals 1 when ACTS is used as the time
synchronization source and 0 for all other sources.
::= { acts 1 }
actsBaudRate OBJECT-TYPE
SYNTAX INTEGER
{
baud300 (300),
baud1200 (1200),
baud9600 (9600),
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Indicates the baud rate setting for the ACTS modem. The ACTS
dial-up service accepts 300 or 1200 baud. Note: this is a rare case
where faster is not better and 300 baud yields the best time accuracy.
::= { acts 2 }
actsFailRedial OBJECT-TYPE
SYNTAX INTEGER (0..9999)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
When the dial-up session fails to connect this is the time in
seconds to wait to try again.
::= { acts 3 }
actsMaxCallPeriod OBJECT-TYPE
SYNTAX INTEGER (0..999)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is the maximum time in minutes the ACTS unit will wait between
successful calls to the ACTS service.
::= { acts 4 }
actsPhoneNum OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..25))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
This is the phone number of the ACTS dial-up service, including
any prefixes needed to reach an outside line or international dialing.
Prefixes are separated by a comma from the main phone number.
::= { acts 5 }
actsNumberOfCalls OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Number of times the time server has called the ACTS dial-up
service - weather the call was successful or not.
::= { acts 6 }
actsGoodCalls OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Number of times the time server called the ACTS dial-up service
and successfully received the time.
::= { acts 7 }
actsBadCalls OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Number of times the time server called the ACTS dial-up service
and something was not right. This variable is the sum total of all
other ACTS failure types.
::= { acts 8 }
actsFailedInit OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Time servers internal modem failed to initialize. If this is
excessive, it may indicate a time server hardware failure.
::= { acts 9 }
actsNoDialTone OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Time servers internal modem found no dial tone. This may be
caused by a broken phone line to the time server.
::= { acts 10 }
actsNoCarrier OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Time servers internal modem found no carrier. No modem was
found at the other end and maybe the phone number for ACTS is wrong.
::= { acts 11 }
actsBusyLine OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Time servers internal modem found ACTS line busy.
::= { acts 12 }
actsNoAnswer OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The remote ACTS mode did not answer the call.
::= { acts 13 }
actsBadReply OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The syntax of the reply from remote modem was incorrect, possibly
due to line noise.
::= { acts 14 }
actsNoOnTimeMark OBJECT-TYPE
SYNTAX Counter
MAX-ACCESS read-only
STATUS current
DESCRIPTION
The reply from remote modem had no on time mark, possibly due to
line noise.
::= { acts 15 }
END
The Automated Computer Time Service (ACTS) is run by the National Institute of
Standards and Technology (NIST) in Boulder, Colorado.
ACTS allows computer users with modems to synchronize their clocks by telephone. The
phone number for ACTS is (303) 494-4774 (not toll free). Users can connect at speeds of
up to 9600 baud with 8 data bits, 1 stop bit, and no parity and obtain time signals with
standard uncertainty of 5 ms. To receive the full time code, you must connect at a speed
of at least 1200 baud.
The full time code is transmitted every second and contains more information than the
300 baud time code, which is transmitted every 2 seconds. The full time code looks like
this:
JJJJJ YRMODA HH:MM:SS TT L DUT1 msADV UTC(NIST) OTM
where
JJJJJ = the Modified Julian Date (MJD). The MJD is the
last five digits of the Julian Date, which is the
number of days since January 1, 4713 B.C. To get
the Julian Date, add 2.4 million to the MJD.
YRMODA = the date, showing the last two digits of the year, the
month, and the current day of month.
HH:MM:SS = the time in hours, minutes, and seconds. The time is
always sent as Coordinated Universal Time (UTC).
An offset needs to be applied to UTC to obtain local
time. For example, Mountain Time in the U. S. is
7 hours behind UTC during Standard Time, and
6 hours behind UTC during Daylight Saving Time.
TT = a two digit code (00 to 99) that indicates whether the
United States is on Standard Time (ST) or Daylight
Saving Time (DST). It also indicates when ST or
DST is approaching. This code is set to 00 when ST
is in effect, or to 50 when DST is in effect. During
the month in which the time change actually occurs,
this number decrements every day until the change
occurs. For example, during the month of October,
the U.S. changes from DST to ST. On October 1,
This appendix contains information on optional features that may have been added to your
device at the factory. For a standard device, it is normal for this appendix to be empty.
A
AC Model
Cabling 15
C
Power Specifications 5 Cabling 1516
Access 2, 40, 108 Change User Password (F100 P) 64
HTTP 31 Chassis 3, 16
Internet 4041 Cold Boot 17
Remote Control Lockout (F100 LOCK) 26 Commands
Remote Lockout (F100 LOCK) 76 and Responses, Serial/Telnet
Serial 4247 Common Elements 53
Web 31 Serial/Telnet
Accuracy 6 Format 49
Acquisition 13 List 5152
ACT (Connection Speed Indicator LED) 7 Semicolon used as replacement 50
ACTS 17 Community 108
Configuration Compatibility 55
Using FTP 7475 Configuration 108
Explanation of Full Time Code 125 ACTS
Modem 20 Using FTP 7475
Cabling 1516 Commands (F36 or F100) 55
Overview 125 NET Port
Port 9 Initial 2829
Synchronization Mode 19 Single Entry (F100) 59
Telephone Number 125 Using Serial/Telnet Commands 59
acts.conf file 75 Using the Internet 34
Administrator 29 NTP 69
Alphanumeric Front Panel Display 7, 42 Using FTP 6973
Default Display 21 Using the Internet 36
Power-Up Sequence 17 Remote Control Lockout (F100 LOCK) 26, 76
Antenna 34, 1213, 16, 18 SNMP
Feed Circuit Status (F72) 58 Using FTP 72
Installation 11 Using the Internet 38
Mast Mounting 13 Connection 2, 12, 31, 40, 43, 48, 60
Applications, List of Supported 8 Connector 2, 89, 12, 15, 42
Authentication 108 Control Session 39
Broadcast Mode with 7071, 101 Conventions 1
Broadcast Mode without 102103 Cross Check 96
Auto-Configure 61 Current Satellite 56
Automatic Time Out Current Time Source Request
For Display Security Feature 27 F100 T 66
Cursor 24, 28
B
Backward Compatibility 55
D
Bad Satellite 56 Data Packet
Broadcast Mode
Packet 6
Parameters
Network Configuration, Initial 2829 S
Password
Changing 86 Satellite 13
Web Interface 33 Acquisition 1718
Default Current 56
Serial/Telnet Interface 41 Enabled 56
Web Interface 33 Good/Bad 56
Protection 2427 Number Currently Tracked (F53) 55
Size 64 PRN Number 56
PDU 108 Tracked
Physical Specifications 3 List 56
Position 1, 18, 31, 89 Security 2427, 33, 86
Power Specifications 5 Automatic Time Out 27
Precision 9293 SNMP 108
PRN Number for Satellite 56 Self Test Status (F100 ST) 65
Procomm 40 Serial 2, 8, 12, 33, 40, 42
Protocols, List of Supported 6 Access 4247
Remote Control Lockout (F100 LOCK) 76
Commands
and Responses, Common Elements 53
R List 5152
Semicolon used as replacement 50
Rack Mounting Instructions 11 Interface, Login Passwords 86
RAM 65 Server 6, 31, 61
test status (F100 ST) 65 Renaming 70, 75
Receiver 13 Session 40, 47, 8990
Reference Timestamp 94 Timers 48
Remote Control SMI 6
Lockout (F100 LOCK) 76 SNMP 6, 8, 29, 107108
Remote Control/Configuration Configuration
Lockout (F100 LOCK) 26 Using FTP 72
NTP 36 Using the Internet 38
SNMP 38 "get" and "set" Commands 67
Through Web Pages 31 SNTP 2, 6, 8
RFC-1155 6 Client 6
RFC-1157 6, 107 V 3.0 Data Format (RFC-2030) 95
RFC-1212 6 Software Version Request
RFC-1213 6, 107108 F100 VER 66
RFC-1305 2, 6, 91, 94, 100 F18 54
RFC-1321 6, 100 Specifications
RFC-1354 107 Environmental 4
RFC-2030 2, 6, 95 Interface 8
RFC-2068 and 2616 6 Internal Timing Performance 5
RFC-2132 6 NTP Synchronization 6
RFC-854 6 Physical 3
RFC-867 6, 106 Power 5
RFC-868 2, 6, 125, 127 Status Indicators (LED) 7
RFC-959 6 Status Message Window 33
RG-58 13 Storage Altitude 4
RG-59 3, 13 Stratum 9293
RJ-11 9, 12, 16 Structure of Management Information (SMI) 6
RJ-45 2, 8, 12, 16 Subnet Mask (F100 SM) 63
Rolling Redundancy 22 Supported Applications 8
Root Delay 93 Supported Protocols 6
RS-232 8, 12, 16, 42 Survey Static Mode 55
U
UDP 6, 91, 105106, 111
User Password
Changing (F100 P) 64
UTC 21, 54
Time 18, 23, 105106
Default Format 21
Utility Port 40, 42, 51, 89
Session Timer 48
W
Warranty 2
Web
Access 31
Browser 3132, 48
Addresses 91, 100, 107