Timecreator 1000
Timecreator 1000
Timecreator 1000
User’s Guide
Revision C – February 2010
Part Number 097-93100-01
Symmetricom, Inc.
2300 Orchard Parkway
San Jose, CA 95131-1017
U.S.A.
http://www.symmetricom.com
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
DHCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Logging In And Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Adding And Deleting Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Saving The Present Configuration To Non-volatile Memory. . . . . . . . . . .66
Restoring Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Determining Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Enabling Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Setting The Output To Test Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Configuring For Default Mode (Real Time Clock) . . . . . . . . . . . . . . . . . . .67
Configuring For User Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Configuring For GPS Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Configuring For NTP Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Configuring For Subtending Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Forcing Unit To Send New Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Setting Manual Cable Advance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Setting Auto Cable Advance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Configuring Static IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Configuring Dynamic IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Switching Active And Standby Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Chapter 5 Provisioning
Establishing a Connection to the TimeCreator 1000. . . . . . . . . . . . . . . . . . . . .72
Communicating Through the Serial Port. . . . . . . . . . . . . . . . . . . . . . . . . .72
Communicating Through the Ethernet Port . . . . . . . . . . . . . . . . . . . . . . .72
Managing the User Access List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Adding a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Deleting A User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Displaying Current Users and User Access Levels . . . . . . . . . . . . . . . . .76
Displaying Logged in Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Changing a User’s Password and Access Level . . . . . . . . . . . . . . . . . . .77
Managing the IP Address Whitelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Add an IP Address to the Whitelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Delete an IP Address From the Whitelist . . . . . . . . . . . . . . . . . . . . . . . . .79
Set the Whitelist to Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Provisioning Login Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Provisioning the TC1000 for Login Authentication . . . . . . . . . . . . . . . . . .79
Configuring the RADIUS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
Configuring the TACACS+ Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
097-93100-01 Revision C – February, 2010 TimeCreator 1000 User’s Guide 5
Table of Contents
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295
3-1 Management and NTP Server Ethernet Connector Pin Assignments . . . . .54
3-2 Serial Port Connector Pin Assignments. . . . . . . . . . . . . . . . . . . . . . . . . . . .54
3-3 DTI and Root DTI Connector Pin Assignments . . . . . . . . . . . . . . . . . . . . . .56
3-4 Installation Completeness Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
3-5 Module LED Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
In This Preface
Purpose of This Guide
Who Should Read This Guide
Structure of This Guide
Conventions Used in This Guide
Warnings, Cautions, Recommendations, and Notes
Related Documents and Information
Where to Find Answers to Product and Document Questions
What’s New In This Guide
The TimeCreator 1000 User’s Guide describes the procedures for unpacking,
installing, using, maintaining, and troubleshooting the Symmetricom TimeCreator
1000 DOCSIS Timing Interface Server (TimeCreator 1000). It also includes
appendixes that describe alarms and events, the languages that you use to
communicate with the TimeCreator 1000, default values, and other information.
While Chapter 1 is written for non-technical audiences who need information about
the TimeCreator 1000 system, others, such as Chapter 2 through Chapter 6 contain
detailed information and instructions which are intended to be performed by
qualified personnel only.
Chapter 1, Overview of the Provides an overview of the product, describes the major
TimeCreator 1000 hardware and software features, and lists the system
specifications.
Chapter 2, Engineering and Lists the part number and ordering procedure for all TimeCreator
Ordering Procedures 1000 parts and accessories.
Chapter 3, Installing the Contains procedures for unpacking and installing the system, and
TimeCreator 1000 for powering up the unit.
Chapter 4, General Guidelines for Provides basic information to which users can refer to ensure
using the Symmetricom proper system operation.
TimeCreator 1000
Chapter 5, Provisioning Describes the commands and procedures required to provision the
TimeCreator 1000 after installing the unit.
Chapter 6, Maintenance and Contains preventive and corrective maintenance, and
Troubleshooting troubleshooting procedures for the product.
Appendix A, Alarms, Events and Lists the alarms and events and provides basic indications of the
SNMP Traps source of the alarm.
Appendix B, Command Describes the CLI command conventions, functions, and features
Descriptions and and the SNMP, NTP, SSH, and SFTP protocols.
Communications Interface
Appendix C, Installing the Provides procedures for installing a GPS antenna and connecting
Two-Way GPS Antenna it to the TimeCreator 1000.
Appendix D, Specifications and Lists the specifications for the TimeCreator 1000.
Factory Defaults
Appendix E, Software Licenses Contains licensing information for third party software.
Index Provides references to individual topics within this guide.
Acronyms and Abbreviations – Terms are spelled out the first time they appear
in text. Thereafter, only the acronym or abbreviation is used.
Revision Control – The title page lists the printing date and versions of the
product this guide describes.
Typographical Conventions – This guide uses the typographical conventions
described in the table below.
Select File, Open... Click the Open option on the File menu.
Note: All notes use this symbol. Notes contain installation, operation,
or maintenance procedures, practices, conditions, or statements, that
alert you to important information, which may make your task easier
or increase your understanding.
See your Symmetricom representative or sales office for a complete list of available
documentation.
For additional information about the products described in this guide, please contact
your Symmetricom representative or your local sales office. You can also contact us
on the web at www.symmetricom.com.
History
Clear log
In This Chapter
Overview
Performance Monitoring
Physical Description
Functional Description
Communication Ports
Outputs
Reference Inputs and TOD Sources
Alarms
Overview
The TimeCreator 1000, shown in Figure 1-2, is a DOCSIS Timing Interface (DTI)
Server that delivers accurate timestamp and frequency synchronization, and with
GPS it can also provide Time of Day (TOD) to DTI client elements in a Modular
Cable Modem Termination System (M-CMTS) architecture. M-CMTS elements
shown in Figure 1-1 (Edge QAMs, Upstream Receivers, M-CMTS Core, etc.) use
DTI to synchronize the DOCSIS Timestamp and Symbol Clock used in the DOCSIS
communications between modems and the headend/hub. The TimeCreator 1000
functions as either a root server or subtending server. The root server is at the top of
a server hierarchy and is the source of traceable time and frequency for all
subtending DTI servers and clients in a building. The subtending server receives its
time and frequency reference through a direct connection to a root server’s DTI link
connector; a subtending server cannot be referenced to another subtending server.
A TimeCreator 1000 in a root server configuration can use either its internal clock as
the master frequency for the headend/hub meeting DOCSIS specifications, or it can
be configured to use GPS. GPS is required for Business Services over DOCSIS
(BSoD), which allows you to deliver T1, E1, and NxDSO emulation services. GPS is
also required to implement Network Time Protocol (NTP) server mode, which allows
common time between headends/hub and other applications. NTP, the
user-specified time, and the IMC’s real-time clock (RTC) can also be used as a
basis for the DOCSIS timestamp to provide system TOD for operation in free-run
mode only.
Shelf
The TimeCreator 1000 shelf requires a minimum of three plug-in modules to
operate:
It is recommended that a second Power Supply module and IOC are added to the
configuration for redundant operation. Since the TimeCreator 1000 provides the
Master DOCSIS Clock and Timestamp for the entire Headend or Hub site, it is
designed to provide high reliability through redundancy, although redundancy is not
required. The flexibility of configuration and therefore cost enables various
deployment scenarios for root, slave, and protected architectures.
Input Signals
The TimeCreator 1000 can use either GPS or DTI signals as external input
references to acquire the system’s frequency, DTI timestamp, and TOD alignment.
NTP and the user-specified time from the IMC’s real-time clock (RTC) can also
provide system TOD with much less accuracy. See Table 1-1 for descriptions. Only
GPS can provide a common timestamp across the network for a distributed
M-CMTS deployment. It is suggested that all root TimeCreator 1000 servers be
configured with GPS. Upgrading any DTI Server from a user time or NTP time to
GPS for BSoD or distributed M-CMTS architectures will require resetting the
DOCSIS Timestamp and thus re-range all cable modems. The GPS input connects
to the TNC connector on the IMC and the DTI input from a root DTI Server connects
to the rear panel port A and port B RJ-45 connectors (labeled A/11 and B/12). NTP
runs on the IMC’s management Ethernet port.
Note: When ports A/11 and B/12 are provisioned as outputs, they are
referenced as Ports 11 and 12.
DTI External DTI signals used as external input references to acquire the
system’s frequency, DTI timestamp, and TOD.
NTP NTP server used to acquire the TOD. Frequency is provided by IOC’s
clock in freerun mode.
Real-Time Clock Clock on IMC used to acquire the TOD. Frequency is provided by
IOC’s clock in freerun mode.
Output Signals
The TimeCreator 1000 passes frequency and TOD output through rear panel DTI
links. Ports 1 through 10 (12-port version) or Ports 1 through 6 (8-port option) are
permanent output ports. Ports A/11 and B/12 can be provisioned as either outputs
or inputs.
Note: When ports A/11 and B/12 are provisioned as inputs, they are
referenced as ports A and B.
Communications Ports
The EIA-232 serial and Ethernet connections are located on the IMC. The EIA-232
serial and Ethernet connections allow you to provision the system from a terminal or
computer running a terminal emulation application.
8 data bits
1 stop bit
no parity
9600 baud rate (57600 is supported only in the IMC rev H version 1.00.13 or
below)
Flow Control: None
Ethernet
An Ethernet connector provides connectivity to a local area network (LAN) and each
port can be assigned a unique internet protocol (IP) address (see Communicating
Through the Ethernet Port, on page 72). Once the IP address is set and a
connection is made, you can access the TimeCreator 1000 on an intranet. The
Ethernet port supports two simultaneous connections to port 23.
Clock Design
The TimeCreator 1000 clock design includes a highly stable ovenized Quartz crystal
to produce accurate synchronization outputs. In a dual-IOC configuration, the clock
function is redundant to provide protection. Each IOC qualifies the input signal and
filters jitter and wander noise elements that may exist. In the event that all input
references are lost or disqualified, the unit goes into holdover mode with the
oscillator providing the system reference.
Operating Modes
The TimeCreator 1000 has the following operating modes:
Note: In Frequency Mode, DTI output and IMC GPS are not in sync.
Performance Monitoring
Phase Measurements
TheTimeCreator 1000 measures phase data. Peak to peak jitter and MTIE results
are calculated for the user. Frame error rate (FER) is also calculated and made
available to the user. It is calculated over a 10-second window.
MTIE Calculations
MTIE is a measure of the relative noisiness of a signal that relates to frequency
offsets and phase transients. The TimeCreator 1000 automatically calculates MTIE
for each enabled input from the most recent 1000 seconds. From this calculation,
you can retrieve MTIE values for 35-second and user-configurable windows. You
can set an alarm threshold for each of these windows; if the MTIE value exceeds
this threshold and the alarm is enabled, the TimeCreator 1000 generates an alarm.
Physical Description
The TimeCreator 1000 consists of a 19-inch (48 cm) rack mount shelf, plug-in
modules, AC power supply cables and optional GPS cables, and hardware.
Note: 23-inch (58.42 cm) rack mounting brackets are also available
as a separately ordered item.
The front of the TimeCreator 1000 has two IOC module slots and one IMC module
slot. The rear has two power supply slots, twelve DTI link connectors and two BITS
connectors (see Figure 1-4). The minimum configuration is one Power module, one
IOC module, and an IMC module. The second IOC and Power module slots are
available for redundancy.
Input/Output Clock (IOC) Information Management Card (IMC) Input/Output Clock (IOC)
AC Power Supply DTI Client/Server Links DTI Client Links AC Power Supply
Functional Description
The TimeCreator 1000 accepts one GPS input and two DTI inputs for system
reference and it allows you to provision the DTI input reference priority. When a
GPS or DTI reference is qualified as the system reference, the server uses the
qualified reference to acquire the system’s frequency, DTI timestamp, and TOD
alignment.
The TimeCreator 1000 rear panel has ten DTI client links (six DTI client links for
8-port option) and two client/server links. Client links connect to an M-CMTS Core,
Upstream receiver, Edge QAM, or DTI server. Server links allow a subtending
server to receive time and frequency signals from a DTI root server. There are also
two T1/E1 BITS frequency inputs.
Figure 1-5 is a block diagram of the TimeCreator 1000, Figure 1-6 is a block
diagram of the IMC card, and Figure 1-7 is a block diagram of the IOC card.
IOC Module
The IOC module has LED status indicators and test outputs for the system. The
LEDs indicate:
Power Status
Active Status
Output Status
External Reference Status
Alarm Status
Holdover Status
The test output connectors provide a 10.24 MHz master clock signal and a 10 kHz
DTI frame clock signal.
IMC Module
Connectors for Ethernet management, NTP time server, EIA-232 serial, and the
Two-Way GPS Timing Antenna connections are located on the IMC module. The
IMC’s LEDs indicate the following:
Power Status
Alarm Status
GPS Signal Status
Power Module
The TimeCreator 1000 allows either –48 V DC power connection, or 120/220 V AC
power connection depending on the type of module used. The LED indicates power
status.
Each DTI link connection has associated LEDs that indicate connection status.
Communication Ports
Communications ports on the IMC allow you to provision, monitor, and troubleshoot
the shelf. You communicate with the TimeCreator 1000 using either CLI or SNMP
protocols.
Baud = 9600 baud rate (57600 is supported only in the IMC rev H version 1.00.13
or below)
Word Length = 8 bits
Parity = None
Stop bits = 1
Software Handshaking, Xon/Xoff
Outputs
The DTI link connectors use a single pair for transmission in both directions. The
server and client alternate data transmission therefore eliminating the need for a
crossover connection. The DTI server output is a Manchester encoded frame with
an underlying bit-rate of 5.12 Mbps locked to the DTI Master Clock. You can enable
or disable each output individually through user commands (see the command Set
Interface, on page 213). The TimeCreator 1000 automatically calibrates each DTI
Output when a DTI Client is connected eliminating the need to manually
compensate for cable lengths. The maximum cable length is 656 Ft. (200 m).
The TimeCreator 1000 provides a 10.24 MHz master clock signal and a 10 kHz
frame clock on the front panel.
The TimeCreator 1000 can use either GPS or DTI signals as external input
references to acquire the system’s frequency, DTI timestamp, and TOD alignment.
The GPS reference signal input connects to a TNC connector on the IMC module
and the DTI reference signal input is connected to RJ-45 connectors labeled A/11
and B/12 on the rear panel. The Set Interface Priority user command allows you to
set priority levels for the two DTI reference signals (see the command Set Interface,
on page 213).
Note: When ports A/11 and B/12 are provisioned as outputs, they are
referenced as ports 11 and 12.
NTP, the user-specified time, and the IMC’s real-time clock (RTC) provide system
TOD for operation in free-run mode only, as shown in Table 1-1.The default settings
provision the TimeCreator 1000 to operate in free-run mode only.
Note: The BITS input connectors are not functional in this release.
It is recommended that the root server in a DTI network with root and subtending
servers be referenced to GPS. Using GPS allows the user to recover from root
server outages with minimal cable modem re-ranging. The root server can be set to
user mode and still provide protection from excessive re-ranging, but requires some
additional network resources to enable an orderly network recovery from any major
root outages. If, for example, a power outage affects the root server, it must have a
way to recover the previous network time and phase when it returns to normal
operation. To do this the TimeCreator has a 'Root-Server Recovery' function that
re-synchronizes the root server to the rest of the network. To accomplish this there
has to be a connection between the root server, port 12 and a subtending server
port 1, with port 12 of the root server set as a Client, but not enabled. When the root
server recovers power (or has been serviced) it will automatically query time from a
subtending server so that it will not cause unnecessary cable modem re-ranging.
See Provisioning Root Server Recovery Mode, on page 95 for details.
Alarms
The TimeCreator 1000 uses alarms to notify you when certain conditions are
deteriorating below user-specified levels. These alarms are indicated by module
status LEDs and by SNMP traps. You can provision the alarm to either be enabled
or disabled and the current alarm state can be obtained via the communication
ports. For more information, see Provisioning Alarms, on page 105 and Appendix A,
Alarms, Events and SNMP Traps.
This chapter describes the items available for the TimeCreator 1000, and lists the
part number for each item.
In This Chapter
Overview
TimeCreator 1000 Part Numbers
User-Supplied Tools and Materials
Overview
1 Shelf
1 IMC module
1 AC or DC power module
1 12-port or 8-port IOC module
1 Shelf
1 IMC module
2 AC or DC power modules
2 12-port or 2 8-port IOC modules
System Configurations
This section provides part numbers and descriptions for the various system
configurations and parts available for the TimeCreator 1000. Table 2-1 provides a
list of common configurations and Table 2-3 lists the shelf component and
accessory part numbers.
TimeCreator 1000 - NA AC Power (1 SH, 1 IMC, 2 IOC, 2 AC) - see Table 2-6 990-93105-01
TimeCreator 1000 - NA AC Power, 8port IOC (1 SH, 1 IMC, 2 IOC-8 port, 2 AC) - 990-93105-02
see Table 2-7
TimeCreator 1000 - DC Power (1 SH, 1 IMC, 2 IOC, 2 DC) - see Table 2-8 990-93106-01
TimeCreator 1000 - NA AC Power (1 SH, 1 IMC, 2 IOC, 2 AC, GPS) - see Table 990-93107-01
2-9
TimeCreator 1000 - DC power (1 SH, 1 IMC, 2 IOC, 2 DC, GPS) - see Table 2-10 990-93108-01
TimeCreator 1000 - NA AC Power (1 SH, 1 IMC, 2 IOC, 2 AC, GPS, NTP) - see 990-93109-01
Table 2-11
TimeCreator 1000 - DC power (1 SH, 1 IMC, 2 IOC, 2 DC, GPS, NTP) - see Table 990-93110-01
2-12
Configuration part numbers, as shown in Table 2-1, are of the form 990-xxxxx-0y.
For AC configurations the y value in the part number corresponds to the power cord
configuration. See Table 2-2. For example, the part number for a basic TimeCreator
1000 with no redundancy and a North American (NA) power cord is 990-93105-01.
The part number for a basic TimeCreator 1000 with no redundancy and a European
(EU) power cord is 990-93105-02. With a United Kingdom (UK) power cord, the part
number for a basic TimeCreator 1000 with no redundancy is 990-93105-00.
North American NA 1
European EU 2
United Kingdom UK 0
Table 2-7. TimeCreator 1000 - NA AC Power & Rdnt Clk, 8port - P/N 990-93105-02
Table 2-7. TimeCreator 1000 - NA AC Power & Rdnt Clk, 8port - P/N 990-93105-02
You need to supply the following tools and materials for installing and testing the
TimeCreator 1000.
These standard tools and materials are not supplied, but may be required for
installing the GPS antenna and the Two-Way Antenna Interface:
This chapter describes the procedures for installing the TimeCreator 1000.
In This Chapter
Getting Started
Unpacking the Unit
Rack Mounting the Shelf
Working With Modules
Making Signal Connections
Making Ground and Power Connections
Installation Check List
Applying Power to the TimeCreator 1000
Getting Started
Before you begin to install the TimeCreator 1000, review the information in this
section.
Site Survey
Before you begin installation, determine the shelf location, ensure the appropriate
power source is available (–48 V DC or 120/220 V AC depending on power module
type), and ensure that the equipment rack is properly grounded.
The TimeCreator 1000 is designed to mount in a 19-inch (48 cm) rack, occupies
1.75 in (4.5 cm, 1 RU) of vertical rack space, and has a depth of 20 in (50.8 cm).
Note: 23-inch (58.42 cm) rack mounting brackets are also available
as a separately ordered item.
Environmental Requirements
To prevent the unit from malfunctioning or interfering with other equipment, install
and operate the unit according to the following guidelines:
The TimeCreator 1000 is packaged to protect it from normal shock, vibration and
handling damage.
3. Open the container, being careful to cut only the packaging tape.
4. Locate and set aside the printed information and paperwork that is included in
the container.
5. Remove the unit from the container and place it on an anti-static surface.
6. Locate and set aside small parts which may be packed in the container.
9. Verify that the model and item number shown on the shipping list agrees with the
model and item number on the equipment. The item number can be found on a
label affixed to the unit. Contact your Symmetricom distributor if the model or
item number do not match.
The installation procedure described in this section provides general guidelines for
installing the TimeCreator 1000. Always follow applicable local electrical codes.
Use the following steps to mount the TimeCreator 1000 in a 19- or 23-inch (48 or
58.42 cm) rack.
1. If necessary, attach the rack mounting brackets to the shelf using 6-32 x 1/4-inch
screws. Ensure that the mounting brackets on both sides are attached at equal
distances from the front of the unit (see Figure 3-1).
2. Mount the shelf to the front of the equipment rack rails with four screws and
associated hardware. Use the proper screws for the equipment rack.
This section describes how to install, remove, and handle the modules associated
with the TimeCreator 1000.
Handling Modules
When handling any of the modules, observe the following precautions:
1. Use proper static control precautions when handling modules! Protect the
equipment against ESD (electrostatic discharge) by using a grounded protective
wrist strap and normal equipment grounding.
Inserting Modules
This procedure is common for all modules.
1. Align the module edges within the guides of the selected slot.
2. Slide the module into the chassis and press firmly until it seats fully into its
backplane edge connector. Handles on each side of the faceplate are provided
for removing and inserting the module.
Removing Modules
Caution: You must disconnect the GPS antenna before removing the
IMC module or removing ground connection.
To remove a module, loosen the captive screws and then pull out on the handles
located on each side of the module. Be sure to place the module on a static-free
surface.
The connectors for the GPS input signal, Management and NTP Server Ethernet
connections, and EIA-232 serial connection are located on the IMC module. The
rear panel has RJ-45 connectors for ten client DTI links, two DTI client/server links,
and two T1/E1 BITS frequency links.
Table 3-1. Management and NTP Server Ethernet Connector Pin Assignments
Not Used 4, 5, 7, 8
Figure 3-3 shows the EIA-232 connector pin assignments for the serial port.
Table 3-2 describes the EIA-232 connector pin assignments for the serial port.
Signal Pin
Ground 5
GPS Connections
The TimeCreator 1000 GPS input TNC connector is located on the IMC. To connect
a GPS signal, you must install a GPS antenna. For detailed installation instructions,
see Appendix C, Installing the Two-Way GPS Antenna. In addition to the installation
instructions, this appendix also provides a list of the standard tools you will need
and a list of available parts. See Working With Modules, on page 51 for module
installation instructions.
Caution: The GPS cable should only be connected while the unit is
properly grounded.
http://www.symmetricom.com/resources/downloads/application
-notes
DTI Connectors
The DTI server and client connections are shielded RJ-45 receptacles on the rear
panel and they are standard 10Base-T/100Base-T connectors. The client
connectors are ports 1 through 10 and additionally ports 11 and 12 if these two ports
are provisioned as outputs. The server connectors are ports A and B if these two
ports are provisioned as inputs.
If the root server in a DTI network with subtending servers is set to user mode to
utilize root server recovery, a connection should be made from the root server port
12 to a subtending server port 1. This enables root server recovery, in an orderly
manner, from any outages affecting the root server
Not Used 3, 4, 5, 6, 7, 8
Note: The 8-port option only uses Ports 1 through 6, A/11 and B/12.
Ports 7 through 10 cannot be enabled for this option.
The TimeCreator 1000 has the option of using either 120/220 V AC, or –48 V DC
power. For non-redundant operation, install either one AC module or one DC
module. For redundant operation, install either two AC modules, two DC modules,
or one AC and one DC module (see Figure 3-6).
Ground Connections
After installing the TimeCreator 1000 into the rack, connect the shelf to the proper
grounding zone or master ground bar. The grounding lug is a screw on the side of
the unit, near the back. Using a ring terminal on the 12 AWG wire, connect the
ground lug to permanent earth ground
Power Connections
Install the appropriate power module and make the power connections as follows:
DC Power
1. Ensure the power source is turned off.
4. Using 16 AWG (minimum) stranded wire, connect primary power to the terminal
screws. Symmetricom recommends that you use a #6 spade lug termination for
each power lead.
AC Power
1. Ensure the power source is turned off.
2. Connect the power cord to the power connector on the 120V-220V AC Power
Module.
Note: The AC power socket contains two 2 amp fuses: one in line
and one spare.
To verify that the installation of the TimeCreator 1000 is complete, perform the
checks and procedures in Table 3-4.
Operation Complete
Ensure that the appropriate modules (and filler panels if needed) are
installed
Verify that all power and ground wires are installed correctly and securely
Verify that all input and output cables are properly installed
The TimeCreator 1000 is not equipped with a Power switch. DC power is controlled
by a power distribution panel. AC power is applied when a standard 120 or 220
V AC power cord connected to the 100-240 AC Power module is plugged into the
appropriate power outlet.
Power Module
IMC Module
IOC Module
DTI Links
A/11 - B/12 DTI Off Disabled, or Enabled and qualified as reference input
Client State
Amber Enabled and not qualified as reference input
A/11 - B/12 DTI Off Disabled or not connected to DTI Server
Client Connection
Green Connected to DTI Server
Status
A/11 - B/12 DTI Off Disabled, or client operating normally
Server State
Amber 1. Enabled, client indicates Warm-up, Free-run,
Holdover, or Acquire states
2. In Test Mode, the DTI Output State LED and DTI
Server Port Connectivity Status LED alternate
being ON and OFF
A/11 - B/12 DTI Off Disabled or not connected to DTI client
Server Connection
Green 1. Connected to DTI client
Status
2. In Test Mode, the DTI Server Port State LED and
DTI Server Port Connectivity Status LED alternate
being ON and OFF
1 - 10 Off Disabled, or client operating normally
DTI Server State
Amber 1. Enabled, client indicates Warm-up, Free-run,
Holdover, or Acquire states
2. In Test Mode, the DTI Output State LED and DTI
Server Port Connectivity Status LED alternate
being ON and OFF
1 - 10 Off Disabled or not connected to DTI client
DTI Server
Green 1. Connected to DTI client
Connection Status
2. In Test Mode, the DTI Server Port State LED and
DTI Server Port Connectivity Status LED alternate
being ON and OFF
This chapter provides basic information to which users can refer to ensure
proper system operation.
In This Chapter
Clock Operations
GPS
NTP Client Mode
DHCP
CLI commands
Clock Operations
For TOD sources of RTC, User, and NTP, the unit initially sets the time from the
selected source. The unit then operates in freerun after that, keeping time according
to its local oscillator frequency.
The user can force an update in the User and NTP modes. In GPS mode, the initial
time is set from GPS, and the unit maintains frequency and phase lock to GPS.
When recovering from extended holdover, the frequency is locked to the GPS
reference. If the phase error is small, the phase is corrected by slewing. If the phase
error is large, an alarm is generated and the user will need to manually correct the
phase. This prevents unmanaged discontinuities of the DOCSIS time stamp.
GPS
For details on proper installation of the GPS antenna, refer to Appendix C. Proper
cable, grounding techniques, and lightning arrestors should be used. Mount the
antenna outside, preferably on the roof with a clear view of the sky. Do not mount
the antenna near a wall or other obstruction blocking part of the sky. Mount the
antenna well above roads or parking lots.
Allow at least one hour for the unit to track and lock to GPS.
If the system time is off by more than four hours, then the system mode should be
set to user mode and the time set to within four hours. The unit can then be
configured to use NTP.
Since the unit only sets the time once, the time could be off by more than 100 ms if
this procedure is not followed.
DHCP
This unit's DHCP client will not continually attempt to acquire an IP address if the
Ethernet cable is not connected at power up, or when DHCP mode is enabled.
After the cable is connected, enter the following commands to restart DHCP:
CLI commands
Example
Enter the following command to backup the current IOC configuration in the IMC
card:
Enter the following command to backup the current IMC configuration in the IOC1
card:
Enter the following command to backup the current IMC configuration in the IOC2
card:
Determining Status
Enter the following commands to display current alarms, the unit status, GPS
information, and inventory:
Show inventory
Enabling Outputs
Enter the following command to set the interface state.
Show clock
If the unit is not ready when the “sync tod-source now” command is issued, actual
execution of this command is postponed until the unit is ready. Use the “show
alarms” command to check for the presence of the “jam sync required” alarm to
indicate readiness.
This command should also be entered after you change the time in user mode.
Configuring Static IP
Example for host ip address of 192.168.5.2, with router gateway at 192.168.5.1:
Set ip-state eth0 disable
Configuring Dynamic IP
Ethernet cable should already by connected and DHCP server configured:
This chapter describes the procedures for provisioning the TimeCreator 1000. Use
the procedures in this chapter after you have installed and powered up the
TimeCreator 1000 (see Chapter 3, Installing the TimeCreator 1000).
In This Chapter
Establishing a Connection to the TimeCreator 1000
Managing the User Access List
Managing the IP Address Whitelist
Provisioning Login Authentication
Provisioning Services
Provisioning the Ethernet Ports
Setting the System Date, Time and Time Offset
Setting the DTI Server Type
Provisioning the Input Reference
Provisioning the DTI Links
Provisioning Revertive and Non-Revertive Mode
Provisioning Root Server Recovery Mode
Provisioning SNMP
Provisioning an NTP Server
Provisioning Cable Advance
Provisioning Alarms
Routine Operation Commands
Saving and Restoring Provisioning Data
To set up and manage the TimeCreator 1000 with a terminal or a computer with
terminal emulation, you must establish either a serial connection or an Ethernet
connection. To connect through the serial port, see Communicating Through the
Serial Port, on page 72. If the TimeCreator 1000 is connected to an Ethernet LAN,
use the procedure described in Communicating Through the Ethernet Port, on page
72.
1. Connect one end of a straight cable to the serial port on the computer or terminal
and the other end to the EIA-232 connector on the IMC.
2. Configure the emulation software for 8 data bits, 1 stop bit, no parity, and 9600
baud rate.
3. Start the terminal emulation software and press Enter. The system prompt
should appear. If it does not, recheck each step in this procedure.
2. Provision the IP, Gateway, and Subnet Mask addresses for the TimeCreator
1000. The IT department or site administrator for your location can recommend
specific addresses for these parameters. The mask is specified as a prefix
number which is the number of 1's from the MSB with the remaining bits set to 0.
For example 255.255.255.0 is set with the value 24.Use the dotted decimal
format xxx.xxx.xxx.xxx to enter the address parameter with the following
commands:
Example
2. Telnet from your PC to the IP address assigned to the TimeCreator 1000 (see
Configuring the Ethernet Port, on page 73).
3. Type your user name and press Enter. If you are not assigned as a user in the
system, contact the system administrator or see Adding a User, on page 75.
4. Type your assigned password and press Enter. The system prompt appears.
When you are logged in at the Admin level you can add, edit, or delete user names
in the user access list. The user list can contain up to 20 names and users can be
set to one of three different security levels described in Table 5-1. Users are
required to enter a user name and password to log in to the system. Users can
access or modify only the parameter settings allowed by their assigned security
level.
Caution: After three failed login attempts the user account is locked
out for 15 minutes; this includes the admin user. To avoid a service
call, it is recommended that at least two admin-level users be
configured.
User Users can edit their password and retrieve information, or access
any command at the User security level.
Admin Users are allowed to modify the security database or download new
firmware and issue commands at any level.
Use the procedures in this section to manage user access to the TimeCreator 1000.
Login
Use the following procedure to log in to the system at the admin level.
If the TimeCreator 1000 is connected to a PC directly through the serial port, start
a session and press Enter.
3. Type your user name and press Enter. The system prompts for a password.
4. Type your password and press Enter. The system prompt appears.
Note: The unit’s default user name is admin and the default password
is SymmTC1000. To avoid unauthorized access, you should change
the default user name and password.
Adding a User
Use the following procedure to add a user to the system access list.
Note:
/ ( ) | \ ; : “ ‘ , < >
2. Type show user and press Enter to view the current list of users.
3. Type set user add and press Enter. The system prompts you for a user name.
4. Type a user name and press Enter. The name you enter will be the log-in name
for the user. The system prompts you for the user access level.
5. Type the user access level and press Enter. The system prompts you for a
password.
6. Type a password and press Enter. The password you enter will be the log-in
password for the user. The system responds with the confirm password prompt.
8. Type show user and press Enter to verify that the account exists (repeat steps
3, 4, 5, 6, and 7 to add other users).
Deleting A User
Use the following procedure to delete user ABC from the system access list.
2. Type show user and press Enter to view the current list of users.
2. Type show user and press Enter. The system displays the current list of users.
2. Type show logged-in-user and press Enter. The system displays the current
list of users who are logged in.
Note:
/ ( ) | \ ; : “ ‘ , < >
2. Type show user and press Enter to view the current list of users.
3. Type set user password <user> and press Enter. The system prompts you
for a password.
4. Type the user’s password and press Enter. The system responds with the
confirm password prompt.
The whitelist feature in TimeCreator allows the user to filter IP access addresses to
prevent malicious attacks. In the default condition, all IP addresses are allowed
access. Once the first IP address has been added to the whitelist, any future IP
sessions will only be accepted if they originate from IP addresses from the whitelist.
This feature is useful when the management port is connected to a public network
rather than a private network.
The whitelist must be committed before any changes to the whitelist will be
implemented.
Note: If the whitelist function is being use for a TimeCreator 1000 with
the TOD-source of NTP, the local host address (127.0.0.1) should be
added to the whitelist with the command “set whitelist add
127.0.0.1”.
2. To view the current list of IP addresses on the whitelist, type show whitelist
and press Enter.
3. To add a specific IP address to the whitelist, type set whitelist add <ip
address> and press Enter. (For example, set whitelist add
192.168.5.10).
4. To add IP addresses using a subnet mask, type set whitelist add <ip
address>/<ip mask> and press Enter. The mask indicates which parts of the IP
address are significant it is specified as a prefix number which is the number of
1s from the MSB with the remaining bits set to 0. A mask of 255.255.255.0 is set
with the value 24. (For example, set whitelist add 192.168.5.0/24) The
default value is 32, or 255.255.255.255, to match the full 32-bit IP address. .
2. To view the current list of IP addresses on the whitelist, type show whitelist
and press Enter.
3. Type set whitelist delete <ip address> and press Enter. (For example,
set whitelist delete 192.168.5.10).
The authentication scheme used in the TimeCreator 1000 allows you to provision
either a RADIUS or TACACS+ server IP address and authentication key(s) for
server access. If RADIUS or TACACS+ is enabled, the system allows local login if
the server doesn't authenticate the user and the user is configured locally.
3. Type set authentication radius key <key> and press Enter (key is up to
32 ASCII characters).
TACACS+ Server
To provision the TACACS+ server IP address and the authentication key for server
access:
3. Type set authentication tacacs+ key <key> and press Enter (key is up to
32 ASCII characters).
Table 5-2. Security Levels vs. RADIUS Server Class Attribute Settings
User 1-4
Power-user 5-9
Admin 10 - 15
Listed below are example configurations for the file “/etc/raddb/users.conf” for the
FreeRADIUS server.
The RADIUS client and secret key must also be configured in the RADIUS server.
For a FreeRADIUS server, this is configured in the "/etc/raddb/clients.conf" file.
Example
client 192.168.0.0/16
{
secret= testing123
shortname= private-network-2
}
Table 5-3. Security Levels vs. RADIUS Server Class Attribute Settings
User 1-4
Power-user 5-9
Admin 10 - 15
Listed below are example configurations for the file “tac.cfg” for the Cisco
TAC_PLUS TACACS+ server.
For user "usr_a" with a password of "test1a", and a secret (key) of "testing123":
#
# CONFIGURE ENCYPTION KEY
key = testing123
# Configure User
user = usr_a {
pap = cleartext test1a
opap = cleartext test1a
global = cleartext test1a
service = exec {
default attribute = permit
priv-lvl = 15
}
}
# End file
#
# CONFIGURE ENCYPTION KEY
key = testing123
# Configure User
user = usr_b {
pap = cleartext test2b
opap = cleartext test2b
global = cleartext test2b
service = exec {
default attribute = permit
priv-lvl = 8
}
}
# End file
#
# CONFIGURE ENCYPTION KEY
key = testing123
# Configure User
user = usr_c {
pap = cleartext test3c
opap = cleartext test3c
global = cleartext test3c
service = exec {
default attribute = permit
priv-lvl = 1
}
}
# End file
Note:If you change the "priv-lvl" attribute in the file “tac.cfg”, you
need to use the “set user del” command to delete the
TimeCreator's stale user account (if it exists) for your remote
TACACS+ user. Then log in to TimeCreator again so the
TimeCreator will recreate the user account for your remote
TACACS+ user with the new user security level corresponding
to the "priv-lvl" attribute you specified in the file “tac.cfg”.
Provisioning Services
Using the Set Service command, you can control the TimeCreator 1000 services
(see Set Service, on page 250). This command allows you to enable or disable the
following services:
EIA-232
Telnet
SSH
NTP
SNMP
Example
Static IP Mode
Use the following procedure to configure the TimeCreator 1000 IP parameters (Host
Address, Subnet Mask, and Gateway Address) on the MGMT port. Use the
dot-decimal notation format xxx.xxx.xxx.xxx to enter the address parameter.
Example
DHCP Mode
You can either enable or disable DHCP mode on the MGMT port or NTP port. Use
the following procedure to configure the TimeCreator 1000 to enable DHCP on the
MGMT port.
Example
The TimeCreator 1000 Time of Day can be set either by an external source, or
manually with the Set Clock command. You can set the time and date only in the
user tod-source mode. The local time offset only affects the time associated with the
logs. Use the following procedure to manually set the system date, time, and time
offset:
3. Type set clock date <date value> time <time value> and press Enter.
Enter the date value in format yyyy-mm-dd.
4. Type set clock offset <offset value> and press Enter. Enter the time
offset value in format hh-mm. Only offsets corresponding to valid time zones are
supported. The time offset will only affect the time associated with the logs.
Note: If the offset is changed, then the unit saves the configuration
and restarts the IMC.
The TimeCreator 1000 can be provisioned as a root server operating with a GPS
external reference, or if no external reference is qualified, it can operate in free-run
mode. The TimeCreator 1000 can also be provisioned to operate as a subtending
server receiving its reference from a root DTI server.
The TimeCreator 1000 stays in warm-up until the time is obtained. If RTC mode is
selected, then the time is already available. Other modes need to obtain the time
from an external source. Once the unit has passed beyond warm-up, a jam sync is
required to adjust the time when changing the TOD source.
Warning: Changing the TOD source and performing the jam sync
may require cable modems to re-sync. For information on jam sync,
see Force System Time to Reference (Jam Sync), on page 91 and
refer to the command Sync TOD-Source, on page 262.
GPS Root GPS antenna used to acquire the system’s frequency, DTI
timestamp, and TOD
Real-Time Clock Root Clock on IMC used to acquire the TOD. Frequency is
(RTC) provided by IOC’s clock in freerun mode
Use the following procedure to provision the TimeCreator 1000 mode of operation
as either a root DTI server or subtending server.
Example
To provision the TimeCreator 1000 as a root server in free-run mode with the TOD
set by the user to the current time, perform the following steps:
3. Type set clock date <date> time <time> and press Enter.
Example
To provision the TimeCreator 1000 as a root server with an NTP server supplying
the TOD, perform the following steps:
Example
To provision the TimeCreator 1000 TOD source to be the IMC’s real-time clock
(RTC), perform the following steps:
Example
To provision the TimeCreator 1000 as a root server with GPS as the external
reference, perform the following steps:
Example
3. Follow the steps in Provisioning the Input Reference, on page 89 to provision the
input reference ports.
Note: The root server must be in verbose TOD mode. On the root
server, enter the following command: Type set interface
tod-mode verbose and press Enter.
When operating in normal (locked) mode, the TimeCreator 1000 uses the external
reference (GPS or DTI) to acquire the system’s frequency, DTI timestamp, and TOD
alignment. (See Operating Modes, on page 29 for details about Normal and other
operating modes.) A GPS reference is connected to the GPS interface on the IMC
of root server. DTI references are connected to ports A and B of a subtending
server, and you can provision a priority level for each port. You can also provision
NTP to provide TOD, with frequency provided by the IOC clock. The TOD source
must be set prior to enabling the desired interface.
Example
To provision the TimeCreator 1000 to set a GPS reference for manual mode and
specify the position as a latitude of N37.22.45.123, longitude of W121.55.36.123,
height of 17.5 meters, with a mask of 25 degrees, perform the following steps:
2. Type the command show show tod-source to verify that the TOD source has
been set to GPS.
If the TOD source is set to GPS, proceed to step 3. If the the TOD source is not
set to GPS, type the command set tod-source gps and press Enter
Example
To provision ports A and B for DTI reference, set port A for a priority of 1 and port B
for a priority of 2 then perform the following steps:
2. Type the command show show tod-source and press Enter to verify that the
TOD source has been set to DTI. This must be set before the state or type can be
set.
If the TOD source is set to DTI, proceed to step 3. If the the TOD source is not set
to DTI, type the command set tod-source dti and press Enter
Example
To enable the MGMT port to receive TOD from an NTP server, perform the following
steps:
2. Type the command show show tod-source and press Enter to verify that the
TOD source has been set to NTP.
If the TOD source is set to NTP, proceed to step 3. If the the TOD source is not
set to NTP, type the command set tod-source ntp and press Enter
5. Type set ntp-server add <ip address> and press Enter. If required by the
NTP server, specify a keyID with the NTP-Server command, use the NTP-Key
command to add key configuration, and NTP-Authorization to enable or disable
authorization operation.
Warning: Changing the TOD source and performing the jam sync
may require cable modems to re-sync. For information on jam sync,
see Force System Time to Reference (Jam Sync), on page 91 and
refer to the command Sync TOD-Source, on page 262.
Example
The TimeCreator 1000 rear panel has ten permanent DTI client links that provide
DTI timing signals to client elements in an M-CMTS architecture. With the 8-port
IOC module option, however, only Ports 1 through 6 are active. There are also two
DTI client/server ports that can be provisioned as either DTI reference links (for
subtending servers), or as additional DTI links to client elements. DTI ports 11 and
12 must be provisioned to the appropriate type, either client or server, before being
enabled or disabled.
The LED status indicators on the DTI links are described in Table 5-5.
DTI Output Status Off 1. A DTI output issue exists on at least one DTI
output port
2. When operating as the Standby IOC
Example
The revertive and non-revertive function allows you to select the action taken when
the system reference at ports A and B is disqualified and then re-qualified.
In the revertive mode, if an input used as the system reference is disqualified (for
any reason), the reference switches to the next-highest input and reverts to the
initial input when that input is re-qualified. In this mode, the reference switches two
times: once when the disqualifying event occurs, and again when the initial input is
re-qualified.
In the non-revertive mode, when the system reference is disqualified (for any
reason), the system reference switches to the other input but does not revert to the
initial input when the initial input is re-qualified. The system reference switches only
once when the disqualifying event occurs. When the priorities of the ports are the
same, the ports act in the non-revertive mode. If the priorities are different, the ports
act in the revertive mode.
Example
To provision the TimeCreator 1000 ports A and B for revertive mode, perform the
following steps:
1. Root Server automatically switching to client mode to acquire time and phase
from a subtending server
2. Root Server returning to server mode and slowly steering the subtending servers'
time and phase back in phase with the root
With the TimeCreator 1000, when the root server has lost power or is taken off line
for servicing, the subtending servers' clocks will enter the holdover state and slowly
drift over time. When the root server is restored and has warmed up, it will
automatically switch to a DTI Client role and acquire the time and phase from a
subtending server connected Port 12. The root server will then switch back to its
role as server and use this time and phase to steer the remaining subtending
servers time and phase. Clients connected to the subtending server will also slew
with the subtending server. If the subtending servers are forced to slew their time
and phase too rapidly, however, this may cause modems to re-range, resulting in
service disruption. Root Server Recovery can be configured to slew at a slow rate
that avoids service disruptions.
In Root Server Recovery mode, the root is switched from server to client mode, thus
allowing it to acquire TOD and phase data from a subtending server. The root is
then switched back to server mode, allowing it to steer the subtending servers time
and phase. Automatic root server recovery is only available for the USER TOD
Source mode, as shown in Figure 5-1. Figure 5-2 shows a simple deployment with
Root Server Recovery. Figure 5-3 shows a larger scale deployment with Root
Server Recovery.
In Root Recovery mode, the root remains in server mode when it acquires TOD and
phase from its TOD source. When the root server is turned on after power failure or
after it has been serviced, it will automatically query time and phase from its TOD
source, and use this time and phase to steer the subtending servers time and
phase. Clients connected to the subtending server will also slew with the subtending
server. Figure 5-4 illustrates the root recovery process based on TOD source.
Figure 5-1. State Diagram for Root Server Recovery - USER mode
Figure 5-4. State Diagram for Root Recovery - GPS, NTP, and RTC modes
When conditions warrant, the user can set another root-recovery per port control,
rapid recovery, to achieve a shorter re-alignment time. Note that this will cause
re-ranging of some DTI clients. The user can view the amount of time required for
recovery to determine whether they need to activate rapid recovery by displaying
status of the recovery process. See the sections Displaying Status of Root Server
Recovery, on page 101 and Enabling Rapid Recovery Mode, on page 102 for
details.
Example:
To set the root server so that it can automatically recover from an outage enter the
following command:
If the autorecovery mode is not enabled when the root server is in USER TOD
Source mode, the user must manually enter the TOD and the “sync TOD source
now” to allow recovery of the root.
Example:
Root recovery settings in the root server can be retrieved by using the following
query:
whether the auto recovery process is taking place (running or not running)
whether a port is able to recover in a controlled manner,
how long re-alignment will take, in minutes (displays total time required, but does
not count down remaining time for re-alignment)
Example:
Root recovery status in the root server can be retrieved by using the following
query:
The Rapid Recovery mode can shorten the duration of the recovery process by at
least a factor of 10, depending on the phase error of the subtending server as a
result of the outage duration.
Example:
Rapid recovery mode can be enabled for all ports of the root server by using the
following commands:
2. Type show root-recovery status and press Enter to verify the status of the
root server recovery process and expected time for re-alignment.
Example:
To abort the root server recovery process under way, enter the following command:
2. Type show root-recovery status and press Enter to verify the status of the
root server recovery process and expected time for re-alignment.
Provisioning SNMP
Enabling SNMP allows you to use an SNMP interface to remotely manage the
TimeCreator 1000 over an Ethernet connection. This also allows the user to:
Example 1:
To enable SNMP on the MGMT port, add an SNMPv3 user ABC, with no
authorization or privacy, and to set the trap destination IP address to
192.168.100.100, port 1098, for user ABC with a security level of “noauth” and an
access level of “ro”, perform the following steps:
3. Type set snmp accessv3 add ABC securLvl noauth accessLvL ro and
press Enter.
5. Type set snmp trap add 192.168.100.100:1098 abc and press Enter.
Example 2:
To provision the NTP server, you must enable it on the NTP server port. When NTP
is enabled, the TimeCreator 1000 can serve its system time to external NTP clients.
Example
To enable NTP on the NTP server port, perform the following steps:
The Cable Advance command allows you to compensate for the response time
between client and server DTI links due to cable length. You can specify any or all
ports and provision for auto correction or manual correction.
Example
To provision cable advance auto mode on DTI link port 1, perform the following
steps:
2. Type show cable-adv and press Enter to view the current setting.
Provisioning Alarms
This section describes the commands used to provision and manage alarms in the
TimeCreator 1000. The user can provision the alarms to be enabled or disabled and
set thresholds to turn the alarms on and off. For a list of all alarms, see Appendix A,
Alarms, Events and SNMP Traps.
Alarms are also indicated by LEDs on the IOC and IMC modules.
MTIE-t
MTIE-35
Jitter
FER
The set and clear values are the threshold settings that determine when an alarm is
activated and deactivated. The set value is the threshold above which an alarm is
activated. The clear value is the threshold below which an alarm is deactivated.
Use the following commands to provision the set and clear alarm threshold values.
Example
To set the MTIE-t, MTIE-35, Jitter, FER threshold of all ports to a set value of 8000
and a clear value of 5000, perform the following steps:
2. Type set alarm-threshold mtie-t all set 8000 and press Enter.
3. Type set alarm-threshold mtie-t all clear 5000 and press Enter.
4. Type set alarm-threshold mtie-35 all set 8000 and press Enter.
5. Type set alarm-threshold mtie-35 all clear 5000 and press Enter.
6. Type set alarm-threshold jitter all set 8000 and press Enter.
7. Type set alarm-threshold jitter all clear 5000 and press Enter.
8. Type set alarm-threshold fer all set 8000 and press Enter.
9. Type set alarm-threshold fer all clear 5000 and press Enter.
Example
To enable the alarm for IOC in holdover for extended period (alarm type of EXTHOLD),
perform the following steps:
Example
To display set and clear thresholds for all ports, enter the following:
1. Login at the User, Admin or Power-User level (see Login, on page 74).
Example
To display a list of all current alarms and list of the state of all alarms, enter the
following:
1. Login at the User, Admin or Power-User level (see Login, on page 74).
This section describes the commands you use to perform the following routine
operations with the TimeCreator 1000:
Displaying alarms
Displaying events
Restarting the server IMC card
Displaying Alarms
The Show Log Alarm command displays some of the local alarms in the alarm log in
chronological order (first in - first out). This command also allows the user to display
a specified number of alarms from the beginning or end of the log file.
Example
Displaying Events
The Show Log Event command displays some of the local events in the event log in
chronological order (first in - first out). The event log contains the 1000 most recent
alarmed and non-alarmed events. This command also allows the user to display a
specified number of alarms from the beginning or end of the log file.
Example
Example
Example
Example
Example 1
To backup the current IMC configuration in the IOC2 card, use the command “set
configuration backup IMC IOC 2”:
Example 2
Example
Example
Example
Notes:
Setting the configuration to default will not overwrite the user login
information or the system’s IP address. Setting the configuration to
factory will overwrite the user login information and return the
system’s IP address to the factory set address.
Example 1
To retrieve the IMC configuration file “/home/user/imc.bak” from the remote server
at IP address 192.168.3.86 -
Example 2
To restore the IMC configuration file that was retrieved rom the remote server -
Example1
To retrieve the IOC configuration file “/home/user/ioc.bak” from the remote server at
IP address 192.168.3.86 -
Example 2
To restore the IOC configuration file that was retrieved rom the remote server -
In This Chapter
Preventive Maintenance
Safety Considerations
ESD Considerations
Diagnosing the IOC
Diagnosing the IMC
Repairing the TimeCreator 1000
Obtaining Technical Assistance
Upgrading the Firmware
Returning the TimeCreator 1000
User’s Guide Updates
Preventive Maintenance
The TimeCreator 1000 requires minimal preventive maintenance. Ensure the unit is
not exposed to hazards such as direct sunlight, open windows, water, or extreme
heat. See Environmental Requirements, on page 48, for electromagnetic
compatibility conditions that may cause damage.
Chassis Inspect for dirt or foreign Clean the exterior of chassis with Periodically
material a soft dry cloth
Safety Considerations
Follow your company’s safety guidelines and policies when working on or around
live equipment.
ESD Considerations
Maintenance personnel should wear ESD wrist straps when installing or working on
all TimeCreator 1000 equipment and modules. Plug the user-supplied wrist strap
into the TimeCreator 1000. Place IMC and IOC modules into static-free bags when
not in use.
Green power is on
Output Off A DTI output issue exists on at least one DTI output
port, or the module is the standby IOC
1. Save the contents of the IOC memory in the IMC by issuing the following
command:
3. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
4. Loosen the captive retaining screws and pull out on them to unseat the IOC from
the shelf.
Install a new IOC using the appropriate procedure in Replacing the IOC, on page
120.
Caution: To avoid a loss of output signals, do not take the only IOC in
a shelf out of service.
2. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
3. Loosen the captive retaining screws and pull out on them to unseat the IOC from
the shelf.
5. Install a new IOC using the appropriate procedure in Replacing the IOC, on page
120.
1. Save the contents of the active IOC memory in the IMC by issuing the following
commands:
2. Issue the following commands to take the standby and active IOCs out of service:
Caution: Output signals are turned off when you place the second
IOC out of service.
3. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
4. Loosen the captive retaining screws and pull out on them to unseat the standby
IOC from the shelf.
7. Install new IOCs using the appropriate procedure in Replacing the IOC, on page
120.
1. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
2. Install the IOC into the shelf and tighten the captive retaining screws.
3. Copy the contents of the IOC memory stored in the IMC by issuing the following
command.
If you have not stored the contents of the IOC memory in the IMC, then provision
the IOC using the procedures and commands described in Chapter 5, Provisioning.
4. Wait for the IOC to reboot and achieve normal operating state.
1. Install the IOC into the shelf and tighten the captive retaining screws.
2. Wait for the IOC to reboot and achieve the normal operating state. During this
time the Active IOC updates the new IOC’s memory with current values.
1. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
2. Install the IOC into the left slot of the shelf and tighten the captive retaining
screws. This IOC will become the Active IOC.
4. Retrieve the contents of the IOC memory stored in the IMC by issuing the
following command:
If you have not stored the contents of the IOC memory in the IMC, then provision
the IOC using the procedures and commands described in Chapter 5,
Provisioning.
5. Install the second IOC into the right slot of the shelf and tighten the captive
retaining screws. This IOC will become the Standby IOC.
6. Wait for the IOC to reboot and qualify the reference inputs. During this time the
active IOC updates the new IOC’s memory with current values.
1. Save the contents of the IMC memory in an IOC (example is for IOC1) by issuing
the following command:
2. Attach a wrist grounding strap and connect it to the TimeCreator 1000 chassis.
3. Remove the IMC by loosening the captive screws and pulling the IMC from the
shelf.
5. Insert another IMC into the shelf and tighten the captive screws.
6. Reload the IMC memory from the IOC by issuing the following command:
To remove an IOC, loosen the captive screws and pull the module out of the shelf.
Place the module on an anti-static surface or in an anti-static bag.
To remove the IMC, loosen the captive screws and pull the module out of the shelf.
Place the module on an anti-static surface or in an anti-static bag.
If you have technical questions about the TimeCreator 1000, call Symmetricom
Global Services (SGS) at 888-367-7966 (toll-free in USA only), 408-428-7907, or
+49 700 3288 6435 in Europe, Middle East, or Africa. You can also E-mail your
technical questions to [email protected] or
[email protected].
You can upgrade the firmware in the IMC, IOC, or redundant IOCs using CLI
commands and software available from Symmetricom. Only users with Admin level
access can execute the command. The command places the IMC in the firmware
download mode and prevents all other sessions from making changes to the
configuration. During the upgrade process, no new sessions are allowed. Refer to
Appendix B, Command Descriptions and Communications Interface and the
command Upgrade, on page 264 for details on the upgrade process.
2. Type set configuration backup and press Enter to save the contents of the
IOC configuration.
auto-reboot)The user is then prompted for the user name and password for the
server and the new software is loaded into the IOC.
Note: The system will FTP the file from the specified FTP server (IP
address) and then upgrade the module.
4. The new software is loaded into the IOC, the IOC is rebooted, and it then enters
Warm-up mode for up to 30 minutes..
Caution: For non-redundant IOC modules, the IOC will restart and
the outputs will be interrupted for approximately 30 minutes.
5. Type set configuration restore and press Enter to restore the contents of
the IOC configuration.
2. Type set configuration backup and press Enter to save the contents of the
active IOC configuration.
4. When prompted, enter a user name and password for the server.
Note: The system will FTP the file from the specified FTP server (IP
address) and then upgrade the module.
5. The new software is loaded into the IOC, the IOC is rebooted, and it then enters
Warm-up mode for up to 30 minutes.
If you are upgrading the active IOC, the TimeCreator 1000 performs the following:
Note: If the initial IOC upgrade is not successful, the entire process is
aborted, an error message is generated, and the IOC restarts with the
original firmware.
6. Type set configuration restore and press Enter to restore the contents of
the IOC configuration.
2. Type set configuration backup and press Enter to save the contents of the
IMC configuration.
4. When prompted, enter a user name and password for the server.
Note: The system will FTP the file from the specified FTP server (IP
address) and then upgrade the module.
5. The TimeCreator 1000 validates the received file, and if the file is valid it updates
the flash memory and reboots the IMC.
Note: If the file is not valid, the TimeCreator 1000 will reject it.
You should return the equipment to Symmetricom only after you have exhausted the
troubleshooting procedures described earlier in this chapter, or if Symmetricom
Global Services has advised you to return the unit.
This URL will send you to a sign-in page. Log in and navigate to the RMA form.
2. Provide a description of the problem, product item number, serial number, and
warranty expiration date.
4. Ship the product to Symmetricom, transportation prepaid and insured, with the
Return Material Authorization (RMA) number and item numbers or part numbers
clearly marked on the outside of the container to the address given with the RMA.
When this manual is updated the updated version will be available for downloading
from Symmetricom’s internet web site. After downloading, you can view the manual
on a computer or print it using Adobe Acrobat Reader.
www.symmetricom.com/support/
Note: If you are downloading a manual for the first time, you will need
to register with Symmetricom. If you are currently registered, login
and download the manual update.
The TimeCreator 1000 provides a log of events and alarms that are stored in
non-volatile memory on the IMC module. This appendix provides details on the
TimeCreator 1000 alarms, including corrective actions. This appendix also provides
details and descriptions about events and SNMP traps.
In This Appendix
Alarm Messages
Event Messages
SNMP Traps
Alarm Messages
The TimeCreator 1000 provides set and clear alarm messages to notify you when
certain conditions are exceeding the user-specified levels (when alarms are set)
and when certain conditions return to within the user-specified levels (when alarms
are cleared). Alarms also indicate hardware and signal status.
There are several parameters used to identify or specify individual alarms, events
and traps, as shown in Table A-1 below.
Table A-2 below provides a list of alarm messages and a description of each
message. Event Messages
4 OUTDISC Minor Output Port <#> Output Port (port Check cable and
cable is 1 through port NE on that port
disconnected 12) DTI client
cable is
disconnected
5 INPDISC Minor Input Port <#> DTI input port A Check cable and
cable is or B cable is NE on that port
disconnected disconnected
6 INPADVINV Minor Input Port <#> Indicates that Check cable and
cable advance the cable NE on that port
value is invalid advance value
for the specified
port is not valid
7 INPUNSTBL Minor Input Port <#> Indicates that Check cable and
performance is performance for NE providing input
unstable the specified on that port
port is unstable
10 CLKEXTHOLD Critical IOC <#> has Indicates that Check cable and
been in Holdover the specified NE providing input
Mode for IOC has been in on that port
extended period Holdover mode
for an extended
period
13 IMCNCOMP Minor IMC and IOC <#> Indicates that Need to upgrade
incompatible the IMC and IOC IOCs or IMC to
modules are not same firmware
compatible versions
15 MTIETEXC Minor Port <#> has Indicates that Check cable and
exceeded the the MTIE-t error NE (network
MTIE-t threshold, rate has element) on that
<value> exceeded the port
user-set
threshold
16 MTIE35EXC Minor Port <#> has Indicates that Check cable and
exceeded the the MTIE-35 NE on that port
MTIE-35 error has
threshold, exceeded the
<value> user-set
threshold
17 PPJEXC Minor Port <#> has Indicates that Check cable and
exceeded the the P-P Jitter NE on that port
P-P Jitter error has
threshold, exceeded the
<value> user-set
threshold
18 FEREXC Minor Port <#> has Indicates that Check cable and
exceeded the the Frame Error NE on that port
FER threshold, Rate has
<value> exceeded the
user-set
threshold
20 PWRFANFAIL Major Power Module The fan of power Check fan and if
<#> fan failure module A or B not spinning or
failed alarm persists
then replace
power module
Event Messages
Table A-3 below provides a list of event messages and a description of each
message.
40 SETBYGPS nonalarm System TOD has The TOD has been No action
been set by GPS set by GPS required
41 SETBYNTP nonalarm System TOD has The TOD has been No action
been set by NTP set by the NTP required
server
42 SETTOD nonalarm DTI TOD has been The TOD has been No action
set set by DTI required
43 IOCREMOVED nonalarm IOC <#> has been Indicates that the No action
removed IOC module has required
been removed
48 PPJALA nonalarm Port <#> P-P Jitter Indicates that the No action
threshold set to 0, P-P Jitter threshold required
alarm disabled for the port has
been set to 0 and
the alarm is
disabled
52 SETBYDTI nonalarm System TOD has The TOD has been No action
been set by root set by the root required
server server
53 SETBYUSER nonalarm System TOD has The TOD has been No action
been set by user set by the user required
SNMP Traps
The MIB for TimeCreator 1000 v1.2 has MIB var bindings for all Symmetricom
specific SNMP traps, as shown in Table A-4 below:
trapState The TimeCreator 1000 provides set and clear trap messages to
notify you when certain conditions are exceeding the
user-specified levels (when traps are set) and when certain
conditions return to within the user-specified levels (when traps
are cleared). Traps also indicate hardware and signal status.
These are integer values, where:
clear (1) - the condition for this trap has been cleared,
set (2) - the trap condition has been raised
See Figure A-1, Figure A-2, and Figure A-3 for details about other relevant MIB
table entries.
Note: Users need to load 2 mib files into their MIB browser:
symm-smi.mib
TC1000.my
The symm-smi.mib file must be loaded first before TC1000.my file.
Figure A-2. SNMP MIB - Trap Object Parameters and Event Log Entries
See Table A-6 below for additional trap details, such as descriptions and bindings.
The OID for alarms traps are of the format:
where x corresponds to index values that identify specific alarms. The digits shown
for the OID Index in Table A-6 below correspond to x. See Table A-5 for listings of
the full OID for each alarm.
Note: The ID in the Trap OID Name column in Table A-6 below is
used with the Generate Message command to raise a specific trap:
tc1000>generate message
“id,trapAID1,trapAID2,trapState,trapValue”
Example
The severity level for an alarm trap can be critical, major, or minor if trapState is set
(2) for this alarm trap; otherwise, the severity level will be clear if trapState is clear
(1) for this alarm trap.
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
trapValue: n/a
trapAID2: n/a
Inter-IOC
communication trapState: clear (1), set (2)
restored
trapValue: n/a
trapValue: n/a
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
trapAID2: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
IOC 2, IOC 1
compatible
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapAID2: n/a
GPS antenna
communication trapState: clear (1), set (2)
restored
trapValue: n/a
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
trapAID2: n/a
Power Module
<#> output trapState: clear (1), set (2)
failure cleared
trapValue: n/a
OID trapSev
Index Trap OID Name Description Bindings
(x)
erity
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
See Table A-9 below for additional trap details, such as descriptions and bindings.
The OID for events traps are of the format
where y corresponds to index values that identify specific events. The digits shown
for the OID Index in Table A-9 below correspond to y. See Table A-8 for listings of
the full OID for each event.
Note: The ID in the Trap OID Name column in Table A-9 below is
used with the Generate Message command to raise a specific trap -
tc1000>generate message
“id,trapAID1,trapAID2,trapState,trapValue”
Example
To generate the message for the trap “IOC <#> has transitioned in to
Holdover Mode”, which has id=13, trapAID1=258 (corresponds to
trapAID1=2 for IOC2 in Table A-9) trapAID2=0, trapState=2, and
trapValue=0:
The event trap is for information only and always has the nonalarm severity.
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
Output Port <#>
cable advance value trapState: clear (1), set (2)
is Valid
trapValue: n/a
trapAID2: n/a
Output Port <#>
performance is trapState: clear (1), set (2)
stable
trapValue: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: 1 or 2,
IOC <#> has IOC module id
selected BITS Port
<#> as reference trapState: clear (1), set (2)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapValue: n/a
trapValue: n/a
trapAID2: n/a
trapValue: gear
trapAID2: n/a
TPIU tuning voltage
within 10%-90% trapState: clear (1), set (2)
range
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapValue: n/a
trapValue: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapValue: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
Port <#> MTIE-t
threshold set above trapState: clear (1), set (2)
0, alarm enabled
trapValue: n/a
trapAID2: n/a
Port <#> MTIE-35
threshold set above trapState: clear (1), set (2)
0, alarm enabled
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
Port <#> P-P Jitter
threshold set above trapState: clear (1), set (2)
0, alarm enabled
trapValue: n/a
trapAID2: n/a
Port <#> FER
threshold set above trapState: clear (1), set (2)
0, alarm enabled
trapValue: n/a
trapValue: n/a
trapValue: n/a
trapValue: n/a
OID
Index Trap OID Name Description Bindings Severity
(y)
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
trapAID2: n/a
trapValue: n/a
This appendix describes the CLI command conventions, the prompts, line editing
functions, and command syntax. The CLI command functions and features are
organized by user security access levels and are listed alphabetically.
In This Appendix
CLI Overview
CLI Commands
Simple Network Management Protocol
Network Time Protocol
Secure Shell Protocol
Secure File Transfer Protocol
CLI Overview
The Command Line Interface (CLI), also called the ASCII command set, can be
used to control the TimeCreator 1000 from a terminal connected to the EIA-232
serial port, or the Ethernet port. See Figure B-1 below for an overview of the
command set.
General Conventions
The following are CLI command general conventions:
Command name
Description of command function
Operation of this command at security levels 1 through 3, with descriptions of
syntax and command functions
Remarks and comments about the command operation
Related Commands lists other commands that may affect or be affected by the
command.
Restrictions describes any special restrictions on the use or operation of the
command.
The users assigned to each security level have access options available as follows:
CLI Commands
Show Alarms
This command displays a list of all standing (active) system alarms.
Command Syntax:
show alarms
Example:
tc1000>show alarms
Response:
Show Alarm-State
This command displays the state of each alarm: if it is enabled or disabled.
Command Syntax:
show alarm-state
Example:
tc1000>show alarm-state
Response:
Remarks: See the list of alarm codes in the Set Alarm-State command.
Set Alarm-State
This command is used to enable or disable specific alarms. Table A-2 provides a list
of alarm codes and their description.
Command Syntax:
Example:
To enable the alarm for IOC in holdover for extended period (alarm code of EXTHOLD) -
Show Alarm-Threshold
This command displays the set and clear alarm thresholds for MTIE-35, Jitter,
MTIE-35, MTIE-t, and FER.
Command Syntax:
show alarm-threshold
Example:
tc1000>show alarm-threshold
Response:
port - 1
FER set - 100
FER clear - 10
MTIE-t set - 10000
MTIE-t clear - 7000
Jitter set - 8000
Jitter clear - 5000
MTIE-35 set - 10000
MTIE-35 clear - 7000
port - 2
FER set - 100
FER clear - 10
MTIE-t set - 10000
MTIE-t clear - 7000
Jitter set - 8000
Jitter clear - 5000
MTIE-35 set - 10000
MTIE-35 clear - 7000
port - 3
FER set - 100
FER clear - 10
MTIE-t set - 10000
MTIE-t clear - 7000
Jitter set - 8000
Jitter clear - 5000
MTIE-35 set - 10000
MTIE-35 clear - 7000
.................
Remarks: When ports A/11 and B/12 are configured as clients, alarm thresholds
are not used.
Set Alarm-Threshold
Use this command to provision the set and clear alarm thresholds for MTIE-35,
Jitter, MTIE-35, MTIE-t, and FER on the specified port. The threshold can be set for
all ports or an individual port.
Command Syntax:
Range:
Example 1:
Example 2:
Example 3:
Example 4:
Remarks: When ports A/11 and B/12 are configured as clients, alarm thresholds
are not used. The alarm is disabled if either threshold, set, or clear is set to zero.
Alias
Use this command to create a short form of a frequently used command.
Command Syntax:
To display all defined aliases and the commands to which they have been
assigned:
alias
Example 1:
Example 1a:
tc1000> ip
Response 1a:
Example 2:
tc1000> alias
Response 2:
Related: None
Show Authentication
Displays how the TimeCreator 1000 authenticates users. If applicable, it displays
the RADIUS server and key and TACACS+ server and key.
Command Syntax:
show authentication
Example:
tc1000>show authentication
Response:
Related: None
Set Authentication
Use this command to provision the authentication scheme, the RADIUS server IP
address and the authentication key(s) for server access, or the TACACS+ server IP
address and the authentication key(s) for server access. Only one RADIUS or
TACACS+ server is supported at any one time. Only one key is supported at any
one time. This command also allows the user the option to specify the server port in
addition to the server address.
Command Syntax:
Example 1:
Example 2:
Example 3
Example 4:
Example 5:
Example 6:
Show Bridge-Time
This command displays the bridging time that is used when the system does not
have a qualified reference.
Command Syntax:
show bridge-time
Example:
tc1000>show bridge-time
Response:
Remarks: If the system does not qualify a TOD source (frequency reference) within
the specified bridging time, the system transitions to holdover mode.
Set Bridge-Time
Use this command to provision the amount of time the system will remain in bridging
mode before transitioning into the holdover mode.
Command Syntax:
Example:
Remarks: The default value is 900 seconds. Based on DOCSIS requirements and
the characteristics of the TimeCreator 1000 oscillator, impairments in performance
are not expected within this default time period.
Command Syntax:
show cable-adv
Example:
tc1000>show cable-adv
Remarks: The cable advance value may not be updated if the cable is
disconnected or the port is disabled, including manual cable advance values.
Command Syntax:
Example 1:
Example 2:
To set the cable advance for Port 5 to Manual, with a value of 00x01023 -
Remarks: The valid range for the manual cable advance value is from 00:00:00 to
0E:A0:EA.
Note: If the cable advance is presently valid, then the cable advance
setting is constrained to update at a rate of 26 ps/s, as required by the
DTI specification, in both automatic and manual modes. To make a
large change in the cable advance manually, first disable the port with
the Set Interface command.
Show Clock
This command displays the system’s date, time, leap seconds, and local time offset.
Command Syntax:
show clock
Example:
tc1000>show clock
Response:
Date - 2010-01-13
Time - 06:47:46
Local Time Offset - +00:00
IMC Uptime - 9:43
Leap Seconds - 14
Remarks: If the Show Clock command and the Show DTI-Clock command
time/date values are different and the unit is not in warm-up, then a "jam-sync" is
probably required (see Sync TOD-Source command).
Set Clock
Use this command to provision the IMC’s user-assigned date, time, leap seconds,
and local time offset.
Command Syntax:
Example 1:
Example 2:
To set the local time offset to -8:00 for the IMC clock -
Example 3:
Remarks: The date and time can only be set in the user tod-source mode. The leap
seconds value can only be set in the user and NTP tod-source modes. The leap
seconds value is the accumulated number of seconds between GPS and UTC time.
The local time offset only affects the time associated with the logs.
Note: If the offset is changed, then the unit saves the configuration
and restarts.
-12:00 -11:00 -10:00 -9:00 -8:00 -7:00 -6:00 -5:00 -4:00 -3:30
-3:00 -2:00 -1:00 +0:00 +1:00 +2:00 +3:00 +4:00 +4:30 +5:00
+5:30 +6:00 +6:30 +7:00 +8:00 +9:00 +9:30 +10:00 +11:00 +12:00
Set Configuration
Use this command to backup the current configuration, restore the current
configuration from a backup copy, or set the current configuration to factory default
values.
Command Syntax:
To restore the configuration to the default values, but preserving user and ip
configuration -
set configuration default
Example 1:
Example 2:
Example 3:
Example 4:
Example 5:
Example 6:
Example 7:
To restore the configuration to the default values, but preserving user and ip
configuration -
Example 8:
Remarks: Setting the configuration to default will not overwrite user login
information or system’s IP address. Setting the configuration to factory resets all
settings to the factory default. The IOC configuration is automatically saved in the
IOC one minute after a configuration setting is changed.
Command Syntax:
Example 1a:
To retrieve the IMC configuration file “/home/user/imc.bak” from the remote server
at IP address 192.168.3.86 -
Example 1b:
To restore the IMC configuration file that was retrieved rom the remote server -
Remarks:
Command Syntax:
Example 1a:
To retrieve the IOC configuration file “/home/user/imc.bak” from the remote server at
IP address 192.168.3.86 -
Example 1b:
To restore the IOC configuration file that was retrieved rom the remote server -
Remarks:
Related:
Show DTI-Clock
This command displays the date, time, leap seconds, and local time offset
transmitted on the DTI ports.
Command Syntax:
show dti-clock
Example:
tc1000>show dti-clock
Response:
Remarks: If the Show Clock command and the Show DTI-Clock command
time/date values are different and the unit is not in warm-up, then a "jam-sync" is
probably required.
Show EIA-232
This command displays the serial port’s operating parameters: baud rate, parity,
word length, stop bits, and handshaking.
Command Syntax:
show eia-232
Example:
tc1000>show eia-232
Response:
Show Firewall
This command displays the firewall configuration.
Command Syntax:
show firewall
Example:
Response:
ICMP - disable
Telnet - enable
SSH - enable
NTP - enable
SNMP - enable
TACPLUS - enable
RADIUS - enable
SYSLOG - enable
Set Firewall
Use this command to configure the firewall. The firewall is used to selectively block
traffic of specified protocols from the Ethernet ports. If the firewall is enabled for a
protocol, then traffic using that protocol is allowed. If the protocol type is disabled,
then traffic of that type is blocked. If remote authentication is to be used, the firewall
for RADIUS and/or TACACS+ must be set to Enable to allow remote authentication
to work.
Command Syntax:
Example 1:
Example 2
Generate Message
Use this command to generate all TimeCreator 1000 traps in one run, or to generate
a specific trap. This command essentially acts as a trap simulator.
Command Syntax:
Note: See Table A-6 for the the alarm trap bindings “trapID”,
“trapAID1”, “trapAID2”, “trapState” and “trapValue”.
Example 1:
tc1000>generate message
Example 2a:
To generate the message for the trap “IMC-IOC 1 communication failed”, which has ID=2,
trapAID1=257 (corresponds to trapAID1=1 for IOC1 in Table A-6) trap AID2=n/a (use 0),
trapState=2, and trapValue=n/a (use 0) -
Example 2a:
To generate the message for the trap “IMC-IOC 1 communication restored”, which has ID=2,
trapAID1=257 (corresponds to trapAID1=1 for IOC1 in Table A-6) trap AID2=n/a (use 0),
trapState=1, and trapValue=n/a (use 0) -
Show GPS
This command displays the position (latitude, longitude, height), elevation mask
value (positioning filter), mode of operation (manual or automatic), and GPS
satellite tracking status. It also displays information for all satellite vehicles being
tracked: vehicle number, noise ratio, satellite elevation, satellite azimuth.
Command Syntax:
show gps
Example:
tc1000>show gps
Response:
State - disable
Mode - auto
Latitude - N37:22:42.885
Longitude - W121:55:34.702
Height - 13.2
Elevation Mask - 10
Position Hold State - positionHold
Number of tracked: 6
PRN ELEV AZIM C/N
11 34 235 40
16 16 137 39
20 50 313 43
23 32 275 42
31 53 52 42
32 77 0 42
Set GPS
Use this command to provision the GPS for mode of operation, position, and
positioning elevation mask. With this command, you can provision the GPS to use
either automatic or manual mode to determine the system’s position. You can
provision the GPS position if the system is provisioned for Manual mode of
operation. You can also provision the elevation mask to provide a method of filtering
satellites to be used by the system.
Command Syntax:
Example 1:
Example 2:
To provision the GPS reference for manual mode and specify the position as a
latitude of N37.22.45.123, longitude of W121.55.36.123, height of 17.5 meters, with
a mask of 25 degrees, perform the following steps -
Note: Before changing GPS parameters, verify that the TOD source
has been set to GPS with the command
tc1000>show tod-source
If the the TOD source is not set to GPS, type the command
Note: The GPS port state must also be enabled for positioning
changes to be implemented.
Example 3:
Remarks: The system must have the GPS mode of operation provisioned as
manual before you can successfully provision the position manually.
N37:22:45.123
S48:33:67.456
W121:55:36.123
E157:33:47.456
Height is in meters with one digit after the decimal point, for example: 17.5
Show Hostname
This command displays the host name for the TimeCreator 1000.
Command Syntax:
show hostname
Example:
tc1000>show hostname
Response:
Set Hostname
This command sets the host name for the TimeCreator 1000.
Command Syntax:
Example:
tc1000>set hostnameabc100
Imcdebug
This command is used to initiate an IMC debugger. This is for use by Symmetricom
personnel only. Not for customer use.
Command Syntax:
imcdebug
Remarks:
Related: iocdebug
Iocdebug
This command is used to initiate an IOC debugger. This is for use by Symmetricom
personnel only. Not for customer use.
Command Syntax:
iocdebug
Remarks:
Related: imcdebug
Show Interface
This command displays the port state (enabled or disabled) for the GPS, client, or
server ports. It also displays the reference priorities and the port number, type, test
mode, and state.
Note: With the 8-port IOC module option, only DTI Ports 1 through 6
are active, in addition to Port A/11 and Port B/12.
Command Syntax:
show interface
Example:
tc1000>show interface
Response:
Interface State
---------------------------------
|Port |State |
|----------|--------------------|
|GPS |disable |
|..........|....................|
|Port1 |enable |
|..........|....................|
|Port2 |enable |
|..........|....................|
|Port3 |enable |
|..........|....................|
|Port4 |enable |
|..........|....................|
|Port5 |enable |
|..........|....................|
|Port6 |enable |
|..........|....................|
|Port7 |disable |
|..........|....................|
|Port8 |disable |
|..........|....................|
|Port9 |disable |
|..........|....................|
|Port10 |disable |
|..........|....................|
|PortA/11 |enable |
|..........|....................|
|PortB/12 |enable |
---------------------------------
Interface Type
---------------------------------
|Port |Type |
|----------|--------------------|
|PortA |server |
|..........|....................|
|PortB |server |
---------------------------------
Interface Priority
---------------------------------
|Port |Priority |
|----------|--------------------|
|PortA/11 |2 |
|..........|....................|
|PortB/12 |3 |
---------------------------------
---------------------------------
|Port |Test Mode |
|----------|--------------------|
|1 |false |
|..........|....................|
|2 |false |
|..........|....................|
|3 |false |
|..........|....................|
|4 |false |
|..........|....................|
|5 |false |
|..........|....................|
|6 |false |
|..........|....................|
|7 |false |
|..........|....................|
|8 |false |
|..........|....................|
|9 |false |
|..........|....................|
|10 |false |
|..........|....................|
|11 |false |
|..........|....................|
|12 |false |
---------------------------------
Remarks: There are a total of 12 ports. Ports A/11 and B/12 have dual functionality;
they can be provisioned as either DTI client or DTI server ports.
212 TimeCreator 1000 User’s Guide 097-93100-01 Revision C – February, 2010
Appendix B Command Descriptions and Communications Interface
CLI Commands
Set Interface
Use this command to provision the port state to be enabled or disabled for the GPS,
client, or server ports. You can provision ports A/11 and B/12 as either DTI client
ports or DTI server ports and you can also provisions the priority levels. You can
provision the DTI server ports to be in test mode.
Note: With the 8-port IOC module option, only DTI Ports 1 through 6
are active, in addition to Port A/11 and Port B/12.
Command Syntax:
To provision the port state for the GPS or other ports to be enabled or disabled -
set interface state {gps|port #|all} {enable|disable}
Example 1:
Example 2:
Example 3:
Example 4:
Example 5:
To set the priority value for Port A to a value of 2 and the priority value of Port B to a
value of 3 -
Remarks: Rear panel ports A/11 and B/12 are referred to as ports A and B for the
interface state and type commands.
If the priority of the ports are the same, the port selection is non-revertive. For
instance:
1. If one port is disqualified and the second port is qualified, the second port will be
used as the reference.
2. If the first port is once again qualified, then the unit will not switch back to using
the first port; it will continue to use the second port as reference.
Set the ToD source to the desired value before setting the interface state or type.
The type should be set before the state is set for ports 11 and 12. Ports A/11 and
B/12 must be configured as server ports for the test signal is generated in test
mode. If test mode is enabled, the test signal is generated regardless of the port
enable/disable state setting.
Level : Power-User and Admin only
Show Interval
This command displays the interval over which performance data is calculated for
all types of data and for all output ports.
Command Syntax:
show interval
Example:
tc1000>show interval
Response:
port - 1
MTIE-t - 35
Jitter - 10
FER - 10
Jitter - 10
port - 10
MTIE-t - 35
FER - 10
Jitter - 10
port - 11
MTIE-t - 35
FER - 10
Jitter - 10
port - 12
MTIE-t - 35
FER - 10
Jitter - 10
Set Interval
This command allows you to provision the interval over which performance data is
calculated for the specified type of data (P-P Jitter, MTIE-t, FER) and for the
specified output ports.
Command Syntax:
To provision the interval over which jitter performance data is calculated for the
specified port-
set interval jitter [port#|all] <value>
To provision the interval over which MTIE-t performance data is calculated for the
specified port-
set interval mtie-t [port#|all] <value>
To provision the interval over which Frame Error Rate (FER) performance data is
calculated for the specified port-
set interval fer [port#|all] <value>
Example 1:
Example 2:
Example 3:
Show Inventory
This command displays the installed module inventory information: model number,
user-assigned asset number, IMC’s MAC addresses, IMC and IOC modules’ serial
numbers, IMC and IOC modules’ PCB versions, IMC and IOC modules’ FPGA
versions, IMC and IOC modules’ firmware versions.
Command Syntax:
show inventory
Example:
tc1000>show inventory
Response:
System Information:
Set Inventory
Use this command to provision the IMC module’s user-assigned asset value
information.
Command Syntax:
Example:
Show IOC-State
This command displays the state of both the active and standby IOC module. If either
IOC module cannot assume the active, standby, or disabled state, the state indicates
NOT AVAILABLE.
Command Syntax:
show ioc-state
Example:
tc1000>show ioc-state
Response:
--------------------------
|IOC |State |
|--------|---------------|
|1 |active |
|........|...............|
|2 |standby |
--------------------------
Remarks: The active IOC module generates DTI outputs. The redundant module is
the standby Module.
Set IOC-State
Use this command to provision the standby module to become the active module, or
for either module to be disabled. IOC1 references the IOC module to the left of the
IMC and IOC2 references the IOC module to the right of the IMC.
Command Syntax:
Example:
Remarks: If the active IOC module is disabled, the system sets the redundant IOC
module to be the active module prior to disabling the currently active module. If the
redundant IOC module cannot become the active module, the command is ignored.
Show IP
This command displays the Host address, Mask, and Gateway IP settings for both
Ethernet interfaces. It also indicates if DHCP is enabled for the interface and if the
interface is disabled.
Command Syntax:
Example 1:
tc1000>show ip config
Response 1:
eth0 config:
mode: dhcp
addr: 192.168.5.62
netmask: 255.255.255.0
broadcast: 192.168.5.255
gateway: 192.168.5.1
eth1 config:
mode: static
addr: 10.0.0.101
netmask: 255.255.255.0
broadcast: 10.0.0.255
Example 2:
tc1000>show ip status -
Response 2:
Related: set ip
Set IP
Use this command to provision the Host address, Mask, Gateway, and Broadcast IP
settings for both Ethernet interfaces.
Command Syntax:
Example:
Remarks: The address format allows IPv4 and IPv6 multiple octet formats. Use
IP-State to disable the interface while configuring the system. The mask is defined
as an integer defining the number of 1-bits from the MSB. The rest of the bits are 0.
For example a value of 24 corresponds to 255.255.255.0
Notes:
Set IP-Mode
Use this command to set the DHCP mode for both Ethernet interfaces. You can set
up the interface to use either DHCP or a static IP.
Command Syntax:
Example:
Remarks: Use Set IP-State to restart the interface after configuring the system.
Set IP State
Use this command to enable or disable the specified Ethernet interface. You must
restart the interface after you configure it.
Command Syntax:
Example 1:
Example 2:
Related: show ip
Show Log
This command displays the specified log file from the local storage. The Index
parameter selects one of the rotated log files. The Head parameter, along with the
count value, displays the specified number of events from the beginning of the file.
The Tail parameter, along with the count value (#), displays the specified number of
events from the end of the file. If the Index is not specified or set to zero, the current
log file is displayed. If neither Head nor Tail parameter is issued, the 20 most recent
entries are displayed. the command display the specified log’s user provisioned line
buffer size and total number of lines buffered. The log files are:
Command Syntax:
Example:
Response:
Show Log-size
Use this command to display the specified log buffer, the maximum number of
kilobytes stored in the file before it is rotated.
Command Syntax:
show log-size
Example:
tc1000>show log-size
Response:
performance - 100
ntp - 100
alarm - 100
event - 100
command - 100
security - 100
Set Log-size
Use this command to provision the specified log file buffer size, the maximum
number of kilobytes to be stored in the file before it is rotated.
Command Syntax:
Example:
Remarks: The range is 0 to 100 kilobytes. Provisioning a log file size to zero
disables the logging of that type of data.
Show Log-Interval
This command displays the user provisioned log intervals.
Command Syntax:
show log-interval
Example:
tc1000>show log-interval
Response:
Performance - 60
Set Log-Interval
Use this command to provision the interval for the specified log. The interval is the
time, in seconds, between successive log entries. Only the performance log can be
provisioned.
Command Syntax:
Example:
To set the interval between successive log entries for the perfromance log to a value
of 75 seconds -
Remarks: Setting the log interval to zero disables logging. The range is 10 - 86,400.
Show Logged-in-user
This command displays a list of currently logged in users.
Command Syntax:
show logged-in-users
Example:
tc1000>show logged-in-users
Response:
Remarks:
Related:
Logout
This command terminates the current user connection.
Command Syntax:
logout
Example:
tc1000>logout
Show Mode
This command displays the TimeCreator 1000 mode configuration, either root or
subtending.
Command Syntax:
show mode
Example:
tc1000>show mode
Response:
Remarks: For subtending mode, this command returns "proxy". This is the term
used by the SNMP MIB.
Show NTP
This command displays the NTP configuration, including server addresses, polling
intervals, preferred server, and key information.
Command Syntax:
show ntp
Example:
tc1000>show mode
Response:
NTP configuration:
NTP Query:
==============================================================================
SYMM_TE(0) .GPS. 0 l - 16 0 0.000 0.000 0.015
192.168.83.180 .STEP. 16 u - 1024 0 0.000 0.000 0.000
*192.168.3.98 192.168.10.44 2 u 845 1024 377 1.292 0.048 0.207
Set ntp-server
This command provisions which NTP servers to use, the minimum and maximum
poll intervals, if the server is preferred, and key ID. This information is used when
the TimeCreator 1000 is acting as an NTP client.
Command Syntax:
To add a new NTP server, its key ID, minimum and maximum poll intervals, and if
the server is preferred -
set ntp-server add <server ip-address> [key <keyid>] [min
<value>] [max <value>] [preferred {yes|no}]
To modify an existing NTP server, its key ID, minimum and maximum poll
intervals, and if the server is preferred -
set ntp-server modify <server ip-address> [key <keyid>] [min
<poll value>] [max <poll value>] [preferred {yes|no}]
Example 1:
Example 2:
To modify the minimum and maximum poll intervals of the NTP server at IP address
192.168.15.86 to 32 seconds (<poll value> = 5) and 512 seconds (<poll value> = 9),
respectively:
Example 3:
Remarks: Valid key ID range is 1 to 65534. The poll interval is 2z seconds, where z
= <poll value>. Valid poll intervals are 16 to 1024 seconds, which corresponds to a
range of <poll values> of 4 to 10. The NTP service must be disabled and then
enabled with the Set Service command for changes to take effect. If a key ID is
specified, then authentication is used when connecting to the NTP server. The key
must be defined with the Set NTP-Key command. A maximum of 8 NTP servers can
be specified.
Set ntp-authentication
This command provisions NTP authentication.
Command Syntax:
Example:
Remarks: The NTP service must be disabled and then enabled with the Set
Service command for changes to take effect. This configuration is not used in the
client-server mode of NTP.
Set ntp-key
This command provisions NTP key ID and key string pairs. This will be used when
the TimeCreator 1000 is an NTP client and also when it is an NTP server. Key ID
and string pairs can be added, modified, or deleted.
Command Syntax:
Example 1:
Example 2:
To modify the key string for NTP key ID 41567 to the new string
“zyxvutsrqponmlkj321”:
Example 3:
To delete the NTP key ID of 41567 and its associated key string:
Remarks: Valid key ID range is 1 to 65534 and the key string can be up to 32 ASCII
characters. Up to nine NTP keys can be configured. The key must not contain the
"#" or "?" characters. The NTP service must be disabled and then enabled with the
Set Service command for changes to take effect.
show option
This command displays the option mode and key information.
Command Syntax:
show option
Example:
Response:
Remarks:
set option
This command sets the option mode and key information. The key information is
printed on the Symmetricom-issued certificate for the unit.
Command Syntax:
Example:
Remarks:
Ping
Use this command to ping the host at the specified IP address and display ping
statistics.
Command Syntax:
ping <IP-address>
Example:
Reboot
This command restarts one of the modules. Using this command can cause a loss
of outputs.
Command Syntax:
reboot {imc|ioc1|ioc2}
Example:
tc1000>reboot ioc1
Remarks:
Command Syntax:
Example 1a:
To retrieve the IMC configuration file “/home/user/imc.bak” from the remote server
at IP address 192.168.3.86 -
Example 1b:
To restore the IMC configuration file that was retrieved rom the remote server -
Related:
Command Syntax:
Example 1a:
To retrieve the IOC configuration file “/home/user/imc.bak” from the remote server at
IP address 192.168.3.86 -
Example 1b:
To restore the IOC configuration file that was retrieved rom the remote server -
Related:
Show Remote-syslog
This command displays the remote syslog server(s) that log messages are sent to
from the TimeCreator 1000.
Command Syntax:
show remote-syslog
Example:
To display the remote syslog server(s) that log messages are sent to from the
TimeCreator 1000 -
tc1000>show remote-syslog
Set Remote-syslog
This command is used to configure the remote syslog servers (maximum 8) to
receive log messages from the TimeCreator 1000.
Command Syntax:
Example 1:
Example 2a:
Example 2b:
Command Syntax:
Example:
Response:
Related:
Command Syntax:
Example:
Response:
Related:
Command Syntax:
Example
Command Syntax:
Example:
To enable the rapid recovery mode for root server recovery on Port 5:
Command Syntax:
Example:
Related:
Command Syntax:
Example:
Related:
Show Services
This command displays all TimeCreator 1000 service states.
Command Syntax:
show services
Example:
tc1000>show services
Reponse:
Service States:
eia-232 - enable
telnet - enable
ssh - enable
ntp - enable
snmp - enable
syslog - enable
Remarks: Services include EIA-232, Telnet, SSH, NTP, Syslog, and SNMP.
Set Service
Use this command to specify the state of each service.
Command Syntax:
Example:
To enable SNMP:
Remarks: Services include EIA-232, Telnet, FTP, SSH, NTP, Syslog, and SNMP.
Show SNMP
Use this command to display all assigned SNMPv3 users, including AuthType,
PrivType, and access type.
This command can also be used to display whether SNMPv2 is enabled, and
whether read-write access is available.
This command can also be used to display whether traps are sent as SNMPv2 or
SNMPv3, the trap destination IP addresses, and the trap ports (default is 162).
Command Syntax:
To display whether traps are sent as SNMPv2 or SNMPv3, the trap destination IP
addresses, and the trap ports (default is 162):
show snmp trap
Example 1:
Response 1:
v3user1 priv
v3user2 auth
v3user3 auth (read only user)
v3user4 noauth (read only user)
Example 2:
Response 2:
Host: 192.168.3.45
SNMPv3 trap user: v3user1
Host: 192.168.3.44
SNMPv3 trap user: v2user2
Example 3:
Response 3:
SNMPv2 is enabled
SNMPv2 read only community: public
SNMPv2 read write community: private
Set SNMP
Use this command to provision the SNMPv3 user assignments, trap destination
assignments, SNMPv2 state, and v2 community assignments.
In order to use SNMP traps, the user must specifiy the IP address of the destination
for the trap message. Up to 5 destinations can be specified. In order to send
notifications, you must enter at least one trap destination IP address.
SNMPv3 users can provisioned as one of three security levels: Private, Author, and
Non Author. SNMPv3 users can be provisioned as one of two access levels:
read-only and read-write.
The following figure shows the hierarchy for the set snmp command:
Command Syntax:
The TC1000 will prompt for authentication protocol and key for security levels of
Author or Private. The authentication type can be set to MD5 or SHA. If the
security level is Private, the TC1000 will also prompt for a privacy protocol and
key. The privacy type can be set to DES or AES (128-bit).
Use this command to add an SNMP trap destination at the specified IP address
and port, if desired.
set snmp trap add <trap destination
IP-address>[:<port#>][<SNMPv3 user>|
<SNMPv2 rocommunity-name>|<SNMPv2 rwcommunity-name>|public]
Use this command to delete the SNMP recipient at the specified IP address:
set snmp trap delete <trap destination IP-address>
Use the above command to create a read-only SNMPv2 community. The default
value for rocommunity-name is “public”.
set snmp accessv2 rocommunity [<rocommunity-name>]
Use the above command to create a read-write SNMPv2 community. The default
value for rwcommunity-name is “private”.
set snmp accessv2 rwcommunity [<rwcommunity-name>]
Example 1:
To add an SNMPv3 user named “v3user1”, with a security level of “priv” and an
access level of “rw”:
Authentication key:
Privacy key:
Response 1:
Example 2:
Example 3a:
To add an SNMP trap destination with the IP address 192.168.5.177 and a v3 user
named “v3user1”:
Example 3b:
To add an SNMP trap destination with the IP address 192.168.5.178, port 1098, and
v2 trap rocommunity named “v2rocommunity1”:
Example 4:
Example 5:
Example 6a:
Example 6b:
Example 7:
Show Statistics
This command displays the statistics information for the following:
Command Syntax:
show statistics
Example:
tc1000>show statistics
Clear Statistics
This command clears all statistics.
Command Syntax:
clear statistics
Example:
tc1000>clear statistics
Show Status
This command displays the system status information as follows:
Command Syntax:
show status
Example:
tc1000>show status
Set-timeout
Use this command to change the timeout time. If the timeout is reached, the CLI
logs out with a message “Session timeout” … The user can set the timeout as
desired.
Command Syntax:
set-timeout <value>
Example:
tc1000>set-timeout 900
Remarks: The range for the session timeout parameter is 30 3600 seconds.
TimeCreator will accept the set-timeout command from Level 1 and Level 2
users, but TimeCreator will return the message “Unable to open configuration file to
record timeout value”. The value entered by Level 1 or Level 2 users will only apply
to the session in which the command was entered.
Show TOD-Source
This command displays the Time Of Day Source.
Command Syntax:
show tod-source
Example:
tc1000>show tod-source
Set TOD-Source
Use this command to provision the TOD Source for GPS, DTI client port, NTP
server, or the local Real-Time Clock.
Command Syntax:
Example:
Note: If the system has passed the warm up state, the Sync
TOD-Source command is also required.
Sync TOD-Source
Use this command to change the time and phase of the DTI outputs by
synchronizing with the TOD source. Use this command to provision the
TOD-Source to “jam sync” when the command is issued or at the specified
date/time.
Command Syntax:
Example 1:
Example 2:
Unlockcli
This command is used to release a CLI lock. The TimeCreator 1000 can support up
to 5 Telnet sessions, with commands being executed on a first-in/first-out (FIFO)
basis. In the event that a command from a session cannot be fully executed, other
CLI users are essentialy locked out. This command releases the CLI lock.
Command Syntax:
unlockcli
Example:
tc1000>unlockcli
Upgrade
Use this command to upgrade the specified modules firmware with the specified
filename. The system can download the file from an http, ftp, or sftp server. If the
optional keyword “auto-reboot” is added, then the upgraded card will reboot after
being upgraded. IOC cards will verify that there is a standby IOC card available
before rebooting. The new firmware is not used until the card is rebooted.
Command Syntax:
The user will be prompted for the username and password for the server.
Example:
To upgrade IOC1 with the file “ver2.bin”, which is located at server IP address
192.168.5.64, via FTP, and then to auto-reboot IOC1 afterwards:
Show User
This command displays all assigned users and access levels.
Command Syntax:
show user
Example:
tc1000>show user
Response:
Name - admin
Access Level - admin
Lock State - unlock
Name - bobo
Access Level - user
Lock State - unlock
Set User
Use this command to provision the local user password and access level.
Command Syntax:
Use this command to add a new user. The system prompts the Administrator for
username, password, password verification and level of access. A maximum of
30 users can be specified.
set user add
Use this command to modify the access level for an existing user.
set user modify <username> access-level <level>
Use this command to change the password for the indicated user. The system
prompts for the password.
set user password <username>
Use this command to unlock the specified user. Users are locked out after 3
consecutive failed login attempts.
set user unlock <username>
Use this command to remove all users from the access list and set the default
user and password.
set user default
Note:
/ ( ) | \ ; : “ ‘ , < >
Example:
See Managing the User Access List, on page 74 for detailed examples for this
command.
Show Whitelist
This command displays the list of IP addresses on the whitelist.
Command Syntax:
show whitelist
Example:
tc1000>show whitelist
Set Whitelist
Use this command to add or delete IP addresses to/from the whitelist. Once the first
IP address has been added to the whitelist, any future IP sessions will only be
accepted if they originate from IP addresses from the whitelist. In the default
condition, all IP addresses are allowed access.
Command Syntax:
Use this command to commit changes to the whitelist. The whitelist must be
committed before any changes to the whitelist will be implemented:
set whitelist commit
Use this command to set the whitelist to default conditions, where all IP
addresses are allowed access:
set whitelist default
Example 1:
Example 2:
To add the IP address 192.168.5.0, with the mask value of “24” bits (255.255.255.0)
to the whitelist:
Example 3:
Example 4:
To set the whitelist to default conditions, where all IP addresses are allowed access:
Remarks: The whitelist must be committed before any changes to the whitelist will
be implemented.
This section describes the two versions of SNMP supported by the TimeCreator
1000: SNMPv2c and SNMPv3.
SNMP Features
The Simple Network Management Protocol (SNMP) is an application layer protocol
that allows you to manage network devices. SNMP is based on a client-server
query-response mode that requires an Ethernet connection. A manager application
(software installed on a computer) is the client generating the queries, and an agent
(software on the TimeCreator 1000) is the server generating responses. The
TimeCreator 1000 SNMP supports most existing functions.
If SNMP is present, port 161 becomes the port of standard SNMP interactive
communications and port 162 becomes the trap port.
Alarm management
GPS input configuration
DTI client and server port configuration
TOD source configuration
The MIB is controlled by the TimeCreator 1000’s SNMP agent. The SNMP agent is
a server program that sends TimeCreator 1000 status (stored in the MIB database)
to the network manager when the manager transmits GET or GETNEXT messages.
The manager can also transmit SET messages that instruct the agent to set MIB
variables to new values. The TRAP message is used by the server to send the
manager indications of MIB occurrences, such as a fault condition.
Enabling SNMP
The Set Service Snmp command allows you to enable or disable the SNMP (see
Set Service, on page 250).
Example:
Example 1:
Example 2:
Type set snmp trap add 192.100.100.100 v3user1 then press Enter.
Example
Use the following command to add user ABC with the 20 character MD5
authentication key 123456789ABCDEFGHIJK and 16 DES character privacy key
123456789ABCDEFG.
Type set snmp accessv3 add abc SecureLvl priv AccessLvl rw and press
Enter.
270 TimeCreator 1000 User’s Guide 097-93100-01 Revision C – February, 2010
Appendix B Command Descriptions and Communications Interface
Network Time Protocol
Example 1
Use the following command to display the list of SNMPv3 users (admin user level 3
required).
Example 2
Use the following command to display the list of SNMP trap destinations and trap
users (admin user level 3 required).
Example 1
Use the following command to display the list of SNMPv2 communities (admin user
level 3 required).
The TimeCreator 1000 implements NTPv4, and supports the NTP v.3 (RFC 1305)
version. It can run as a server application and a client application. The NTP server
always runs and the client is enabled independently.
Server Mode
The NTP server application always runs at port 123 (default NTP port) on the NTP
Ethernet port and responds to requests for time in the NTP format. The NTP
datagram provides fields (bits) of information that indicate the integrity of the time
delivered by the server, two of these are the LI and STR fields. The Leap Indicator
(LI) field indicates that Time has been successfully set (LI=0) or that Time has not
been successfully set (LI=3). The Stratum (STR) field indicates the number of
“hops” a client is from the root NTP server: for every hop, STR is incremented by
one (1). If the unit has time set from GPS, then it indicates it is a primary time source
with 0 in the LI field and 1 in the STR field. If the unit has time set by the client
application, it indicates it is a secondary source with a 0 in the LI field and the
source server STR + 1 in the STR field.
If the unit time has not been set by one of the above then it indicates that time is not
valid by setting the LI field to 3. Once the unit time has been set by either radio or
client then LI = 0. Setting time by the keyboard sets (or leaves) LI = 3, since this is
not an accurate time setting.
Client Mode
If GPS is not available or if it is disabled, and a valid NTP server is configured, then
the unit will request time from port 123 of the assigned server IP at the designated
time interval (16 to 1024 seconds). Once time is set by the client mode, the server
will have LI = 0 and Stratum = the time source STR + 1. A second server IP may be
entered and the NTP protocol will check both servers and select the best source per
the NTP specifications. An NTP response received in the client mode overrides the
time set by keyboard and changes the LI field to 0 as indicated above.
Secure File Transfer Protocol (SFTP) uses SSH to transfer files encrypting both
commands and data, including passwords, to provide secure transmission for
copying files.
This document describes the procedures for installing the Symmetricom Two-Way
GPS antenna and the Two-Way Antenna Interface.
In This Appendix
Tools
Parts
Making GPS Connections
Tools
These standard tools and materials are not supplied, but may be required for
installing the Two-Way GPS antenna:
Parts
The following table identifies the parts available for the GPS antenna.
To connect the GPS antenna signal, you must install a GPS antenna using the
procedure in this document.
Prior to installing the antenna, the site, antenna location, lightning suppressor
location, cable route, and all other details should be planned. Use Figure C-1 as a
guide to locating the antenna.
To install the antenna, refer to Figure C-2, and perform the procedure in this section.
Ensure all user-supplied materials are available. The maximum distance between
the antenna and the device is approximately 985 feet (300 m). The minimum cable
length is 6.6 feet (2 m). The GPS Antenna should always be as close to the
TimeCreator 1000 as practical.
1. Attach the antenna mounting bracket to a 1-inch (2.5 cm) diameter pipe or wood
post.
5. Connect the cable to the antenna “pigtail” and pull the cable back through the
mast.
6. Mount the antenna and mast assembly to the “L” bracket using the supplied nuts,
bolts, and washers, as shown in Figure C-5.
7. Using a plumb line or bubble level, ensure the antenna is within 5° of vertical
(perpendicular to the horizon), and tighten the mounting bracket bolts.
8. Bolt the lightning suppressor mounting plate to a flange that is attached to a valid
earth ground. The roof ring ground system, a grounding plate, and building
structural steel are examples of valid earth ground points. If the mounting plate
cannot be bolted to a valid earth ground, bolt the mounting plate to a point within
15 feet (4.6 m) of the chosen valid earth ground. A minimum 30-foot (9 m) bend
radius is required when installing the ground wire. If the mounting plate is to be
installed in a nonmetallic junction box, perform the installation and bolt the
assembly near the chosen valid earth ground.
10.Install 1.5 inch (3.8 cm) nonmetallic conduit from the antenna to the lightning
suppressor, and from the lightning suppressor to the cable entrance into the
building.
12.Route the antenna cable through the conduit, and connect the cable to the
lightning suppressor. See Table C-1 for specific cable lengths.
13.If the lightning suppressor is not mounted directly to a valid earth ground, crimp a
length of 4.115 mm (6 AWG) ground cable to the two-hole terminal, slide the
terminal over two of the three threaded posts on the lightning suppressor
mounting plate, and attach the terminal to the mounting plate with two KEPS
nuts. Use the two posts that allow the least bending of the cable.
15.Install fire-stopping material in all holes opened in the roof and/or walls during
this procedure.
16.Check all connections for tightness to prevent arcing and intermittent operation.
This appendix provides mechanical and electrical specifications and factory defaults
for the TimeCreator 1000.
In This Appendix
Specifications
Factory Defaults
Specifications
This section provides the specifications for the TimeCreator 1000 components and
input and output signals.
Mechanical
Parameter Description
Environmental
Parameter Description
Power
Parameter Description
AC Power 40 W
DC Recommended 3A
Battery Feed Fuse
DC Power 40 W
Serial Port
Item Description
Interface RS-232
Baud Rate 9600 Kbps (57600 is supported only in the IMC rev H
version 1.00.13 or below)
Data Bits 8
Stop Bits 1
LAN Port
Connector Description
Input Signals
Parameter Specification
GPS
DTI
Output Signals
Parameter Specification
Roof Antenna
Parameter Specification
Power 36 V nominal
Impedance 50 / 75
Factory Defaults
This section provides the factory defaults for the TimeCreator 1000 GPS and DTI
port parameters, IMC and communications parameters, and alarm parameters.
Leapseconds 14 0 to 40
Table D-10 provides the IMC module and communication parameter factory default
values and range.
Port 1 thru 12 – P-P_Jitter Set Threshold (pS) 8000 0 = Disable, 5000 to 10000000
Port 1 thru 12 – P-P_Jitter Clear Threshold (pS) 5000 0 = Disable, 5000 to 10000000
Port 1 thru 12 – MTIE-35 Set Threshold (pS) 10000 0 = Disable, 5000 to 10000000
Port 1 thru 12 – MTIE-35 Clear Threshold (pS) 7000 0 = Disable, 5000 to 10000000
Port 1 thru 12 – MTIE-t Set Threshold (pS) 10000 0 = Disable, 5000 to 10000000
Port 1 thru 12 – MTIE-t Clear Threshold (pS) 7000 0 = Disable, 5000 to 10000000
Note: For 8-port IOC module option, these parameters apply to Ports
1 thru 6, Port 11, and Port 12
This product contains licensed third party software, including software available
under the GPL licensing scheme. The text of each license is available in the
“License” folder located on the Product Information CD-ROM that is supplied with
the TimeCreator 1000. Additionally, you can obtain these licenses and the
open-source software by contacting Symmetricom Technical support at the
following numbers:
By using the TimeCreator 1000, the user agrees to the terms of these licenses.
In This Appendix
Third-Party Software
Third-Party Software
bash-2.05a
busybox-1.01
cron-3.0pl1
daemontools-0.76
dhcpcd-1.3.22pl1
e2fsprogs-1.27
eepro100-1.09
findutils-4.1.7
glibc-2.3.2
glibc-2.3.2
grub-0.97
hardhatutils-1.14
hostname-2.09
ifupdown-0.6.4
initscripts-2.78
iproute-20030805
iptables-1.2.9
iputils-tracepath-20020124
kernel-2.4.20_dev
less-358
libpam-0.72
libpam-cracklib-0.72
libpam-dev-0.72
libpam-modules-0.72
libpam-runtime-0.72
linux-ftpd-0.17
linuxinfo-1.1.7
logrotate-3.5.7
ltrace-0.3.10
macphy-1.6
mii
modutils-2.4.21
mount-2.11h
net-snmp-5.1
net-tools-1.60
netbase-4.06
netkit-telnet-server-0.17
ntp-dev-4.2.0b-rc1-20060306
openssh-3.7.1p2
openssh-clients-3.7.1p2
openssh-server-4.2p2
openssl-0.9.7b
pam_radius_license-1.3.16
pam_tacplus-1.2.9
pam_tally-0.1
pciutils-2.1.8
rpm-4.1
setserial-2.17
shellutils-2.0.11
sudo-1.6.7p3
sysklogd-1.4.1
sysvinit-2.78
util-linux-2.11h
xinetd-2.3.3