Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
PC:
1. From a PC that is on the same network as the TimeProvider 500, select Start >
Run.
2. In the Run dialog box, select cmd, then click OK. This initiates a command
session as shown in Figure 2-6.
3. At the prompt, type ping followed by the TimeProvider 500 IP address, then
press Enter. See Figure 2-6. The example shows successful connection.
Figure 2-6. Pinging the TimeProvider 500
44 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 2 Installation & Configuration
Configuration Setup
If ping was not successful, here are some considerations:
First, ensure that a physical link has been established from the TimeProvider 500
to whatever it is connected to (likely a switch). The small green LED in the
upper-right-hand corner of the 1588 connector on the TimeProvider 500 (see
Figure 1-4) should be lit solid green. If it is not, there is likely a basic link problem.
A similar check can be done on the computer being used for the ping. For the
remainder of this discussion, it is assumed that the user is able to establish
connection from the computer into the network that includes the PTP flow of the
TimeProvider 500 being used.
Once the physical link is established, ensure that the device linked to the
TimeProvider 500 is capable of running 100Base-T. The TimeProvider 500 will
auto-negotiate the rate, but does not support speeds other than 100Base-T.
Configure PTP Settings
Now that the TimeProvider 500 is configured for the network, configuration of PTP
settings can be configured for access to the target grandmaster to establish PTP
packet flow. Using the show ptp command, current PTP configuration data is shown
in Figure 2-7.
Figure 2-7. GrandMaster (GM1) Factory Default Settings
Setting the Target Grandmaster IP Address
As with the TimeProvider 500, the IP address for the grandmaster will likely be
customized for your system network. The IP address of the grandmaster is
configured on the grandmaster. To configure the TimeProvider 500 to use the
grandmaster IP address, use the set ptp address command as shown in the
following example:
Note: Auto-negotiate can be disabled using the set auto-neg
command.
TP-500> show ptp
PTP Mode : Unicast
Client MAC address : 00:B0:AE:01:22:D5
Grand Master 1 IP : 192.168.1.11
Grand Master 2 IP : 0.0.0.0
Management IP : 0.0.0.0
Multicast IP : (NONE)
Management GM1 : Enabled
Management GM2 : Enabled
Management NODE-MGR: Enabled
Client Clock ID : 00:B0:AE:FF:FE:01:22:D5
Domain : 0
DSCP : 0
Sync Rate : 64 pkts/s
Announce Interval : 1 s
Lease Duration : 300 s
Transport : Ethernet
Factory Default Setting
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 45
Chapter 2 Installation & Configuration
Configuration Setup
TP-500> set ptp address gm1 192.168.1.100
TimeProvider 500 will respond with:
Grand Master 1 address set to 192.168.1.100
Confirm that the setting for the target grandmaster address is now configured by
using the show ptp command.
Figure 2-8. Confirming GrandMaster (GM1) IP Address Setting
Configure GrandMaster (GM2) Clock (Optional)
The TimeProvider 500 allows you to select two grandmaster clocks for its source of
synchronization. Configuring the target address for the second GrandMaster (GM2)
is similar to the configuration for the primary GrandMaster (GM1), except that GM2
is used in the set ptp address command instead of GM1. Confirmation of the second
GrandMaster (GM2) address can be seen via show ptp as shown in Figure 2-7. In
the example, note that the GM2 IP address is shown as 0.0.0.0, which is the factory
default (unconfigured). If the second grandmaster is not used, it is recommended
that the 0.0.0.0 setting be left unchanged so that the TimeProvider 500 does not
attempt communication with a second grandmaster.
Confirm Connectivity with Grandmaster Clocks
To confirm connectivity with GrandMasters (GM1/GM2), follow these steps:
1. Use the show ptp command to view the current PTP settings. See the Grand
Master IP address shown in the Setting the Target Grandmaster IP Address
example.
2. Use the ping CLI command to confirm connectivity between the TimeProvider
500 and the targeted grandmaster clock.
TP-500> show ptp
PTP Mode : Unicast
Client MAC address : 00:B0:AE:01:22:D5
Grand Master 1 IP : 192.168.1.100
Grand Master 2 IP : 0.0.0.0
Management IP : 0.0.0.0
Multicast IP : (NONE)
Management GM1 : Enabled
Management GM2 : Enabled
Management NODE-MGR: Enabled
Client Clock ID : 00:B0:AE:FF:FE:01:22:D5
Domain : 0
DSCP : 0
Sync Rate : 64 pkts/s
Announce Interval : 1 s
Lease Duration : 300 s
Transport : Ethernet
46 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 2 Installation & Configuration
Configuration Setup
If there is connectivity, TimeProvider 500 will produce a response similar to the
following:
TP-500> ping if0 192.168.1.100
Pinging 192.168.1.11 [192.168.1.100]:
Reply from 192.168.1.100: time=5ms
Reply from 192.168.1.100: time=0ms
Reply from 192.168.1.100: time=0ms
Reply from 192.168.1.100: time=0ms
If there is lack of connectivity, TimeProvider 500 will produce a response
similar to the following response:
TP-500> ping if0 192.168.1.100
Pinging 192.168.1.11 [192.168.1.100]:
Request timed out
If the ping request times out, here are some considerations to help troubleshoot:
All of the items listed for troubleshooting connectivity with the TimeProvider 500
in Confirm TimeProvider 500 Network Communication, on page 43 should be
considered.
The targeted grandmaster clock settings should be reviewed, if available. For
example, check the address settings it is actually using and anything related to
network configuration. For example, there could be firewalls in place preventing
connection.
If VLAN is being used in the TimeProvider 500, it is essential that the
grandmaster also be a member of the same VLAN (established by the
vlan_config CLI command). If VLAN is enabled, and two grandmasters are
targeted by the TimeProvider 500, then both must be in the same VLAN with the
same VLAN-ID. See Configure PTP Settings for more information.
Confirm PTP Flow
When connectivity between theTimeProvider 500 and the grandmaster clock(s) is
established, the actual PTP flow begins. The TimeProvider 500 starts PTP flow with
a request to the grandmaster clock(s) to send it the appropriate set of PTP packets
at the desired rate and for a desired duration. Once flow is established, the
TimeProvider 500 periodically sends a new flow to prevent a time out. The
automatic time out allows client clocks (such as a TimeProvider 500) to be removed
from the network without continuously consuming resources from the grandmaster
clock.
For a quick visual check for PTP flow, view the LED in the upper right-hand corner
of the RJ-45 connector labeled 1588 (see Link and Flow LED in Figure 1-4). If
there is flow, the Link and Flow LED will blink at a high-rate (multiple blinks per
second). Next, type show status to view a list of current PTP-related settings, as
shown in Figure 2-9.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 47
Chapter 2 Installation & Configuration
Configuration Setup
Figure 2-9. List of Current PTP-Related Settings
Possible Flow State, on page 65 shows several events related to PTP flow that can
be used to check on successful flow.
If the PTP flow is not as expected, here are some considerations:
Although it would likely require special user configuration, make sure the
grandmaster clock does not have its PTP port disabled. A disabled port will not
support PTP flow. TimeProvider 500 provides a similar setting (see the set ptp
addr-mode command), but the port is enabled by default.
Although perhaps unlikely, it is possible that the grandmaster does not have
sufficient resources to support the requested PTP flow. For example, a
grandmaster has a limit on how many clients can be supported.
A quick check for PTP flow can be seen by looking at the 1588 connector's LEDs.
However, for a more reliable and detailed confirmation of PTP flow, use the show
status query to observe the actual flow rate shown in the Flow Direction section of
the status response from the TimeProvider 500 as shown in Figure 2-9. See Details
for Show Status Function, on page 63 for more information about the results of the
show status query.
Configure Frequency Outputs
By factory default, the TimeProvider 500 produces 2.048 MHz output and 1PPS
output. If this is the desired output, no configuration is needed.
The show output command identifies the current output configuration. The
following example shows that the TimeProvider 500 is currently generating 2.048
MHz clock from OUT1, OUT3, and OUT4 and a 1 PPS signal from OUT2.
TP-500> show status
Current Time : 21:51:38 11/09/2009 (UTC)
FLL state : Normal FLL [2840 min] Temperature
Reference : GM2 Avg : 41.01 C
Correction Freq : -10.12 ppb Min : 40.88 C
Phase : 0.00 ppb Max : 41.06 C
Output MDEV Estimate : 0.0002 ppb 5min : 55.37 mC
Residual Phase Error : 2377.13 ns 60min : 166.04 mC
Minimal RTD : 12.57 usec
--------------------------------------------------------------------------
Flow Direction : (GM to client) (client to GM)
GM1 (pkts/s): 0 0
GM2 (pkts/s): 64 64
Weight (%): 1.00 99.00
Transient free (/900): 900 900
Transient free (/3600): 3600 3600
Percentile Clustering(%): 99.8 99.8
Operational Min TDEV(ns): 2.7 1.8
Operational MAFE (ppb): 0.01 0.01
Min Cluster Width (ns): 100.0 100.0
Mode Width (ns): 100.0 200.0
--------------------------------------------------------------------------
Flow State : (GM1)Signaling (GM2)Normal
Clock id : (GM1)00:00:00:00:00:00:00:00 (GM2)00:B0:AE:FF:FE:01:31:65
48 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 2 Installation & Configuration
Configuration Setup
TP-500> show output
Output 1 type : 2.048 MHz Clock
Output 2 type : 1PPS
Output 3 type : 2.048 MHz Clock
Output 4 type : 2.048 MHz Clock
HDB3 : Enabled
Freerun output mode : on
Holdover output mode: on
1PPS offset : 2984 ns
1PPS pulse width : 100000000 ns
1PPS mode : standard
Set the signal type for OUT1, OUT2, OUT3, or OUT4 using the set output
command. The <selection> choices are shown in Table 2-3.
For example, set OUT2 to e1_ccs with the following command:
TP-500> set output OUT2 e1_ccs
Table 2-3. Output Signal Selections for OUT1, OUT2, OUT3 and OUT4
Selection Output Generated
Disable No output
clk_2048 2.048MHz square wave
(default for OUT1, OUT2, OUT4)
e1_ccs E1 CCS, no CRC4
e1_ccs4 E1 CCS, with CRC4
e1_cas E1 CAS, no CRC4
e1_cas4 E1 CAS, with CRC4
e1_ais E1 AIS
clk_1544 1.544 MHz square wave
t1_sf Super-Frame T1
t1_esf Extended Super-Frame T1
t1_iso_pulse T1 Isolated Pulse
1 PPS Pulse Per Second (default for OUT2)
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 49
Chapter 2 Installation & Configuration
Configuration Setup
Optional Configure VLAN Settings Example
When one of the external network devices or telnet sessions communicating with
the TimeProvider 500 is using VLAN, interface connections are available to support
the external network devices (GM1, GM2, node manager) or remote telnet
sessions. For interface connection information, see Interface Connections, on page
55.
An interface connection for communication between the targeted external network
device or remote telnet session and the TimeProvider 500 needs to be established
before a VLAN connection can be established. In this example, the procedure to set
up a VLAN connection for a GM1 is described.
To connect the TimeProvider 500 with a GM1 using VLAN, perform the following
steps:
1. Disable any current PTP flow.
At the TP-500> prompt, type set ptp addr-mode disable, and then press
Enter
2. Enable a VLAN interface to use. For this example, use interface if1.
At the TP-500> prompt, type set interface if1 enable and then press
Enter.
3. Configure the IP settings on the desired VLAN interface. For more details, see
Configure the TimeProvider 500 IP Address, on page 41. For this example, the
interface will be set to 192.168.1.12 and all devices are on the same subnet.
At the TP-500> prompt, type set ip if1 192.168.1.12 netmask
255.255.255.0 gateway 0.0.0.0 and then press Enter.
4. Configure the if1 interface to use the desired VLAN. The range of VLAN ID is 1 to
4094, and the range for priority is 0 to 7. For this example, use a VLAN ID of 404
and a priority of 3.
At the TP-500> prompt, type set vlan-config if1 vlan-id 404
priority 3, and then press Enter.
TimeProvider 500 will respond with the following:
VLAN ID set to 404 and priority to 3
5. Configure the IP address of the grandmaster. For this example, GM1 is selected
and the IP address is 192.168.1.19.
At the TP-500> prompt, type set ptp address gm1 192.168.1.19, and then
press Enter.
50 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 2 Installation & Configuration
Installation and Provisioning Checklist
TimeProvider 500 will respond with the following:
Grand Master 1 address set to 192.168.1.19
6. Now that the GM1 IP address is configured, enable GM1 for PTP management
flow.
At the TP-500> prompt, type set ptp mgmt gm1 enable, and then press
Enter.
TimeProvider 500 will respond with the following:
Management for GM1 enabled
7. Now attach interface if1. If the interface is not attached and enabled,
communication between the TimeProvider 500 and supported network devices
will not work.
At the TP-500> prompt, type set interface attachments gm1 if1, and
then press Enter.
8. The last step is to enable the device for PTP flow.
At the TP-500> prompt, type set ptp addr-mode unicast, and then press
Enter.
The configuration for VLAN communication between the GrandMaster (GM1) and
the TimeProvider 500 on interface connection if1 is now completed.
Installation and Provisioning Checklist
To make sure that you have properly installed and provisioned your TimeProvider
500, use Table 2-4 to verify that you have completed the required operations. For
further details about each of the operations, refer to the section shown in Table 2-4.
Table 2-4. Installation and Provisioning Checklist
Operation More Information Complete
TimeProvider 500 Site Survey Site Survey, on page 33
Unpack Unit Unpack the Unit, on page 34
Shelf Mounting (optional) Rack Mounting the TimeProvider
500, on page 36
Shelf Grounding (optional) Ground the Shelf, on page 37
Apply Power Apply Power, on page 39
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 51
Chapter 2 Installation & Configuration
Installation and Provisioning Checklist
Now that you have completed the required steps to install and configure the
TimeProvider 500 for operation, the Command Line Interface (CLI) can be used for
additional configuration or status monitoring. Refer to CLI Commands, on page 77
for further details.
Establish Serial Communication Establish Serial Communication, on
page 40
TimeProvider 500 Logon Logon to TimeProvider 500, on page
40
Configure TimeProvider 500 IP Address Configure the TimeProvider 500 IP
Address, on page 41
Confirm TimeProvider 500 Network
Communication
Confirm TimeProvider 500 Network
Communication, on page 43
Configure PTP Settings Configure PTP Settings, on page 44
Confirm Connectivity with Grandmaster
Clocks
Confirm Connectivity with
Grandmaster Clocks, on page 45
Confirm PTP Flow Confirm PTP Flow, on page 46
Configure Frequency Outputs Configure Frequency Outputs, on
page 47
Optional Configure VLAN Settings Optional Configure VLAN
Settings Example, on page 49
Table 2-4. Installation and Provisioning Checklist (Continued)
Operation More Information Complete
52 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 2 Installation & Configuration
Installation and Provisioning Checklist
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 53
Chapter 3 Operations
This chapter provides information on the operations of TimeProvider 500. It includes
PTP management, interface connections, settings for TOD, packet flow and
operation state descriptions, an explanation of a show status example, information
about alarms and events, frequency locked loop, logs, user sessions, and a GM2
GrandMaster description.
In This Chapter
Introduction
PTP Management
Interface Connections
Multicast Support
Time-Setting
IPDV
Details for Show Status Function
Flow State
Frequency Locked Loop
Alarms & Events
Date & Time
TimeProvider 500 Logs
User Sessions
Firmware Upgrade
GM2 GrandMaster
Introduction
Having completed the initial setup and checklist, the unit is now ready for operation
as a 1588 client-clock. This section provides information about how to interpret
TimeProvider 500 operational status and performance. See the CLI Commands, on
page 77 for a complete list of configuration and query commands with examples
and responses from TimeProvider 500.
54 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
PTP Management
PTP Management
In addition to providing synchronization with a grandmaster clock, the TimeProvider
500 also supports the management facilities of PTP. This allows PTP node
managers selected control over the TimeProvider 500, the ability to obtain status
information, and to receive alarms. Node managers can collect and analyze the
status data and potentially send out notifications to a management system based on
this data. Node managers can either be a specific device or can be combined with a
grandmaster, such as the TimeProvider 5000. Node managers can continue to
manage the TimeProvider 500 via PTP management messages even if the
synchronization flow has been disabled via set the ptp addr-mode disable
command. See set ptp address for further information.
PTP management messages can be used to set the acceptable master table,
reboot the unit, or to upgrade the firmware. They can also be used to read the
acceptable master table, get status information, respond to the null-mgmt message,
and get the clock description.
The following list describes similarities between PTP management messages and
CLI commands:
Setting acceptable master via PTP management is similar to using CLI command
set ptp address. Only 1 or 2 acceptable masters can be configured. These map
to GM1 and GM2. The alternate priority field is not used.
Rebooting the TP500 via PTP management performs an action identical to CLI
command reboot system.
Upgrading the TP500 firmware via PTP management performs an action
identical to CLI command upgrade. An autonomous PTP message (see below) is
available to provide indication to a node-manager that an upgrade is in process.
The information provided by the get status PTP management command is
identical to what is provided by CLI command show status-list query.
Obtaining clock description via PTP management is similar to using CLI
commands show inventory and show image. Additionally, user description text is
conveyed in this message, settable using CLI command set udesc.
The TimeProvider 500 can be configured to autonomously send PTP management
messages to the node managers when an alarm is generated or cleared. The
commands in the set alarm-config category apply to both local alarm indication
(alarm LED and event log) and autonomous PTP alarm generation. A new
command, set alarm-config proxy, provides additional control regarding whether or
not a specific alarm will generate an autonomous PTP management message.
The user can control which devices have access to the PTP management
capabilities of the TimeProvider 500. The TimeProvider can be configured to allow
the GrandMasters GM1 or GM2, or a specific node manager to be enabled for
management. See set ptp mgmt and set ptp address.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 55
Chapter 3 Operations
Interface Connections
Interface Connections
TimeProvider 500 has support for up to four different VLANs when a GM1, GM2,
node manager, and remote telnet session are on different VLANs. Interface
connection support for the four different VLANs can be any combination of network
devices and remote telnet sessions. An interface connection is also available for all
non-VLAN connections. How you define an interface connection depends on the
network configuration being used.
PTP Devices
The PTP devices that can be configured with the TimeProvider 500 are the
following:
GM1 a GrandMaster clock that exchanges PTP packet flow with the
TimeProvider 500.
GM2 a GrandMaster clock that exchanges PTP packet flow with the
TimeProvider 500 when the GM1 is not responding.
Node Manager a PTP device that is connected to the network and understands
PTP management messages. A node manager serves as an interface for PTP
message transportation between PTP-related devices such as grandmaster
clocks and clients.
Remote CLI Command Access
All interface connections are available for VLAN and non-VLAN remote telnet
sessions.
Interface Connection Considerations
The following are guidelines when connecting an interface:
1. Decide which external device you want to have connect with the TimeProvider
500, and the connection requirements for the external device.
2. Once a targeted external device is decided upon, determine whether a VLAN
interface is needed and select an interface.
3. Set the IP address of the TimeProvider 500 that is consistent with the external
device connection.
4. If it is a VLAN connection, set the VLAN ID and VLAN priority.
Note: Both GrandMasters (GM1 & GM2) can function as a node
manager device in addition to being a grandmaster clock.
56 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Interface Connections
5. Enter the IP address of the targeted external device for the interface connection
with the TimeProvider 500.
6. Attach the targeted external device by first identifying which external device you
are targeting and then attach the targeted device with the interface connection
selected in step 2.
7. Finally, enable the interface, and for grandmasters, enable the PTP flow. For
node managers, enable PTP management.
See Optional Configure VLAN Settings Example for an example of setting an
interface connection between the TimeProvider 500 and a GM1 using a VLAN.
Figure 3-1. Interface Connections
if0, if1, if2, if3 & if4
For a VLAN connection, the if1, if2, if3, and if4 interface connections are available.
For a non-VLAN connection, the if0 interface connection is available. The
TimeProvider 500's factory default for if0 is enabled which means the unit is ready
for communication with all non-VLAN PTP devices and remote telnet sessions
without an interface connection configuration.
Ethernet
Ports
GM1
GM2
Node
Manager
Telnet
Sessions
TimeProvider 500
if0 - no VLAN
if1 - VLAN
if2 - VLAN
if3 - VLAN
if4 - VLAN
Attachments
GM1
GM2
Node
Manager
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 57
Chapter 3 Operations
Interface Connections
The if0 interface connection must be enabled for non-VLAN connections. To set if0
for non-VLAN connections, use the set interface command. For telnet sessions,
once the if0 interface connection is enabled and the IP address for the TimeProvider
500 is set using the set ip command, non-VLAN telnet sessions can begin. For PTP
devices, once a GrandMaster (GM1 or GM2), or node manager's IP address
information is configured for connection using the set ptp address command,
non-VLAN PTP device communication can begin as shown in Figure 3-2. For
management communications, the set ptp mgmt needs to be configured as well.
Figure 3-2. Non-VLAN Interface Connections
The four VLAN interface connections (if1, if2, if3 and if4) can be used when PTP
devices and telnet sessions are all using different VLANs. The TimeProvider 500
can be configured for separate VLANs for each of the PTP management devices
and remote telnet sessions using the set ip, set interface, set vlan-config and set
interface attachments commands as shown in Figure 3-3.
When PTP devices (GM1, GM2, and the node manager) connected to TimeProvider
500 are on the same VLAN and share the same VLAN ID, there is no need to use
more than one interface connection. Remote telnet sessions using VLAN can also
use one of the interface connections but does not need to be attached to one of the
interfaces. In Figure 3-3, GM1, GM2 and the node manager are all on the same
VLAN with VLAN ID 2223 and a telnet session is on VLAN with VLAN ID 26. All are
configured for one of the interface connections using the set interface CLI
command. PTP management devices need to be identified after setting an interface
connection with the set interface attachments command.
Ethernet
Ports
GM1
GM2
Node
Manager
Telnet
Sessions
TimeProvider 500
set ip
set interface
if0 - no VLAN
if1 - VLAN
if2 - VLAN
if3 - VLAN
if4 - VLAN
non-VLAN
n
o
n
-V
L
A
N
n
o
n
-V
L
A
N
n
o
n
-
V
L
A
N
58 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Multicast Support
Figure 3-3. Separate VLAN Interface Connections
Reviewing Interface Configurations
There are two interface-related CLI commands for reviewing interface settings;
show interface config and show interface status. The show interface config CLI
command is available to display interface configuration settings entered by the user.
The show interface status CLI command provides a network's perspective by
displaying the network settings used by the system based on the user's
configuration settings.
Multicast Support
Both unicast and hybrid-multicast mode are available with TimeProvider 500
version 2.0. Multicast mode is a hybrid of multicast sync and announce messages
and unicast delay response messages. When selecting multicast mode, the
TimeProvider 500 joins the multicast within the network system and observes all
announce messages. Only announce messages from grandmaster clocks in the
same domain as the TimeProvider 500 will be assessed for candidacy as the best
master clock (BMC). See Figure 3-4. With hybrid-multicast mode, unicast announce
messages that are received should not be included while evaluating BMC. The
TimeProvider 500 will use unicast negotiation to authorize a unicast delay
request/response flow with the grandmaster selected via BMC.
GM1
GM2
Node
Manager
Telnet
Sessions
TimeProvider 500
set ip
set interface
set vlan confg
set interface attachments
if0 - no VLAN
if2 - VLAN
if3 - VLAN
if1 - VLAN
if4 - VLAN
Attachments
GM1
GM2
Node
Manager
Ethernet
Ports
VLAN ID 2223
V
L
A
N
ID
2
2
2
3
V
L
A
N
ID
2
2
2
3
V
L
A
N
I
D
2
6
VLAN ID 26
VLAN ID 2223
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 59
Chapter 3 Operations
Multicast Support
Figure 3-4. Multicast Operational Behavior
Once the BMC is selected based on announce comparisons within the multicast
environment, a sync flow is only allowed from the selected best grandmaster clock.
See Figure 3-5.
Start Multicast
Wait for qualified
Announce
message
Wait for SYNC
flow
Announce message good
Signal for Delay
flow
Wait for Delay flow
Normal
SYNC flow adequate
Delay flow adequate
Announce message not qualified
SYNC flow not adequate
Delay flow not adequate
60 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Multicast Support
Figure 3-5. BMC Behavior
In hybrid-multicast mode, the GM1 and GM2 addresses do not need to be
configured. These addresses are not used in the BMC algorithm to determine which
master to use. However, the GM1 does need to be attached to the appropriate
interface. GM2 is not used in hybrid-multicast mode.
The TimeProvider 500 only supports unicast PTP management; it does not support
multicast PTP management. If GM1 or the node manager is configured and enabled
for management, then the TimeProvider 500 will allow management from the
configured device. If GM1 is not configured and enabled, then the TimeProvider
5000 will allow PTP management from the current grandmaster.
1. Set the IP address for the TimeProvider 500 interface. For this example, assume
a non-VLAN address of 192.168.1.5 with no gateway.
At the TP-500> prompt, type set ip if0 192.168.1.5 netmask
255.255.255.0 gateway 192.168.1.1, and then press Enter.
2. Attach the GM1 interface. Only GM1 is used with multicast. The GM1 address
does not need to be configured in multicast mode.
At the TP-500> prompt, type set interface attachments gm1 if0, and then
press Enter.
3. Enable hybrid-multicast mode.
Start
Receive Multicast Announce
message
?
yes
no
no
yes
Is Announce
qualified?
Is new GM
better than
current GM?
Change to new
GM
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 61
Chapter 3 Operations
Multicast Support
At the TP-500> prompt, type set ptp addr-mode multicast-hybrid, and then
press Enter.
4. View the changes made.
At the TP-500> prompt, type show interface status, and then press Enter.
TP-500> show interface status
Interface Status:
Name status ip-address netmask gateway ip-mode vid vpri
-------------------------------------------------------------------------------
if0 Enabled 192.168.1.5 255.255.255.0 192.168.1.1 Static -- --
if1 Disabled ------ ------ ------ Static 66 0
if2 Disabled ------ ------ ------ Static 569 5
if3 Disabled ------ ------ ------ Static 1666 1
if4 Disabled ------ ------ ------ Static 3334 1
-------------------------------------------------------------------------------
Attachments:
Device interface
---------------------
GM1 if0
GM2 if2
NODE-MGR if0
---------------------
TP-500> show ptp
PTP Mode : Multicast-Hybrid
Client MAC address : 00:B0:AE:01:22:AD
Grand Master 1 IP : 0.0.0.0
Grand Master 2 IP : 0.0.0.0
Node Management IP : 0.0.0.0
Multicast IP : 192.168.1.11
Management GM1 : Enabled
Management GM2 : Enabled
Management NODE-MGR: Disabled
Client Clock ID : 00:B0:AE:FF:FF:01:22:AD
Domain : 0
DSCP : 0
Sync Rate : 64 pkts/s
Announce Interval : 1 s
Lease Duration : 300 s
GM1 Lease Duration : 300 s
GM2 Lease Duration : 300 s
Transport : Ethernet
62 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Time-Setting
Time-Setting
In TimeProvider 500 version 1.0, time could only be set by the user with the set
clock CLI command. In Version 2.0, the local clock-setting method continues to be
supported with the set clock time CLI command, but time-setting from a
grandmaster as a PTP-time related reference is added in version 2.0.
When the TimeProvider 500 receives its time from a grandmaster clock, the time is
continuously monitored and updated. Sudden jumps compared to the TimeProvider
500s current time setting are recorded in the event log and various show
commands.
Other time-related CLI commands have been introduced in Version 2.0 so that the
user can select a timescale and make timezone adjustments when reporting time.
See set clock timescale and set clock timezone for more information.
IPDV
The TimeProvider 500 can make IPDV (IP Packet Delay Variation) measurement.
These will be made on the packet flows to the currently-used grandmaster. Sync
packets will be used for forward measurements and delay packets used for the
reverse measurements. The following measurements can be made:
Forward and Reverse IPDV% below Threshold: These results use the set
ipdv <threshold> setting to define the boundary and set ipdv interval
<value> to define the data collection window. The results reported (one for each
flow direction) are the percentage of delay variation measurements made within
the data collection window that were smaller than the defined threshold.
Forward and Reverse Maximum IPDV: These results use set ipdv interval
<value> to define the data collection window. The results reported (one for each
flow direction) are the maximum delay variation measurement made within the
data collection window. Results are in usec.
Forward and Reverse Inter-Packet Jitter: These results use the set ipdv
pacing <samples> setting to define the spacing of the inter-packets and set
ipdv interval <value> to define the data collection window. The results
reported (one for each flow direction) are an estimate of the packet-to-packet
jitter observed within the defined data collection window. Results are in usec.
Note: If a grandmaster is the reference for time, any local setting via
the set clock time CLI command will be overridden by the
grandmaster clock reference.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 63
Chapter 3 Operations
Details for Show Status Function
Details for Show Status Function
This section describes performance-related information available using the show
status and show status-list query CLI commands. The status of the flow state
provides data on the condition of the 1588 message flow between the TimeProvider
500 and a GrandMaster (GM1/GM2). The temperature values available provide a
method for viewing temperature behavior. Figure 3-6 shows an example of a show
status query.
Figure 3-6. Show Status Query Example Top Section
The following describes the information available in the show status and show
status-list CLI commands:
Current Time shows the TimeProvider 500s current time for logging and alarm
reporting. See set clock time, on page 86 for details on how to configure time for
the TimeProvider 500.
FLL State the current state of the Frequency Locked Loop (FLL). For details,
see Frequency Locked Loop, on page 67.
Reference identifies the device that is exchanging flow with the TimeProvider
500.
Note: Warm-up FLL state duration does not increment until a flow is
established.
TP-500> show status
Current Time : 21:51:38 11/09/2009 (UTC)
FLL state : Normal FLL [2840 min] Temperature
Reference : GM1 Avg : 41.01 C
Correction Freq : -10.12 ppb Min : 40.88 C
Phase : 0.00 ppb Max : 41.06 C
Output MDEV Estimate : 0.0002 ppb 5min : 55.37 mC
Residual Phase Error : 2377.13 ns 60min : 166.04 mC
Minimal RTD : 12.57 usec
--------------------------------------------------------------------------
Flow Direction : (GM to client) (client to GM)
GM1 (pkts/s): 64 64
GM2 (pkts/s): 0 0
Weight (%): 1.00 99.00
Transient free (/900): 900 900
Transient free (/3600): 3600 3600
Percentile Clustering(%): 99.8 99.8
Operational Min TDEV(ns): 2.7 1.8
Operational MAFE (pps): 0.01 0.01
Min Cluster Width (ns): 100.0 100.0
Mode Width (ns): 100.0 200.0
--------------------------------------------------------------------------
Flow State : (GM1)Signaling (GM2)Normal
Clock id : (GM1)00:B0:AE:FF:FE:01:31:65 (GM2)00:00:00:00:00:00:00:00
64 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Details for Show Status Function
Correction Freq shows the current rate correction (in parts per billion: 1E-9)
applied to the synthesizer to provide traceable frequency output.
Phase shows the current rate correction (in parts per billion: 1E-9) applied to
the synthesizer to provide traceable phase output.
Output MDEV Estimate uses the reference clock model being developed in
ITU-T SG13 to provide an operational estimate of the output performance of the
TimeProvider 500 in terms of peak MDEV stability.
Residual Phase Error shows the current estimate of the residual phase error
in ns. This error compensation is reflected in the phase value.
Minimal RTD shows the minimal round-trip delay value. In steady state, this is
estimated over the cluster window time of nominally 1 minute.
Temperature Avg shows the average temperature over five minutes.
Temperature Min shows the minimum temperature over five minutes.
Temperature Max shows the maximum temperature over five minutes.
Temperature 5min standard deviation of five-minute average temperature
data.
Temperature 60min standard deviation of 60-minute average temperature
data.
Flow Direction shows two separate columns for flow direction; (GM to client)
and (client to GM). Identifies whether the values shown are for the flow direction
from the grandmaster to the client or from the client to the grandmaster.
GM1 shows the number of sync packets being received from the Grandmaster
GM1 in the first column and the number of delay response packets being
received from the GrandMaster GM1 in the second column. Since the default
packet rate setting for the TimeProvider 500 is 64 Sync Packets/second, the
grandmaster flow is good in Figure 3-6.
GM2 shows the number of sync packets being received from the grandmaster
GM2 in the first column and the number of delay response packets being
received from the GrandMaster GM2 in the second column. The values for GM2
are 0, as expected, since GM1 is being used for the PTP flow. See Figure 3-6.
Weight indicates the percentage contribution of the forward flow sync packets
being used to drive the TimeProvider 500 outputs. The remaining percentage is
being taken from reverse flow (Delay_resp packets).
Transient Free values are rolling 15 minute (900 s) and 1 hour (3600 s)
metrics. Transients include loss of sync flow, phase steps, and pops against both
dynamic and static thresholds. If a given second includes a transient, it is not
considered transient free. Generally, if 80% or more of the indicated times (900
or 3600 seconds) are transient free, transient packet behavior should not be
causing output performance issues.
Percentile Clustering indicates the percentage of sync packets that meet all
clustering criteria and are therefore included in extracting the clock offset
estimates.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 65
Chapter 3 Operations
Flow State
Operational Min TDEV an operational stability estimate using the minimum
TDEV metric defined in G.8261. Smaller values correlate to better output
performance.
Operational MAFE an operational stability estimate proposed to the ITU-T.
MAFE (Maximum Average Frequency Error) estimates the maximum frequency
error of a packet clock based on a clustering and averaging window. The
clustering window is 1 minute and the averaging window is 15 minutes.
Min Cluster Width the current operational minimum cluster width used in the
forward clock estimate.
Mode Width the current estimate of the main mode of the forward packet delay
variation. The mode width is used in both weighting and compensation. Mode
width is a good indicator of loading.
Flow State displays the flow state of the GrandMaster clocks (GM1/GM2)
Clock id displays the Clock ID of the grandmaster(s) that has flow with the
TimeProvider 500.
Output TDEV Estimate uses the reference clock model being developed in
ITU-T SG13 to provide an operational estimate of the output performance of the
TimeProvider 500 in terms of peak TDEV stability.
Flow State
If there is an established flow, the clock ID of that master clock is shown (it can be
directly recovered from any PTP packet sent by that master). In the example shown,
there is no GM2 flow, so its clock ID is zeroed. Table 3-1 and Figure 3-7 shows the
possible values for the flow state. In the previous example, GM2 remains in the
initializing state because there is no actual grandmaster clock at its assigned
address.
Table 3-1. Possible Flow State
Flow State Description
Initializing Communication with grandmaster clock is being established.
Waiting for GM to
respond to signaling
TimeProvider 500 is waiting for a lease request response from the
grandmaster clock.
Checking Announce
messages
TimeProvider 500 is waiting for an Announce message to be qualified.
Checking for SYNC
messages
TimeProvider 500 is waiting on SYNC messages per the flow request
agreement.
Checking for Delay
messages
TimeProvider 500 is waiting on Delay messages per the flow request
agreement.
66 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Flow State
Figure 3-7. Possible State Flow
Normal The 1588 packet flow with the grandmaster clock is as expected.
Suspended The user has disabled 1588 packet flow.
Table 3-1. Possible Flow State (Continued)
Flow State Description
Power Up
Suspend
Customer Disabled
Normal
Initializing
Check SYNC
Message
Check Announce
Message
Wait for
GrandMaster to Respond
to Signaling
Check Delay
Message
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 67
Chapter 3 Operations
Frequency Locked Loop
Frequency Locked Loop
The TimeProvider 500 drives a state sequence that allows the operational status of
the Frequency Locked Loop (FLL) to be observed. These can be viewed via the
show status CLI command query. Table 3-2 lists the FLL states, transition
conditions, and SYNC LED impact. The possible sequential flow of frequency
locked-loop states is shown in Figure 3-8.
Table 3-2. Frequency Locked-Loop State
TimeProvider
500 State
Current FLL
State
Typical
Duration
SYNC LED Comment
FREERUN Warm-up ~2-3 minutes OFF initially and
then may blink.
Amber if flow is
established during
warm-up.
Unit is getting ready
for operation.
No SYNC
Flow
None OFF and may
blink Amber prior
to exit state.
No Sync packets
have been received
from master. Will
remain in this state if
there is no flow from
master clock.
Acquiring ~20 minutes Blinking Green TimeProvider 500 is
receiving sync
packets from
grandmaster and
performing coarse
frequency
adjustment.
NORMAL Fast FLL ~90 minutes Blinking Green Performance margins
are being improved,
but steady-state not
yet attained.
Normal FLL Continual Green Performance margins
are stable
Bridging 420 seconds, but
depends on
bridge-time
setting.
Green Abnormality such as
significant load
change or loss of
sync flow has been
observed.
HOLDOVER Holdover Varies depending
on how long it
takes to correct
the reason for
holdover.
Red TimeProvider 500 is
no longer using sync
flow from
grandmaster to
control the outputs.
68 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Alarms & Events
Figure 3-8. Possible Frequency Locked-Loop State Transitions
Alarms & Events
Each detected condition can have one of four severity levels: EVENT, MINOR,
MAJOR, CRITICAL. Each condition has a default severity as shown in Table 5-3.
The CLI provides several types of configurable options for each condition. See the
Set Alarm Commands, on page 98. The basic capabilities are:
Change the severity level of the condition.
Disable or enable any reporting of the condition.
Define an amount of time after detection of the condition before it will actually be
reported.
Warmup
No Sync Flow
Freerun
Acquiring
Normal FLL
Normal
Holdover
Bridging
Holdover
Fast FLL
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 69
Chapter 3 Operations
Alarms & Events
show alarm-config queries the above settings for all of the conditions. See the
CLI command, show alarm-config, on page 111 for more information. These
conditions become manifest in the TimeProvider 500 in three areas:
1. An event log provides history of entry into and exit from any condition that has
not been configured as disabled. Each entry in the log is timestamped. See show
log, on page 117 for more information.
2. The show alarm query provides a listing of all conditions that are currently
present, excluding those that have either been disabled (by user) or set to
severity level = EVENT.
3. The ALARM LED indicates the highest severity level of all conditions that are
currently present. As with show alarm, the ALARM LED will not respond to
conditions that have been disabled (by user). Table 3-3 shows the relationship
between highest active severity level and ALARM LED indication.
When an alarm clears, the alarm condition is no longer present and the following
occurs:
An entry is placed into the alarm log showing that the alarm condition has
cleared.
If the alarm information is included in the show alarm response, it will be removed
from that response.
The Alarm LED logic executes and may drive a change in the Alarm LED
indication.
For more information, refer to Alarm System Messages, on page 126 for alarm
message details.
Table 3-3. Alarm Levels
Highest Severity of Active Alarms Alarm LED Status
Event OFF
Minor Amber
Major Red
Critical Red
70 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Date & Time
Date & Time
Use the set time command to set the time and date. The time and date is used for
log entries and some responses.
There is no real-time clock in the TimeProvider 500, so if the TimeProvider 500 is
power-cycled, the time line is adjusted. The following rules apply and are intended
to keep the time line in the logs from having negative time jumps:
When the TimeProvider 500 powers up, the latest entry in the event and
configuration logs are checked for date and time. The latest entry is the last one
written into the respective log.
The date and time of the latest entries are compared to see which one contains
the most recent time and date. The most recent (date and time-wise) one
becomes the starting point for internal date and time. In other words, while the
unit is powered, the time line proceeds from that reference.
As entries that will be logged occur, the entries reflects the current time and date
(based on reference described in prior bullet). These entries become candidates
for the latest entry discovery on the next power-up.
When set clock time is used, the date and time are immediately updated. Since
this places an entry in the logs, this provides a new timeline basis for the next
power-up.
When PTP flow has been locked, the clock is automatically set.
TimeProvider 500 Logs
The TimeProvider 500 provides two types of non-volatile logs: Event and
Configuration.
Event Log
The event log provides timestamped entries whenever any of the conditions
associated with the events identified in Table 3-3 are set or cleared. Additionally,
other significant actions also generate log entries, such as power-on, resetting of
time (see set clock command), clearing of the log, and changes of FLL state. The
log can be viewed using show log event.
Configuration Log
The configuration log provides timestamped entries whenever a user setting is
changed, thus providing a history of configuration actions. Additionally, other
significant actions also generate log entries, such as session logon and logout,
power-on, clearing of the log, and resetting of time. The configuration log can be
viewed using show log configuration.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 71
Chapter 3 Operations
User Sessions
Both logs are cleared with clear log.
User Sessions
TimeProvider 500 user sessions can occur in two ways:
1. Locally with a serial connection
2. Remotely with a Telnet connection.
Either way, a userID and password is required. All TimeProvider 500 sessions are
enabled with the same userID and password. There can be up to three
simultaneous Telnet sessions. Remote sessions time out after 10 minutes with no
entry. A serial session times out after 60 minutes with no entry.
Logon UserID
The factory default userID is admin and can be changed with the set user
command. See set user, on page 96 for more information.
Password
The factory default password is symmadmin** and can be changed with the set
user command. See set user, on page 96 for more information.
To avoid a possible service call to gain access to the TimeProvider 500,
Symmetricom recommends that you record any changes made to the password and
store it in a secure location.
Firmware Upgrade
The TimeProvider 500 firmware can be remotely upgraded via FTP. See upgrade,
on page 83 for details. Two firmware images are maintained in flash memory to
provide a backup in the event of file corruption. These images can be viewed using
the CLI command, show image. For more information, see the CLI command, show
image, on page 116.
The TimeProvider 500 continues normal operation during the upgrade process.
After upgrading the firmware, to make the newly downloaded firmware active, reset
the TimeProvider 500 using the reboot system CLI command. During reboot, the
TimeProvider 500 signal outputs are lost. Since configuration is retained during a
reboot, the outputs are the same signal types as prior to the reboot once they come
back on. Determination of when the outputs will re-activate can be controlled via the
set output freerun command.
72 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
Firmware Upgrade
To upgrade firmware, following these steps:
1. Log on to the TimeProvider 500. See Logon to TimeProvider 500.
2. Configure the if0 interface per your network configuration. See Configuration
Setup, on page 38, and PTP Management, on page 54 for more information.
3. At the TP-500> prompt, type show inventory.
The show inventory command shows the version of software that is currently
running. The following example shows that the TimeProvider 500 is running
firmware version 2.0.3.
TP-500> show inventory
Product Number : 090-03863-02
Firmware Version : 2.0.3
Product Version :
Serial Number : r45091
User description : doug;lab
4. At the TP-500> prompt, type upgrade. Make sure you have the full file path, FTP
server IP address, server name, and password before you begin.
Example:
TP-500> upgrade /tp500/maincode.bin ftp:192.168.5.56 tp5000
Password: *******
Response:
Opening FTP session
220 Welcome to Build Machine FTP service.
331 Please specify the password.
230 Login successful.
200 Switching to Binary mode.
227 Entering Passive Mode (192,168,5,56,225,121)
150 Opening BINARY mode data connection for
/tp500/maincode.bin (710742 bytes).
226 File send OK.
file size: 710742 bytes
checksum: FD75EF92
revision string: 2.0.0
magic number: ABCD1234
erase sector: 120000
erase sector: 130000
erase sector: 140000
erase sector: 150000
erase sector: 160000
erase sector: 170000
erase sector: 180000
erase sector: 190000
erase sector: 1a0000
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 73
Chapter 3 Operations
Firmware Upgrade
erase sector: 1b0000
erase sector: 1c0000
erase sector: 1d0000
erase sector: 1e0000
erase sector: 1f0000
erase sector: 300000
erase sector: 310000
erase sector: 320000
erase sector: 330000
erase sector: 340000
erase sector: 350000
erase sector: 360000
erase sector: 370000
erase sector: 380000
erase sector: 390000
erase sector: 3a0000
erase sector: 3b0000
erase sector: 3c0000
erase sector: 3d0000
erase sector: 3e0000
erase sector: 3f0000
erased bank: 1
Finished downloading
221 Goodbye.
TP-500>
5. At the TP-500> prompt, type reboot system.
Example:
TP-500> reboot system
Response:
Rebooting system
Bootcode version 1.1.0
Loading Maincode image: 1
-------------------- PTP client --------------------
TP-500 06:27:41 08/09/2009 (221)
Login:
6. Log on to TimeProvider 500 after rebooting the system. See Logon to
TimeProvider 500.
7. At the TP-500> prompt, type show image.
The previous version of TimeProvider 500 firmware will be on image 0 and the
upgraded firmware version is on image 1.
74 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
GM2 GrandMaster
Example:
TP-500> show image
Response:
Image 0
rev: [1.0.27]
size: [702563 bytes]
checksum: [0xFD821E3B]
seq: [7]
Image is [Good]
Image 1
rev: [2.0.0]
size: [710742 bytes]
checksum: [0xFD75EF92]
seq: [8]
Image is [Good]
8. At the TP-500> prompt, type show inventory.
Example:
TP-500> show inventory
Response:
Product Number : 090-03863-02
Firmware Version : 2.0.0
Product Version :
Serial Number : r45091
User description : doug;lab
The latest firmware version upgraded displays.
GM2 GrandMaster
TimeProvider 500 supports a capability to select from one of two master clocks. Use
of this feature is easily enabled by providing target addresses for two master clocks.
See set ptp mgmt, on page 108 and set ptp address, on page 106. When both are
configured to non-zero IP addresses, the TimeProvider 500 will attempt to establish
PTP flow with both. If a flow problem persists, or no flow can be established at with
one of the candidate masters, then the other one is used as long as it has
acceptable PTP flow. Along with such obvious reasons for selecting one of the
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 75
Chapter 3 Operations
GM2 GrandMaster
master clocks, a rule-hierarchy is defined in IEEE-1588 which uses Announce
messages received from both candidate masters and compares information to
determine which of the two clocks is preferred. Details of the comparison algorithm
are beyond the scope of this document, but can be seen in Figure 27 of IEEE Std
1588-2008.
The show status query shows which of the candidate masters (if any) is currently
being used as the synchronization reference. See Details for Show Status Function,
on page 63.
76 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 3 Operations
GM2 GrandMaster
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 77
Chapter 4 CLI Commands
Overview
Chapter 4 CLI Commands
The Command Line Interface (CLI) is used to display information or configure and
manage the TimeProvider 500 from either a terminal connected to the EIA-232
serial port or the Ethernet port.
In This Chapter
Overview
TimeProvider 500 CLI Command Set
Set Commands
Set Alarm Commands
Set Output Commands
Set PTP Commands
Show Commands
Overview
This section describes the CLI command conventions, CLI command keyboard
usage and command-line format. Figure 4-1 shows the general structure of the CLI
commands.
78 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Overview
Figure 4-1. TimeProvider 500 CLI Command Set
TimeProvider 500 CLI Command Conventions
The following are conventions used for the TimeProvider 500 CLI command set.
[ ] Brackets provide information about the allowed range. The first value is the
minimum, and the last value is the maximum.
{ } Braces signify more than one parameter data option.
| Vertical bars separate options.
Italics indicates variable data.
All commands are completed by pressing the Enter key.
() Parentheses are used for any uppercase strings.
clear help logout ping reboot set show upgrade
alarm
alarm-config
announce
auto-neg
bridge-time
clock
correction
eia-232
firewall
interface-config
interface-status
inventory
image
led
log
output
ptp
status
status-list
temperature
tod
TimeProvider 500 CLI Command Set
alarm-config delay
alarm-config level
alarm-config proxy
alarm-config state
auto-neg
bridge-time
clock time
clock timescale
clock timezone
configuration
eia-232
firewall
interface
interface attachments
ip
ip-mode
set ipdv interval
set ipdv pacing
set ipdv reset
set ipdv threshold
set output pps-mode
output
output freerun
output hdb3
output holdover
output pps-offset
output pps-width
ptp addr-mode
ptp address
ptp domain
ptp dscp
ptp mgmt
ptp state
set ptp transport
ptp unicast announce-int
ptp unicast lease-int
ptp unicast sync-int
tod
tod format
tod timescale
udesc
user
vlan-config
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 79
Chapter 4 CLI Commands
Overview
CLI Command Keyboard Usage
The interface has built-in features for navigating within the CLI command
hierarchy and are as follows:
Press the Tab key or type help at the prompt for a list of the available top-level
commands. See help, on page 81 for more information.
Press the Tab key at any time while typing a command. TimeProvider 500 will
respond with the completion of the keyword or available completion choices
based on the letters you type.
If typing of a keyword is partially complete, the completion will display if it
is unique, otherwise, completion choices will be available.
If the keyword is complete after pressing the Tab key, the choices for the
next syntax element will display.
For example, typing s at the prompt displays:
TP-500> s
Then pressing the Tab key displays:
set - Changes settings
show - Displays settings
Continuing with the example, typing se and then pressing the Tab key, displays set
because it is the only possible command. Next, typing o and then pressing the Tab
key, displays set output as the only possible command completion. When typing s
and then pressing the TAB key, set output displays. Pressing the TAB key again
shows the outputs available (OUT1 | OUT2 | OUT3 | OUT4). Typing OUT3 and then
pressing the TAB key results in the signaltype options for OUT3 as shown in the
following:
clk_2048 - Enables 2.048 MHz
e1_ais - Enables E1 with AIS
e1_cas - Enables E1 CAS without CRC4
e1_cas4 - Enables E1 CAS with CRC4
e1_ccs - Enables E1 CCS without CRC4
e1_ccs4 - Enables E1 CCS with CRC4
disable - Disables output
t1_sf - Enables T1 with SF
t1_esf - Enables T1 with ESF
clk_1544 - Enables T1 1.544 MHz
t1_iso_pulse - Enables T1 with isolated pulse
Note: It may appear necessary to press Tab twice. The reason for this
is there is a space between keywords or that TimeProvider 500 has
not completed processing one of the keywords before processing the
next keyword.
80 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Overview
Previously typed commands can be recalled by using the UP ARROW key. You
can recall up to five previously typed commands. Continually pressing the UP
ARROW key will cycle you through the five previously typed commands. After
pressing the UP ARROW key five times, you will go back to the last command
you previously typed. Use the DOWN ARROW key to cycle the five prior typed
commands in the opposite direction.
You can use BACKSPACE to correct keystroke errors, or to reuse parts of a
previously typed command. When using BACKSPACE, the removed characters
will still appear on the screen, but they have been removed to the position shown
by the cursor. When you start typing, the removed characters are overwritten.
Command Line Format
The command line format is as follows:
[Verb] Command [Parameter] [Data] EOL
Example:
set output freerun squelch
set = Verb
output = Command
freerun = Parameter
squelch = Data
Command line format description:
Verb the type of action to be taken with the command.
Parameter command input that defines the particular command element to be
shown or modified.
Data The data input for the parameter, if any.
EOL this parser responds to any input line terminator. Possible terminators are
CR, LF, or CRLF. When the parser receives any of these terminators, the input is
terminated, and the command line entry is processed. Pressing the Enter key also
produces EOL.
Note: Both the TAB key and ? have the same function. Both
can be used at any time while typing a command (including at
the prompt) to provide continuation options.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 81
Chapter 4 CLI Commands
TimeProvider 500 CLI Command Set
TimeProvider 500 CLI Command Set
This section provides details for each of the TimeProvider 500 commands which
includes a description of the commands function, details of associated ranges when
applicable, the commands default settings, and both an example of using the
command and an example of the response you will receive from TimeProvider 500.
clear log
This command clears the contents of event and configuration logs. An entry
showing the time that the log was cleared will display at the start of the log.
Syntax:
clear log
Example:
TP-500> clear log
Response:
All logs have been cleared
Example:
TP-500> show log event
Response:
Event Log
Current time is: 23:12:02 11/12/2009 (TAI)
Log 000: 23:11:59 11/12/2009: Logs cleared
help
This command provides a list of first-level CLI commands.
Syntax:
help
Response: You will see the following:
clear - Clears log
Note: Commands that are new or updated for TimeProvider 500 2.0
are notated in the description of the command. If a notation is NOT
included in the description of the command, the command has not
changed since TimeProvider 500 1.0. See Table C-13 for more CLI
command differences for version 2.0.
82 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
TimeProvider 500 CLI Command Set
help - Print this list
logout - Logs off of telnet session
ping - Sends ping to IP address
reboot - Reboots client
set - Changes settings
show - Displays settings
upgrade - Downloads new firmware into memory logout
logout
This command terminates a users session. The logout command is used to
terminate a serial connection session or a remote session via telnet.
Example 1:
Logout from a serial connection example. The user is prompted to login.
TP-500> logout
Logging out
TP-500 23:13:10 11/12/2009 (316)
Login:
Example 2:
A logout from a telnet session.
TP-500> logout
Logging out
Goodbye
Connection to host lost.
ping
This command is updated from version 1.0.
This command pings (ICMP echo request) a connection interface device [ if0, if1,
if2, if3, if4] using the interfaces IP address.
Syntax:
ping [if0|if1|if2|if3|if4]<ip address>
Range:
ip address = x.x.x.x
Range for all settings = [0, 1, , 255]
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 83
Chapter 4 CLI Commands
TimeProvider 500 CLI Command Set
Example: Checks to see if the device at 192.168.1.9 is accessible. In this example,
the device is a TimeProvider 5000 IEEE 1588 grandmaster clock.
When the device is accessible:
TP-500> ping if0 192.168.1.9
Pinging 192.168.1.9 [192.168.1.9]:
Reply from 192.168.1.9: time=0ms
Reply from 192.168.1.9: time=0ms
Reply from 192.168.1.9: time=0ms
Reply from 192.168.1.9: time=0ms
When the device is not accessible:
ping 192.168.1.9
Pinging 192.168.1.9 [192.168.1.9]:
Request timed out
reboot system
This command performs a soft reboot (restart) of TimeProvider 500.
Syntax:
reboot system
Example:
TP-500> reboot system
Response:
Rebooting system
Bootcode version 1.1.1
Loading Maincode image: 0
-------------------- PTP client --------------------
TP-500 23:14:13 11/12/2009 (316)
upgrade
This command is used to upgrade the TimeProvider 500 firmware. The file for the
TimeProvider 500 firmware upgrade is accessed through an FTP server. For this
command, upgrade is the complete path and includes the file name; FTP is the IP
address of the FTP site; and user_name is the login name of the for the FTP server.
Syntax:
Note: Domain Name Service (DNS) is not supported.
84 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
upgrade full file path FTP:<address> FTP login name <enter>
Password: pwd
Range:
<full file path>:
The full-path name to the file being downloaded from the FTP server.
<FTP:<addresss>:
The IP address of the FTP server.
<FTP login name>:
The login user name for the FTP server.
Password:
The login password for the FTP server
<enter>:
Example: The TimeProvider 500 firmware upgrade file name is Maincode.bin and
is located at the FTP server at IP 192.168.2.3. The login user name for the FTP
server is anonymous and there is no password. Press Enter instead of entering a
password. For this example, to upgrade firmware, perform the following steps:
1. Type upgrade /Maincode.bin FTP:192.168.2.3 anonymous, and then press
Enter.
2. At the password prompt, leave blank and press Enter.
Response:
A response is generated from TimeProvider 500 and after a successful upgrade, the
message ends with Transfer complete.
Set Commands
The set commands enable you to change settings or values such as configuring a
master clocks IP address, creating a user name and password for a logon, or
specifying output behaviors for TimeProvider 500.
Note: TimeProvider 500 provides the password prompt after you type
the full file path, FTP IP address, and the login user name for the FTP,
and then press Enter.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 85
Chapter 4 CLI Commands
Set Commands
set auto-neg
This command sets whether or not the TimeProvider 500 will auto-negotiate
connection speed with a device directly connected to its physical Ethernet network
port (RJ45). The available connection speed is always 100Base-T, electrical, and
when the TimeProvider 500 is set to enable, the TimeProvider 500 displays the
available connection speed. The disable setting is used when a network does not
want to use the Ethernet auto-negotiation process.
Syntax:
set auto-neg { enable | disable }
Default:
Auto-neg = enable
Example:
set auto-neg disable
Response:
Auto-negotiation disabled
set bridge-time
This command sets the amount of time (in seconds) that the TimeProvider 500
remains in bridge mode.
Syntax:
set bridge-time time_val
Range:
Time_val = [ 120, 121, , 86400]
Default:
Time_val = 420 seconds
Example:
Sets the bridging time to 300 seconds.
set bridge-time 300
Response:
Bridging time set to 300
86 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
set clock time
This command sets the date and time for use in logging and alarm reporting. The
time and date results may be overwritten if a qualified master clock is providing
time.
Syntax:
set clock time HH:MM:SS date MM/DD/YYYY
Range:
HH = [00, 01, , 23] = hour
MM = [00, 01, , 59] = minutes
SS = [00, 01, , 59] = seconds
MM = [01, 02, , 12] = month
DD = [01, 02, , 31] = day
YYYY = [2008, , 2089] = year
Leading zeros are never required
Default: 00:00:00 01/01/1970
Example:
set clock time 09:30:00 date 09/17/2008
Response:
Time is: 09:30:00 09/17/2008
set clock timescale
This command in new for version 2.0.
Note: The set configuration command does not alter the
time and date.
Note: The time and date is not updated while TimeProvider 500
is powered-down. Also, the date and time values are not stored
in non-volatile memory and will not be recovered on
power-cycle. For more information, see Date & Time, on page
70.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 87
Chapter 4 CLI Commands
Set Commands
This command enables the user to select either UTC or local time settings for CLI
commands that show the current time such as the show status or show status-list
commands.
Syntax:
TP-500> set clock timescale[local | tai | utc]
Range:
local - Timescale set to local
tai - Timescale set to TAI
utc - Timescale set to UTC
Default:
set clock timescale = utc
Example:
set clock timescale utc
Response:
Timescale changed to UTC
set clock timezone
This command in new for version 2.0.
This command enables the user to set the timezone offset in hours and minutes for
reporting of time in logs and CLI command that show the current time such as the
show status or show status-list commands.
Syntax:
TP-500> set clock timezone
<timeofset +/-HH:MM>
Example:
set clock timezone -01:00
Response:
Setting timezone offset to: +01:00
Note: Setting the timescale does not affect timestamping in logs. The
timestamping in logs always uses UTC.
88 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
set configuration
This command resets user-defined settings to known values with a single
command. The factory configuration will change all settings. The default
configuration is a subset of the factory configuration and will not change
communication-related settings such as TimeProvider 500s IP address. The default
configuration is less extensive and potentially more useful in some situations. See
Table 6-13 for more information.
Syntax:
set configuration { default | factory }]
Default:
TimeProvider 500 ships with its configuration set to factory.
Example:
Sets TimeProvider 500s configuration to the factory settings.
set configuration factory
Response:
Setting configuration to factory
set eia-232 baud
This command is updated from version 1.0 to support changing baud rate.
This command sets the baud rate on the RS232 MGMT connector.
Syntax:
set eia-232 baud { 4800 | 9600 | 19200 | 38400 | 57600 }
Default:
Baud = 57600
set firewall
This command creates a firewall to block remote use of the selected capability.
Syntax:
set firewall { telnet | icmp } { allow | block }
Default:
Note: The set configuration factory command will reset this
setting. The set configuration default command will not
change the current setting.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 89
Chapter 4 CLI Commands
Set Commands
telnet = allow
icmp = allow
Example:
Blocks remote use of Telnet.
set firewall telnet block
Response:
telnet blocked
set interface
This command is new for version 2.0 to support interface connections.
This command enables or disables an interface connection. See Interface
Connections, on page 55 for more information.
Syntax:
set interface [if0|if1|if2|if3|if4] enable | disable
Default:
if0 = enabled
if1 = disabled
if2 = disabled
if3 = disabled
if4 = disabled
Example:
set interface if1 enable
Response:
Interface 1 enabled
set interface attachments
This command is new for version 2.0 to support interface connections. In version
1.0 there was only a single interface connection.
This command controls which interface connection the selected external
capability should use. The external capacities are:
GM1 = GrandMaster 1
GM2 = GrandMaster 2
90 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
NODE-MGR = A PTP node-manager
Syntax:
Set interface attachments {GM1 | GM2 | NODE-MGR } { if0 | if1
| if2 | if3 | if4 }
Default:
For all interfaces attachments: default = if0
Example:
TP-500> set interface attachments
The TimeProvider 500 response is asking which PTP management device is being
configured.
gm1 - Attaches interface to GM1
gm2 - Attaches interface to GM2
node-mgr - Attaches interface to node manager
The TimeProvider 500 response is requesting which interface is being used for the
selected PTP attachment.
TP-500> set interface attachments node-mgr
if0 - Attaches NODE-MGR to interface 0
if1 - Attaches NODE-MGR to interface 1
if2 - Attaches NODE-MGR to interface 2
if3 - Attaches NODE-MGR to interface 3
if4 - Attaches NODE-MGR to interface 4
TP-500> set interface attachments node-mgr if3
Response:
NODE-MGR attached to interface 3
Note: Telnet sessions do not need to be attached to an interface.
Note: The PTP flow should be disabled prior to changing attachments
with the set ptp addr-mode disable command.
Note: If you need to change the VLAN ID or priority, it is
recommended that the VLAN parameter(s) be changed with the set
vlan-config command rather than changing the attachment.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 91
Chapter 4 CLI Commands
Set Commands
set ip
This command is updated from version 1.0 to support connection interfaces.
For more information about connection interfaces, see Interface Connections, on
page 55. The set ip command sets the IP address, gateway, and network mask for
the TimeProvider 500 interface connection. Once an IP address is changed, the
settings take effect immediately. You can only set an interface connection when the
interface is enabled. See set interface, on page 89.
Syntax:
set ip [if0|if1|if2|if3|if4] <ip address> netmask <netmask> gateway
<gateway>
Range:
Range for all settings = [0, 1, , 255]
Default: set configuration factory configures the TimeProvider 500 to the
following settings:
for individual interface connections:
if0 address = 192.168.1.9
if1 address = 10.1.1.1
if2 address = 10.1.2.1
if3 address = 10.1.3.1
if4 address = 10.1.4.1
for all interface connections [ if0 | if1 | if2 | if3 | if4 ]:
Netmask = 255.255.255.0
Gateway = 0.0.0.0
Example:
Sets the IP address to; 192.168.2.52; netmask 255.255.255.0 gateway;
192.168.2.1.
set ip if1 192.168.2.52 netmask 255.255.255.0 gateway 192.168.2.1
Response:
Note: Attempting to set an existing connection interface IP
address to any of the other four interface connections will
cause the command to fail. All interfaces should be configured for
separate subnets.
92 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
IP if1 192.168.2.52, netmask: 255.255.255.0, gateway: 192.168.2.1
set ipdv interval
This command in new for version 2.0.
This command configures the observation period over which all IPDV
measurements are taken. IPDV settings and results can be shown with the show
status-list command.
Syntax:
Set ipdv interval interval_value
Range:
1 to 255 minutes
Example:
Set the interval to 15 minutes.
Set ipdv interval 15
Response:
IPDV interval set to 15 minutes
set ipdv pacing
This command in new for version 2.0.
This command configures the observation pacing factor for the forward and reverse
IPDV inter-packet jitter measurement. The pacing factor identifies how often to
select a data point for the jitter analysis. For example, if pacing value is 128, every
128th sample will be used for jitter assessment (in either flow direction). IPDV
settings and results can be shown with the show status-list command.
Syntax:
Set ipdv pacing samples
Range:
1, 2, 4, 8, , 256, 512 samples
Example:
Note: set configuration factory configures the TimeProvider
500 to the default settings. set configuration default does
not alter the current IP address, gateway, and netmask settings.
When the IP address is changed, the settings take immediate effect.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 93
Chapter 4 CLI Commands
Set Commands
Set the pacing to 2 samples.
Set ipdv interval 2
Response:
IPDV pacing set to 2
set ipdv reset
This command in new for version 2.0.
This command resets and restarts all IPDV measurements.
Syntax:
Set ipdv reset
Example:
Restart the IPDV data.
Set ipdv reset
Response:
Reset IPDV data
set ipdv threshold
This command in new for version 2.0.
This command sets the threshold level to be used for IPDV percent below threshold
results. The same threshold is used for the forward and reverse results. IPDV
settings and results can be shown with the show status-list command.
Syntax:
Set ipdv threshold threshold_value
Range:
0 to 1000000.000 usec, except that 0 is not allowed
Example:
Set the threshold to 50 seconds.
Set ipdv threshold 50
Response:
IPDV threshold set to 50.000 usecs
94 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
set ip-mode
This command has changed in version 2.0 to support DHCP.
This command configures the addressing mode for the available connection method
for TimeProvider 500. Setting the connection method to static will use the address
from the set ip command. Setting the connection method to dhcp enables the
connection method to obtain an address from a DHCP server.
Syntax:
set ip-mode [all|if0|if1|if2|if3|if4] [static|dhcp]
Default:
ip-mode [all|if0|if1|if2|if3|if4] = static
Example:
set ip-mode if2 dhcp
Response:
Interface 2 IP-mode set to dhcp
set tod
This command is new for version 2.0
This command controls whether or not TOD (Time of Day) output is generated on
the RS232 (serial) port. When set to enable, TOD is generated each second. TOD
format is controlled by the set tod format command. When enabled, TOD is
unconditionally generated.
Syntax:
Set tod { enable | disable }
Example:
set tod enable
Response:
TP-500> T104592808102009FF0000012D020086
T104592908102009FF0000012D020014
T104593008102009FF0000012D0200DF
T104593108102009FF0000012D02004D
T104593208102009FF0000012D0200E2
T104593308102009FF0000012D020070
T104593408102009FF0000012D0200A5
T104593508102009FF0000012D020037
T104593608102009FF0000012D020098
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 95
Chapter 4 CLI Commands
Set Commands
T104593708102009FF0000012D02000A
T104593808102009FF0000012D02002B
T104593908102009FF0000012D0200B9
T104594008102009FF0000012D0200B7
...
set tod format
This command is new for version 2.0
This command selects the format for TOD output. Only a single format can be active
at a time. There will be a pending leap second displayed in both UTC and TAI TOD
formats. The leap second will be applied to the UTC time but not the TAI time.
Syntax:
Set tod format { NMEA | T1 }
Example:
set tod format T1
Response:
TOD format changed to timecode 1
set tod timescale
This command is new for version 2.0
This command sets the timescale to be used in TOD output. This setting only affects
the timescale used for TOD messages and does not affect the timescale used in
logs or other time reporting, which is controlled via set clock timescale, on page 86.
The reason for supporting an independent timescale for TOD is that the device
receiving the TOD message might require a specific timescale.
Syntax:
Set tod timescale { local | tai | utc }
Example:
set tod timescale tai
Response:
TOD timescale changed to TAI
96 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Commands
set user
This command sets the user name and password for the TimeProvider 500 logon. In
response to the CLI command, set user, TimeProvider 500 will prompt for old
(current) password, new user name, and new password.
User Name Range:
user_name command requirements:
Must be between 420 characters in length.
The user_name is case-sensitive.
All characters must be alphanumeric (letters a through z and numbers 0 through
9).
Password Range:
Must be between 832 characters in length.
All characters must be printable ASCII (ASCII decimal values 33126), and a
comma, semicolon, and colon are never allowed.
2 characters must be non-alphabetic. For example, a number would qualify.
1 character must be non-alphanumeric (! would qualify)
Default User Name:
admin
Default Password:
symmadmin**
Example:
TP-500> set user
Enter old password: ************
Enter new user name: doug
Enter new password: ************
Verify new password: ************
Note: The default user_name and curr_pwd are the user name and
password shipped from the factory. Using the set configuration
command does not return the password to the factory default value.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 97
Chapter 4 CLI Commands
Set Commands
Response:
updated accepted
set udesc
This command is new for version 2.0
This command sets the user description field shown when using the show inventory
command. Recommended use is <user defined name of device>;<user defined
physical location>. The semicolon is defined as a field delimiter for text in
IEEE-1588. The user description string can be up to 64 characters with no spaces.
Use quotation marks at both ends of the string. For uppercase, use the right and left
parentheses. The following example shows when a user enters a user description in
uppercase letters.
Syntax:
TP-500> set udesc
Example:
TP-500> set udesc "(ABCDE)"
Response:
User data set to "ABCDE"
Using the show inventory command, the new user description settings are shown.
TP-500> show inventory
Product Number : 090-03863-02
Firmware Version : 2.0.0
Product Version :
Serial Number : r45091
User description : ABCDE
set vlan-config
This command is updated from version 1.0 to support connection interfaces.
Note: This command can be used to change the password, user
name or both. To change only the user name, the new password
entries must be the same as the old password. To change only the
password, the user name entry must be the same as the current user
name.
Symmetricom recommends that you record password changes to
avoid a possible service call to gain access to the TimeProvider 500.
98 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Alarm Commands
This command sets the VLAN parameters for interfaces 1 4. The following rules
apply to this command:
Syntax:
set vlan-config [if1|if2|if3|if4] vlan_id <vlan-id> priority
<vlan_priority>
Range:
vlan_id = [1, 2,3 , 4094]
vlan_priority = [0, 1, ,7]
Default:
if1: vlan_id = 2
if2: vlan_id = 3
if3: vlan_id = 4
if4: vlan_id = 5
vlan_priority = 0
Example:
Sets VLAN ID to 22 and priority to 6.
set vlan-config 22 priority 6
Response:
VLAN ID set to 22 and priority to 6
Set Alarm Commands
The set alarm command set allows you to enable or disable reporting of selected
alarms, configure the severity level of alarms, and the delay before an alarm is
reported. Alarm number mapping is shown in Table 5-3.
Note: The set configuration factory command will reset this
setting. The set configuration default command will not
change the current setting.
Note: These settings will only be used when the interface configured
for VLAN is enabled using the set interface command.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 99
Chapter 4 CLI Commands
Set Alarm Commands
Figure 4-2. Alarm Configuration Commands
set alarm-config delay
The number of alarms has increased from 14 to 19 in version 2.0.
This command allows the user to delay the reporting of selected alarms (in
seconds). The alarm_num option allows you to select an individual alarm.
Syntax:
set alarm-config delay { alarm alarm_num } duration delay_time
Example: Sets alarm number 5 delay time to 10 seconds
set alarm-config delay alarm 5 duration 10
Response:
Alarm 5 delay set to 10 seconds
set alarm-config level
The number of alarms has increased from 14 to 19 in version 2.0.
This command configures the severity level of the selected alarm. The alarm_num
option allows you to select an individual alarm. See show alarm, on page 111 for
more information. The selected severity may change the alarm LED indication (see
Alarm System Messages, on page 126 for details).
Syntax:
set alarm-config level { alarm alarm_num } { event | minor | major | critical }
Range: alarm_num = [0, 1, , N], N currently= 19
Default: See Alarm System Messages, on page 126 for default severities.
Example: Sets all alarms to minor severity.
set alarm-config level alarm 9 minor
alarm-config commands
alarm_num
level
alarm_num
enable disable
state
alarm_num
duration
<delay time>
delay
minor major critical event
alarm_num
enable disable
proxy
100 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Alarm Commands
Response:
Alarm level 9 set to minor
set alarm-config proxy
This is a new command for version 2.0. The number of alarms has increased from
14 to 19 in version 2.0.
This command enables or disables the capability for an alarm to generate an
autonomous message via PTP management (see PTP Management, on page 54)
when the alarm has alarm or event activity. The alarm_num option selects which
alarm will have the proxy option. This command enables a receiving device to act
on behalf of the TimeProvider 500. This would allow the receiving device to either
handle the alarm or forward it via an SNMP trap.
Syntax:
set alarm-config proxy { alarm alarm_num } { enable | disable }
Range: alarm_num = [0, 1, , N], N currently = 19
Default: See Alarm System Messages for default severities.
Example: Sets all alarms to minor severity.
set alarm-config proxy alarm 9 enable
Response:
Alarm 9 proxy is enabled
set alarm-config state
The number of alarms has increased from 14 to 19 in version 2.0.
This command enables or disables the reporting of selected alarms. alarm_num
allows you to apply settings to individual alarms.
Syntax:
set alarm-config state {alarm alarm_num} {enable | disable}
Range: alarm_num = [0, 1, , N], N currently = 19
Default: The default setting for all alarms is enable.
Example: Disables alarm number 3
set alarm-config state alarm 3 disable
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 101
Chapter 4 CLI Commands
Set Output Commands
Response:
Alarm 3 is disabled
Set Output Commands
The set output commands enable you to create settings and conditions for output
signal behavior of the TimeProvider 500.
Figure 4-3. Set Output Commands
set output freerun
This command sets the specific output behavior of TimeProvider 500 when it is in
freerun mode. The following parameters are used when specifying output behavior:
onusing this setting will use the set output signaltype when TimeProvider
500 is in freerun mode. See Table 3-2.
aisusing this setting will cause the appropriate Alarm Indication Signal (AIS) to
be generated when in freerun mode. If set output signaltype is set to
disable, no AIS output will be generated.
squelchusing this setting causes the outputs to be turned off when in freerun
mode regardless of the set output signaltype settings.
Syntax:
set output freerun { ais | on | squelch }
Default:
Note: To see changes made, use the CLI command, show
alarm-config. See show alarm-config, on page 111.
set output commands
ais on squelch
holdover freerun
ais on squelch
hbd3
enable disable
clk_2048
e1_ais
e1_cas
e1_cas4
e1_ccs
e1_ccs4
disable
t1_sf
t1_esf
clk_1544
t1_iso_pulse
out3 out4 out1 out2
pps-offset pps-width pps-mode
standard coupled 1pps
clk_2048
e1_ais
e1_cas
e1_cas4
e1_ccs
e1_ccs4
disable
t1_sf
t1_esf
clk_1544
t1_iso_pulse
102 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Output Commands
freerun = on
Example:
Assures disabled output while in freerun mode.
set output freerun squelch
Response:
Output will be squelch in freerun state.
set output hdb3
This command sets whether or not High-Density Bipolar 3 (HDB3) encoding will be
used for framed E1 outputs.
Syntax:
set output hdb3 { enable | disable }
Default:
hdb3 = enable
Example:
Turns off HDB3 encoding.
set output hdb3 disable
Response:
HDB3 set to disable
set output holdover
This command sets specific output behavior when TimeProvider 500 is in holdover
mode. The following parameters are used when specifying output behavior:
onthis command enables the set output signaltype when TimeProvider
500 is in holdover mode.
aisthis command enables the appropriate AIS to be generated when in
holdover mode. If set output signaltype is set to disable, no AIS output will
be generated.
squelchthis command enables the outputs to be turned off when in holdover
mode regardless of the set output signaltype settings.
Syntax:
set output holdover { ais | on | squelch }
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 103
Chapter 4 CLI Commands
Set Output Commands
Example:
Turns off the outputs while in holdover mode.
set output holdover squelch
Response:
Output will be squelch in holdover state
set output out1, out2, out3 & out4
This command sets the type of output generated by the TimeProvider 500. There
are four output ports. The TimeProvider 500 output ports are the two BNC
connections and the two RJ48C connections. See 1PPS/E1/T1 Output Connectors,
on page 27 and Configure Frequency Outputs, on page 47 for more information on
these outputs and the coupling between them.
Syntax:
set output { out1 | out2 | out3 | out4 <signaltype>
Where:
out1 = { 1pps | clk_1544 | clk_2048 | e1_ais |e1_cas |
e1_cas4 | e1_ccs | e1_ccs4 | disable | t1_sf | t1_esf |
t1_iso_pulse }
out2 = { 1pps | clk_1544 | clk_2048 | e1_ais |e1_cas |
e1_cas4 | e1_ccs | e1_ccs4 | disable | t1_sf | t1_esf |
t1_iso_pulse }
out3 = { clk_1544 | clk_2048 | e1_ais |e1_cas | e1_cas4 |
e1_ccs | e1_ccs4 | disable | t1_sf | t1_esf | t1_iso_pulse }
out4 = { clk_1544 | clk_2048 | e1_ais |e1_cas | e1_cas4 |
e1_ccs | e1_ccs4 | disable | t1_sf | t1_esf | t1_iso_pulse }
Default:
out1 = clk_2048
out2 = 1pps
out3 = clk_2048
out4 = clk_2048
Example:
Sets the output to produce a T1 isolated pulse pattern.
set output out3 t1_iso_pulse
Response:
104 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set Output Commands
Setting Output 3 to T1 isolated pulse
set output pps-mode
This is a new command for 2.0.
There are two settings for 1PPS output.
Standard Mode: Standard mode allows the 1PPS and frequency outputs (10
MHz, E1, T1) to both be optimized. Standard mode allows the 1PPS to be
adjusted without affecting the frequency outputs.
Coupled Mode: In coupled mode, the 1PPS is adjusted by adjusting the system
clock frequency to slew the phase. This frequency adjustment also affects the
frequency outputs. At power-up and extraordinary conditions, the phase may still
be adjusted independently of the frequency outputs.
Syntax:
set output pps-mode {standard | coupled }
Default:
standard
Example:
set output pps-mode standard
Response:
Setting PPS mode to standard
set output pps-offset
This is a new command for 2.0
This command offsets the time position of the 1PPS output. The output is adjusted
in time (compared to where it would be positioned otherwise) by the configured
value. The rising edge is the on-time edge. Any 1PPS output is affected equally by
this setting. The width of the pulse can be adjusted with the CLI command, set
output pps-width. This offset can compensate for delays in the 1PPS signal and also
for network asymmetries. The default value was chosen to compensate for the
asymmetric Ethernet switch delay if the grandmaster is at 1 Gigabit and the
TimeProvider 500 is at 100 Mbit.
Note: When output is being generated, the OUT LED illuminates
green for either an e1_signal or a t1_signal signaltype. For signal
types of e1_ais or t1_iso_pulse, the OUT LED blinks green
indicating a special signal type.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 105
Chapter 4 CLI Commands
Set Output Commands
Syntax:
<offset in ns> = [-1000000, , 1000000] ns in steps of 1ns
Default:
<offset in ns> = 2984
Sets to 2984 ns because of the asymmetric delay when the grandmaster is 1
Gigabit and the TimeProvider 500 is 100Mbit.
Example:
To shift any 1PPS output negative by 10 s.
set output pps-offset -10000
Response:
Setting 1PPS offset to -10000 ns
set output pps-width
This command sets the positive pulse width of the 1PPS output. The rising edge is
the on-time edge. The position of the pulse can be adjusted using set output
pps-offset.
Syntax:
<width in ns> = [100, , 500000000] ns in steps of 1ns
Default:
<width in ns> = 100,000,000 = 100 ms
Example:
To set any 1PPS output width to 10 s.
set output pps-width 10000
Response:
Setting 1PPS width to 10000 ns
Note: For an optimum pulse shape on the 090-03863-01 hardware,
the pulse width should be set to 500 ns (default value) or less.
106 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set PTP Commands
Set PTP Commands
The set ptp commands configure settings related to PTP connectivity and flow
rates.
Figure 4-4. Set PTP Commands
set ptp addr-mode
This command replaces the 1.0 command, set ptp state.
This command controls whether or not the TimeProvider 500 will use unicast or
multicast for accessing PTP sync and announce messages. When set to disable,
TimeProvider 500 will not synchronize sync, announce, and delay-response
messages with a grandmaster clock. See Multicast Support for more information.
Syntax:
set ptp addr-mode { disable | multicast-hybrid | unicast }
Default:
enabled
Example:
set ptp addr-mode to unicast
Response:
PTP mode set to Unicast
set ptp address
This command configures the IP address of the selected external device. The
external device is either the GrandMaster clock [GM1], GrandMaster clock [GM2],
or a node manager device capable of transporting PTP packet messages.
Syntax:
dscp
set ptp commands
domain address addr-mode
disable multicast unicast
unicast
lease-int announce-int sync-int
mgmt
gm1 gm2 node-mgr
gm1 gm2 node-mgr
transport
dsl ethernet microwave sonet
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 107
Chapter 4 CLI Commands
Set PTP Commands
set ptp address [ gm1 | gm2 | node_mgr ]<ip_address>
Range:
ip_address = x.x.x.x
Range for all settings = [0, 1, , 255]
Default:
ip_address = 0.0.0.0
Example:
TP-500> set ptp address gm1 192.168.2.43
Response:
Grand Master 1 address set to 192.168.2.43
set ptp domain
This command sets the ptp domain value for TimeProvider 500.
Syntax:
set ptp domain domain_number
Range:
domain_number = [0, 1, , 255]
Default:
domain_number = 0
Example:
Sets the domain number to 3.
set ptp domain 3
Response:
Domain set to 3
Note: The TimeProvider 500 will not attempt communications with a
device if this setting is 0.0.0.0.
Note: The set configuration factory command will reset the
IP address of grandmasters and the node manager to its default
value. The set configuration default command will not
change the current IP address settings.
108 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set PTP Commands
set ptp dscp
This command configures the Differentiated Services Code Point (DSCP) value for
TimeProvider 500 outbound packets. DSCP is the lower 6 bits of the DS field of the
IP packet header.
Syntax:
set ptp dscp dscp_value
Range:
dscp_value = [0, 1, , 63 ]
Default:
dscp_value = 0
Example:
Sets the DSCP outbound packet value to 16.
set dscp to 16
Response:
DSCP set to 16
set ptp mgmt
This command is new for version 2.0.
The command controls whether the selected PTP device allows PTP management.
This provides user control on which external devices are allowed to configure and
control actions in the TimeProvider 500. See PTP Management.
Syntax:
Set ptp mgmt { gm1 | gm2 | node-mgr } { enable | disable }
Default:
gm1 = enable
gm2 = enable
node-mgr = disable
Example:
TP-500> set ptp mgmt gm1 enable
Note: The set configuration factory command resets the
set ptp mgmt value to its default value. The set configuration
default command will not change the current setting.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 109
Chapter 4 CLI Commands
Set PTP Commands
Response:
Management for GM1 enabled
set ptp transport
This command is new for version 2.0.
This command defines the type of network used for transporting PTP traffic to
optimize performance. This command makes configuration profile changes.
Ethernet should be chosen if the entire path is over native Ethernet. For
non-Ethernet transports configured for PPS-coupled mode (see set output
pps-mode), time services are disabled.
Syntax:
set ptp transport {dsl|ethernet|microwave|sonet}
Range:
TP-500> set ptp transport
dsl - Sets PTP transport mode to DSL
ethernet - Sets PTP transport mode to Ethernet
microwave - Sets PTP transport mode to microwave
sonet - Sets PTP transport mode to SONET
Example:
TP-500> set ptp transport dsl
Response:
Setting PTP transport mode to DSL
set ptp unicast announce-int
This command sets the desired interval (in seconds) between announce messages
sent by the grandmaster clocks.
Syntax:
set ptp unicast announce-int a_interval
Range:
a_interval = [1 | 2 | 4 | 8] seconds
Default:
a_interval = 1 second
110 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Set PTP Commands
Example:
Sets the desired announce interval to 4 seconds.
set ptp unicast announce-int 4
Response:
Announce period set to 4 seconds
set ptp unicast lease-int
This command sets the lease duration that the TimeProvider 500 will attempt to
establish between a grandmaster clock server and itself.
Syntax:
set ptp unicast lease-int lease_duration
Range:
lease_duration = [ 10, 11, , 3000 ] seconds
Default:
300 seconds
Example:
Sets the lease duration to 200 seconds.
set ptp unicast lease-int 200
Response:
PTP lease set to 200 seconds
set ptp unicast sync-int
The sync-rate range has changed for version 2.0.
This command sets the TimeProvider 500 requested unicast packet rate for Sync
and Delay_Resp messages from master clock(s).
Syntax:
set ptp unicast sync-int sync_rate
Range:
sync_rate = [ 16 | 32 | 64 ] packets/second
Default:
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 111
Chapter 4 CLI Commands
Show Commands
sync_rate = 64 packets/second
Example:
Sets the packet rate to 32 packets per second.
set ptp unicast sync-int 32
Response:
Sync rate set to 32 pkts/sec
Show Commands
The show commands provide current TimeProvider 500 values and status. Alarms
that are of event severity are not shown.
show alarm
This command provides a list of active alarms.
Syntax:
show alarm
Response:
ID Severity Time-Date Description
------------------------------------------------------------
0 MAJOR 00:00:01 01/01/1970 Lost communication with GM
2 MAJOR 00:00:01 01/01/1970 Free-run
3 MAJOR 00:00:01 01/01/1970 Sync packet rate low
4 MAJOR 00:00:01 01/01/1970 Delay packet rate low
9 MAJOR 00:00:01 01/01/1970 LINK loss of signal
show alarm-config
This command provides a table that shows available alarms, associated
alarm_num, delay, state, severity level, and alarm description. See Set Commands
to configure delay, state, and severity level.
Syntax:
TP-500> show alarm-config
112 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
Response:
TP-500> show alarm-config
ID Delay State Proxy Severity Description
--------------------------------------------------------------
0 3 ENABLED ENABLED MAJOR Holdover
1 3 ENABLED ENABLED MAJOR Free-run
2 3 ENABLED DISABLED EVENT Bridging
3 3 ENABLED ENABLED CRITICAL FPGA
4 3 ENABLED ENABLED CRITICAL 10MHz LOS
5 3 ENABLED DISABLED MAJOR LINK loss of signal
6 3 ENABLED DISABLED MAJOR Outputs disabled
7 3 ENABLED DISABLED MAJOR PTP disabled
8 3 ENABLED DISABLED MAJOR Sync packet rate low(GM1)
9 3 ENABLED DISABLED MAJOR Sync packet rate low(GM2)
10 3 ENABLED DISABLED MAJOR Delay packet rate low
11 3 ENABLED DISABLED MAJOR Announce Timeout(GM1)
12 3 ENABLED DISABLED MAJOR Announce Timeout(GM2)
13 3 ENABLED DISABLED MAJOR Signaling Ack Timeout(GM1)
14 3 ENABLED DISABLED MAJOR Signaling Ack Timeout(GM2)
15 3 ENABLED ENABLED EVENT Upgrade TP500 firmware
16 3 ENABLED DISABLED MAJOR Power Supply A
17 3 ENABLED DISABLED MAJOR Power Supply B
18 3 ENABLED DISABLED MAJOR Packet RTD too large
19 3 ENABLED DISABLED MAJOR Excessive transients
show announce
This is a new query in release 2.0
This command shows selected content from the most recently updated Announce
message from both GM1 and GM2.
Syntax:
TP-500> show announce
Response:
GM1 Announce (ref):
headerFlags : 0x15
currentUtcOffset : 34
grandmasterPriority1 : 128
clockClass : 6
clockAccuracy : 33
offsetScaledLogVariance : 25600
grandmasterPriority2 : 128
grandmasterIdentity : 00:B0:AE:FF:FE:01:31:5C
stepsRemoved : 0
timeSource : 0115
GM2 Announce (stale):
headerFlags : 0x18
currentUtcOffset : 34
grandmasterPriority1 : 128
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 113
Chapter 4 CLI Commands
Show Commands
clockClass : 7
clockAccuracy : 33
offsetScaledLogVariance : 25600
grandmasterPriority2 : 128
grandmasterIdentity : 00:B0:AE:FF:FE:01:31:5F
stepsRemoved : 0
timeSource : 115
show auto-neg
This command shows the current configuration for auto-negotiation.
Syntax:
show auto-neg
Response:
Auto-negotiation is : Disabled
show bridge-time
This command shows the current bridge time setting. This setting determines how
long the TimeProvider 500 will remain in BRIDGING FLL state before a transition
into HOLDOVER state. See Table 3-2 and Figure 3-8.
Syntax:
show bridge-time
Response:
Bridging time set to 420
show clock
This command is changed from version 1.0.
This command shows the TimeProvider 500s time (show clock status) as well as
the current time settings (show clock config). See set clock timescale, on page
86 and set clock timezone, on page 87.
Syntax:
show clock {config | status}
Example:
TP-500> show clock config
114 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
Response:
Timescale : UTC
Timezone offset : 00:00
Example:
TP-500> show clock status
Response:
Time is: 23:43:32 11/12/2009 (UTC)
show correction
This command shows average correction value in PTP packet.
Syntax:
TP-500> show correction
Response:
GM forward corr : 0 ns
Acc-GM forward corr : 0 ns
Delay corr : 0 ns
show eia-232
This command shows the baud setting for the serial port on theTimeProvider 500.
Syntax:
show eia-232 baud
Response:
Baud : 57600
Parity : none
Data bits : 8
show firewall
This command shows the current firewall settings.
Syntax:
TP-500> show firewall
Response:
ICMP is Allowed
Telnet is Allowed
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 115
Chapter 4 CLI Commands
Show Commands
show interface config
This command shows what the configured IP address, subnet mask, and gateway
settings are for the if0, if1, if2, if3, and if4 interfaces and associated external
attachments. This command also shows if the IP for the interfaces are set with
DHCP or static IP addressing. Static IP of different interfaces cannot be the same.
VlanID of different interfaces cannot be the same. These are both checked and
rejected (if necessary) during configuration.
Syntax:
TP-500> show interface config
Response:
Interface Configuration:
Name status static-ip netmask gateway ip-mode vid vpri
-------------------------------------------------------------------------------
if0 Enabled 192.168.1.98 255.255.255.0 0.0.0.0 Static -- --
if1 Enabled 192.168.1.11 255.255.255.0 0.0.0.0 Static 2 0
if2 Disabled 10.1.2.1 255.255.255.0 0.0.0.0 Static 3 0
if3 Disabled 10.1.3.1 255.255.255.0 0.0.0.0 Static 4 0
if4 Disabled 10.1.4.1 255.255.255.0 0.0.0.0 Static 5 0
-------------------------------------------------------------------------------
Attachments:
Device interface
---------------------
GM1 if0
GM2 if0
NODE-MGR if0
---------------------
show interface status
This command shows which interface configurations are recognized by the network
system. This command is similar to the show interface config command. The
difference being the show interface status command lets the user know which
configuration settings are recognized and working on the system. If an address has
not be assigned via DHCP and it is enabled, the IP address, subnet mask, and
gateway values are not displayed as shown in the following example.
Syntax:
TP-500> show interface status
Response:
Interface Status:
Name status ip-address netmask gateway ip-mode vid vpri
-------------------------------------------------------------------------------
if0 Enabled ------ ------ ------ Static -- --
if1 Enabled ------ ------ ------ Static 2 0
if2 Disabled 10.1.2.1 255.255.255.0 0.0.0.0 Static 3 0
if3 Disabled 10.1.3.1 255.255.255.0 0.0.0.0 Static 4 0
if4 Disabled 10.1.4.1 255.255.255.0 0.0.0.0 Static 5 0
116 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
-------------------------------------------------------------------------------
Attachments:
Device interface
---------------------
GM1 if0
GM2 if0
NODE-MGR if0
---------------------
show inventory
This command shows the product number, firmware version, and product serial
number. You cannot set or change these values.
Syntax:
show inventory
Response:
Product Number : 090-03863-02
Firmware Version : 2.0.0
Product Version :
Serial Number : r45091
User description : doug;lab
show image
This commands shows information about firmware images that are currently stored
in flash memory.
Syntax:
show image
Default at Shipment:
Images 0 and 1 contain the most recent TimeProvider 500 firmware released at the
time of shipment.
Example:
show image
Response:
Image 0
rev: [1.0.27]
size: [702563 bytes]
checksum: [0xFD821E3B]
Note: The firmware version shows which version is currently running.
The firmware version displayed is not necessarily the same firmware
version stored in flash memory.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 117
Chapter 4 CLI Commands
Show Commands
seq: [7]
Image is [Good]
Image 1
rev: [2.0.0]
size: [710742 bytes]
checksum: [0xFD75EF92]
seq: [8]
Image is [Good]
show led
This command shows the illumination status of each LED.
Syntax:
show led
Response:
Power : Green
Sync : Blink Amber
Output: Green
Alarm : Red
PWR A : Green
PWR B : Off
show log
This command shows the content of the selected log. The configuration log
provides history of configuration changes and the event log provides a history of
alarms and events (event, minor, major, and critical levels). The show event log lists
up to 200 entries numbered from 000 to 199. The sequence of the records in the log
is first in and first out. The latest entry is assigned the highest number in the log.
Syntax:
show log { configuration | event }
Default:
Logs are empty when shipped from the factory.
Example:
show log event
Response:
TP-500> show log event
Event Log
Current time is: 01:52:49 11/02/2008
118 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
Log 000: 20:48:42 01/11/1970: Logs cleared
Log 001: 20:49:25 01/11/1970: FLL state change from Bridging to Fast FLL
Log 002: 20:49:26 01/11/1970: Exit alarm 2 - Bridging
Log 003: 01:36:00 11/02/2008: Time was 20:53:12 01/11/1970
Log 004: 01:45:49 11/02/2008: Enter alarm 4 - 10MHz LOS
Log 005: 01:45:51 11/02/2008: Exit alarm 4 - 10MHz LOS
show output
This command provides a summary of signal output settings.
Syntax:
show output
Example:
TP-500> show output
Response:
TP-500> show output
Output 1 type : 2.048 MHz Clock
Output 2 type : 1PPS
Output 3 type : 2.048 MHz Clock
Output 4 type : 2.048 MHz Clock
HDB3 : Enabled
Freerun output mode : on
Holdover output mode: on
1PPS offset : 2984 ns
1PPS pulse width : 100000000 ns
1PPS mode : standard
show ptp
This command provides a summary of all PTP-related settings.
Syntax:
TP-500> show ptp
Response:
PTP Mode : Multicast
Client MAC address : 00:B0:AE:01:22:D5
Grand Master 1 IP : 10.1.0.2
Grand Master 2 IP : 0.0.0.0
Management IP : 0.0.0.0
Note: For a given alarm_num, the event log will only generate log
entries when the alarm_num is set to enable.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 119
Chapter 4 CLI Commands
Show Commands
Multicast IP : (NONE)
Management GM1 : Enabled
Management GM2 : Enabled
Management NODE-MGR: Enabled
Client Clock ID : 00:B0:AE:FF:FE:01:22:D5
Domain : 0
DSCP : 0
Sync Rate : 64 pkts/s
Announce Interval : 1 s
GM1 Lease Duration : 300 s
GM2 Lease Duration : 0 s
Transport : Ethernet
show status
This command provides a summary of current TimeProvider 500 performance
status. For more details, refer to Details for Show Status Function, on page 63.
Syntax:
TP-500> show status
Example:
TP-500> show status
Response:
Current Time : 21:51:38 11/09/2009 (UTC)
FLL state : Normal FLL [2840 min] Temperature
Reference : GM2 Avg : 41.01 C
Correction Freq : -10.12 ppb Min : 40.88 C
Phase : 0.00 ppb Max : 41.06 C
Output MDEV Estimate : 0.0002 ppb 5min : 55.37 mC
Residual Phase Error : 2377.13 ns 60min : 166.04 mC
Minimal RTD : 12.57 usec
--------------------------------------------------------------------------
Flow Direction : (GM to client) (client to GM)
GM1 (pkts/s): 0 0
GM2 (pkts/s): 64 64
Weight (%): 1.00 99.00
Transient free (/900): 900 900
Transient free (/3600): 3600 3600
Percentile Clustering(%): 99.8 99.8
Operational Min TDEV(ns): 2.7 1.8
Operational MAFE (ppb): 0.01 0.01
Min Cluster Width (ns): 100.0 100.0
Mode Width (ns): 100.0 200.0
--------------------------------------------------------------------------
Flow State : (GM1)Signaling (GM2)Normal
Clock id : (GM1)00:00:00:00:00:00:00:00 (GM2)00:B0:AE:FF:FE:01:31:65
120 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
show status-list
This command provides a summary of current TimeProvider 500 performance
status via the PTP management command show status.
Syntax:
TP-500> show status-list
Response:
Current time is : 21:52:17 11/09/2009
Current FLL State : Normal FLL
FLL State Duration (minutes) : 2840
Forward Flow Weight (%) : 1.00
Forward Flow Transient-free (out of 900 s) : 900
Forward Flow Transient-free (out of 3600 s) : 3600
Forward Flow Percentile Clustering (%) : 99.8
Forward Flow Operational Min TDEV (ns) : 2.7
Forward Flow Operational MAFE (ppb) : 0.01
Forward Flow Min Cluster Width (ns) : 100.0
Forward Flow Mode Width (ns) : 100.0
Reverse Flow Weight (%) : 99.00
Reverse Flow Transient-free (out of 900 s) : 900
Reverse Flow Transient-free (out of 3600 s) : 3600
Reverse Flow Percentile Clustering (%) : 99.8
Reverse Flow Operational Min TDEV (ns) : 1.8
Reverse Flow Operational MAFE (ppb) : 0.01
Reverse Flow Min Cluster Width (ns) : 100.0
Reverse Flow Mode Width (ns) : 200.0
Correction Frequency (ppb) : -10.12
Phase correction (ppb) : 0.00
Output TDEV Estimate (ns) : 1.80
Output MDEV Estimate (ppb) : 0.00
Residual phase error (ns) : 2377.13
Minimal RTD (us) : 12.57
Operational Temperature Max (deg C) : 41.06
Operational Temperature Min (deg C) : 40.88
Operational Temperature Avg (deg C) : 41.01
5 Minute Temperature Stability (mdeg C) : 55.37
60 Minute Temperature Stability (mdeg C) : 166.04
Timing Packet Rate GM1 (pkts/s) : 0
Timing Packet Rate GM2 (pkts/s) : 64
Timing Packet Rate Delay (pkts/s) : 64
Observation Interval (min) : 1
IPDV Threshold (usec) : 50.000
Pacing Factor for Jitter Computation : 16
Forward IPDV % Below Threshold : 100.0
Forward Maximum IPDV (usec) : 0.187
Forward InterPkt Jitter (usec) : 0.036
Reverse IPDV % Below Threshold : 100.0
Reverse Maximum IPDV (usec) : 0.168
Reverse InterPkt Jitter (usec) : 0.052
Reference : GM2
GM1 Flow State : Waiting for GM to respond to signaling
GM2 Flow State : Normal
GM1 Clock id : 00:00:00:00:00:00:00:00
GM2 Clock id : 00:B0:AE:FF:FE:01:31:65
Last Firmware Upgrade status : Upgrade succeeded
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 121
Chapter 4 CLI Commands
Show Commands
show temperature
This command provides data from the temperature-sensing device located in the
TimeProvider 500. The data presented shows temperature behavior and conditions.
Temperature data is also provided in the show status command.
Syntax:
show temperature
Response:
Temperature : 30.65 C
show tod
This command shows TOD status, TOD format, and TOD timescale parameters
based on the settings configured with the set tod command.
Syntax:
show tod
Response:
TOD status : Disabled
TOD format : T1
TOD timescale : TAI
122 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 4 CLI Commands
Show Commands
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 123
Chapter 5 Maintenance, Troubleshooting & Ordering
This chapter describes maintenance and troubleshooting procedures for the
TimeProvider 500.
In This Chapter
Preventive Maintenance
Safety Considerations
Reading LED Conditions
Upgrading the Firmware
Alarm System Messages
Grandmaster Clock Link Corrective Action
TimeProvider 500 System and Accessory Part Numbers
Returning the TimeProvider 500
Contacting Symmetricom Global Services
User Manual Updates
Preventive Maintenance
The TimeProvider 500 requires minimal preventive maintenance. Ensure the unit is
not exposed to hazards such as direct sunlight, open windows, water, or extreme
heat.
Caution: To avoid electromagnetic discharge damage to the circuitry,
never attempt to vacuum the TimeProvider 500.
Caution: To avoid damage, under no circumstances should the
interior chassis of the TimeProvider 500 be allowed to come in
contact with water.
124 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 5 Maintenance, Troubleshooting & Ordering
Safety Considerations
Table 5-1 lists preventive maintenance measures to be performed periodically. Do
not disassemble components just for the purpose of inspection.
Safety Considerations
Follow your companys safety guidelines and policies when working on or around
live equipment. Refer to the National Electric Code ANSI/NFPA70, or per the
application code in the country of installation for more information.
Table 5-1. Preventive Maintenance
Item Inspection Corrective Action Interval
Chassis Inspect for dirt or foreign
material
Clean the exterior of chassis with
a soft dry cloth
Periodically
Cables Inspect for pinched, worn or
damaged cable
Replace pinched, worn or
damaged cable at the first
opportunity
Periodically
Connectors Inspect for loose or damaged
connector
Tighten loose connectors. If
damaged, replace the connector
and/or cable at the first opportunity
Periodically
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 125
Chapter 5 Maintenance, Troubleshooting & Ordering
Reading LED Conditions
Reading LED Conditions
In Table 5-2, the function of each LED and its color illumination indicators are
described.
Table 5-2. LED Conditions
Indicator Label Description
Power Indicators PWR Green - Power available
Off - Power not available
PTP Synchronization
Indicator
SYNC Off -No synchronization packets are being
received from the grandmaster clock.
Blinking Amber - Synchronization packets are
being received from the grandmaster clock.
Blinking Green - Performance margins are
improved, but steady state is not yet attained or
TimeProvider 500 is receiving sychronization
packets from the grandmaster clock and
performing frequency adjustments.
Green - Performance margins are stable or
abnormal packet flow is observed such as loss
of synchronization flow or significant load
change.
Amber - TimeProvider 500 is no longer using
synchronization flow from the grandmaster clock
to control the outputs.
T1/E1 signal activity OUT Off - No output
Green - A normal sync signal-type is being
generated.
Blinking Green-An output is being generated
but it is not a signal type normally used for
synchronization such as e1_ais and
t1_iso_pulse. See set output out1, out2,
out3 & out4, on page 103 for more information.
Alarm Indicator ALARM Off - No event or alarm with severity is present.
Amber - A minor alarm.
Red - A major or critical alarm.
Power A Indicator A FAIL Green - Power available
Off - Power not available
Power B Indicator B FAIL Green - Power available
Off - Power not available
126 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 5 Maintenance, Troubleshooting & Ordering
Upgrading the Firmware
If the power LEDs are not green and/or turned off, check the polarity of the wiring. If
the wiring is correct and the Power LEDs are still not lit, then the unit needs to be
returned to Symmetricom for service. The TimeProvider 500 internal fuse, F1, is a
500mA, slow blow, 125V UL Recognized surface mount fuse.
Upgrading the Firmware
You can upgrade the TimeProvider 500 firmware using CLI commands. Refer to
Firmware Upgrade , on page 71 and the command upgrade, on page 83 for details
on the upgrade process.
Alarm System Messages
Table 5-3 provides information about the alarm messages that display in response
to an occurrence of an event or an alarm. The alarm number (alarm_num) is used in
the CLI commands to alter delay, enable status, or define alarm severity if desired.
Table 5-3. Alarm System Messages
Description
Alarm
Number
Default
Severity
Level
MsgText Corrective Action
The TimeProvider 500 is in
holdover mode.
0 Major Holdover See Grandmaster
Clock Link Corrective
Action, on page 130.
The TimeProvider 500 is in
free-run mode. This is a
normal temporary condition as
the unit powers-up, but if the
alarm persists when the unit is
expected to have PTP flow,
there may be a problem.
1 Major Free-run See Grandmaster
Clock Link Corrective
Action, on page 130.
The TimeProvider 500 is in
bridging mode. This shows
that a condition exists which
causes TimeProvider 500 to
be unable to maintain normal
frequency lock.
2 Event Bridging TimeProvider 500 may
have lost PTP flow. Allow
TimeProvider 500 to
re-lock.
An FPGA problem is detected. 3 Critical FPGA Send TimeProvider 500
back to the factory. See
Returning the
TimeProvider 500, on
page 99.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 127
Chapter 5 Maintenance, Troubleshooting & Ordering
Alarm System Messages
An internal 10 MHz is not
detected.
4 Critical 10MHZ LOS Send TimeProvider 500
back to the factory. See
Returning the
TimeProvider 500, on
page 99.
A LINK loss of signal. This
alarm is a normal condition
when a network cable is not
connected to TimeProvider
500.
5 Major LINK loss of signal Check the LAN
connection.
The outputs are disabled
because the set output
command is set to disable.
This alarm provides a
reminder that the disable
setting is present.
6 Major Outputs disabled To enable output signals,
change the output
signaltype to a setting
other than disable.
PTP is disabled via the set
ptp state command. This
alarm provides a reminder
that the TimeProvider 500 will
not operate normally with this
setting.
7 Major PTP disabled See Grandmaster
Clock Link Corrective
Action, on page 130.
The sync packet rate from the
grandmaster has fallen below
the expected rate.
Note: This alarm does not
occur if the grandmaster IP
address is set to 0.0.0.0. With
a 0.0.0.0 IP address setting,
TimeProvider 500 is not
expecting packet flow signals
from the grandmaster clock.
8 Major Sync packet rate low
(GM1)
See Grandmaster
Clock Link Corrective
Action, on page 130.
Table 5-3. Alarm System Messages
Description
Alarm
Number
Default
Severity
Level
MsgText Corrective Action
128 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 5 Maintenance, Troubleshooting & Ordering
Alarm System Messages
The synchronization packet
rate from the GM2
GrandMaster clock has fallen
below the expected rate.
Note: This alarm does not
occur if the GM2 GrandMaster
IP address is set to 0.0.0.0.
With a 0.0.0.0 IP address
setting, TimeProvider 500 is
not expecting packet flow
signals from the GM2
GrandMaster clock.
9 Major Sync packet rate low
(GM2)
See Grandmaster
Clock Link Corrective
Action, on page 130.
The delay_resp messages
from the selected
grandmaster clock is below
the expected rate.
Note: This alarm does not
occur if the IP address of both
possible grandmaster clocks
is set to 0.0.0.0. With an
0.0.0.0 IP address setting,
TimeProvider 500 is not
expecting packet flow signals
from the possible grandmaster
clocks.
10 Major Delay packet rate
low
See Grandmaster
Clock Link Corrective
Action, on page 130 and
verify that the
grandmaster clock is
ready for connection.
The announce messages from
the grandmaster clock are
disqualified.
Note: This alarm does not
occur if the grandmaster
clocks IP address is set to
0.0.0.0. With a 0.0.0.0 IP
address setting, TimeProvider
500 is not expecting packet
flow signals from the
grandmaster clock.
11 Major Announce timeout
(GM1)
See Grandmaster
Clock Link Corrective
Action, on page 130 and
verify that the
grandmaster clock is
ready for connection.
Table 5-3. Alarm System Messages
Description
Alarm
Number
Default
Severity
Level
MsgText Corrective Action
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 129
Chapter 5 Maintenance, Troubleshooting & Ordering
Alarm System Messages
The announce messages from
the (GM2) GrandMaster clock
are disqualified.
Note: This alarm does not
occur if the grandmaster
clocks IP address is set to
0.0.0.0. With a 0.0.0.0 IP
address setting, TimeProvider
500 is not expecting packet
flow signals from the
grandmaster clock.
12 Major Announce timeout
(GM2)
Verify that the
grandmaster clock is
ready for connection.
The GrandMaster clock (GM1)
signaling acknowledgements
have timed out. This means
that signaling requests from
TimeProvider 500 are not
being acknowledged by the
grandmaster clock.
13 Major Signaling Ack
Timeout (GM1)
See Grandmaster
Clock Link Corrective
Action, on page 130.
The GM2 GrandMaster clock
signaling acknowledgements
have timed out. This means
that signaling requests from
TimeProvider 500 are not
being acknowledged by the
grandmaster clock.
14 Major Signaling Ack
Timeout (GM2)
See Grandmaster
Clock Link Corrective
Action, on page 130.
Firmware upgrade is in
process.
15 Event Upgrade TP500
firmware
N/A
The power is not being
supplied at PWR A.
16 Major Power Supply A Verify that the cable is
connected.
The power is not being
supplied at PWR B.
17 Major Power Supply B Verify that the cable is
connected.
Packet Round-Trip Delay
(RTD) too large
18 Major Packet RTD too
large
Verify that the network
has round-trip delay
(RTD) capability. If the
network has round-trip
delay, verify that it takes
less than a half second.
Excessive Transients 19 Major Excessive transients Check the network
traffic. The network traffic
noise is not allowing the
TimeProvider 500 to
lock.
Table 5-3. Alarm System Messages
Description
Alarm
Number
Default
Severity
Level
MsgText Corrective Action
130 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 5 Maintenance, Troubleshooting & Ordering
Grandmaster Clock Link Corrective Action
Grandmaster Clock Link Corrective Action
When there is an issue with the link to the grandmaster clock, do the following:
Check the IP address of TimeProvider 500 by using the show interface
config CLI command. See show interface config, on page 115.
Check the IP addresses of the grandmaster clocks with the show ptp CLI
command. See show ptp, on page 118.
Check VLAN with the show interface config CLI command. See show
interface config, on page 115.
Try to ping TimeProvider 500 from another network element on the Ethernet
subnet. See ping, on page 82.
TimeProvider 500 System and Accessory Part Numbers
This section provides part numbers and accessories available for the TimeProvider
500.
Returning the TimeProvider 500
You should return the equipment to Symmetricom only after you have exhausted the
troubleshooting procedures described in this user guide, or if Symmetricom Global
Services has advised you to return the unit.
Table 5-4. Component Part Numbers
Item Part Number
TimeProvider 500 IEEE 1588v2 Translator Kit 990-03863-02
Power Connector and Pins (included with part number 990-03863-02) 093-00063-000
TimeProvider 500 19 Rack Mount Kit 093-00090-000
TimeProvider 500 19 Dual Rack Mount Kit 093-00069-000
21 Mounting Adapter Bracket Kit 093-00011-000
23 Mounting Adapter Bracket Kit 093-00012-000
Note: Please retain the original packaging for re-shipping the
product. If the original packaging is not available, contact
Symmetricom Global Services (SGS) for assistance.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 131
Chapter 5 Maintenance, Troubleshooting & Ordering
Contacting Symmetricom Global Services
Repacking the Unit
Return all units in the original packaging. If the original packaging is not available,
contact Symmetricom Global Services. Use standard packing procedures for
products being returned for repair to protect the equipment during shipment.
Equipment Return Procedure
To return equipment to Symmetricom for repair:
1. 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 to
obtain a return material authorization number (RMA) before returning the product
for service.
You can request an RMA on the internet at
www.symmetricom.com/Support/req_repair.htm.
Retain the assigned RMA number for future reference.
2. Provide a description of the problem, product item number, serial number, and
warranty expiration date.
3. Provide the return shipping information (customer field contact, address,
telephone number, and so forth.)
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.
Repaired equipment is returned to you with shipping costs prepaid by
Symmetricom.
Contacting Symmetricom Global Services
If you encounter any difficulty installing or operating the product, contact
Symmetricom Global Services at:
U.S.A. Call Center:
Symmetricom, Inc.
2300 Orchard Parkway
San Jose, CA 95131-1017
Toll-free North America: 888-367-7966
Tel: 408-428-7907
Fax: 408-428-7998
132 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 5 Maintenance, Troubleshooting & Ordering
User Manual Updates
E-mail: support@symmetricom.com
Internet: http://www.symmetricom.com
Europe, Middle East, and Africa (EMEA) Call Center:
Symmetricom Global Services EMEA
Altlaufstrasse 42
85635 Hoehenkirchen-Siegertsbrunn Germany
Tel: +49 700 3288 6435
Fax: +49 8102 89615-33
E-mail: emeasupport@symmetricom.com
Internet: http://www.symmetricom.com
User Manual Updates
From time to time, this manual may be updated. The updated version of the manual
will be available for downloading in electronic form via the Internet. After
downloading, the manual can be viewed on a computer or printed out.
Manual updates are available by logging in to Telecom Solutions Support at:
http://www.symmetricom.com/support/online-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.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 133
Chapter 6 Specifications and Factory Defaults
This appendix provides mechanical and electrical specifications and factory defaults
for the TimeProvider 500.
In This Appendix
Component Specifications
Factory Defaults
Electromagnetic Environment
Regulatory Requirements
Component Specifications
This section provides the specifications for the TimeProvider 500 components and
input and output signals.
Mechanical
Table 6-1. TimeProvider 500 Mechanical Specifications
Parameter Description
Mounting 19 in. / 48cm Rack
Rack Mounting Position Front mounting location, unit protrudes 0.75 in. / 4.445cm
Width 8.53 in. / 216.7 mm
Height 1.63 in. / 41.4 mm
Depth 8.0 in. / 203.2 mm
Weight 896 g. fully loaded
134 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 6
Component Specifications
Environmental
Power
Table 6-2. TimeProvider 500 Environmental Specifications
Parameter Description
Operating Temperature -5 to +65 C, 23 to 149 F
Storage Temperature -40 to +70 C, -40 to +158 F
Operating Humidity 5% to 93% RH
Storage Humidity 10% to 100% RH
Table 6-3. TimeProvider 500 Power Specifications
Parameter Description
DC Input -48 VDC / -60 VDC Nominal 0.110A current @ -48V
Operating range: -40 VDC to -72 VDC
0.175A (warm-up) @ -48V
0.100A (operating) @ -48V
Branch Circuit
Over-Current Protection
Device
1.0 A
DC Power 5.3 W, typical
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 135
Chapter 6
Component Specifications
Serial Port
Ethernet Port
Table 6-4. Serial Port Specifications
Parameter Description
Connector Type 9-pin, female D connector
Connector Label RS232 MGMT
Interface RS-232, data terminal equipment (DTE)
Baud Rate 57.6 Kbps
Data Bits 8
Parity Bit None
Stop Bits 1
Flow Control None
Timeout Approximately 60 minutes
Table 6-5. LAN Port Specifications
Parameter Description
Connector Type RJ-45
Connector Label 1588
Speed 100 Mbps
Interface IEEE 1588v2 and telnet
Timeout Approximately 10 minutes, applies for telnet
136 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 6
Component Specifications
1PPS Outputs
T1 Outputs
Table 6-6. 1PPS Port Specifications
Parameter Description
Connector Type BNC
Amplitude 2.5 volts peak-to-peak 0.5 volts
Connector Label OUT1, OUT2
Impedance 50
Pulse Width 100 ns 500 ms
Risetime <20 ns
Table 6-7. T1 Output Specifications
Parameter Specification
Connector Type BNC & RJ48C
Connector Label OUT1, OUT2, OUT3 & OUT4
Framing (user selectable) D4/Super Frame (SF)
Extended Super Frame (ESF)
Signal Waveshape Framed, all ones, Alternate Mark Inversion (AMI) per
(ANSI) T1.102 and ITU-T Rec. G.703
Pulse Amplitude 2.4 to 3.6 volts peak into 100
Termination Impedance 100 5% balanced
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 137
Chapter 6
Component Specifications
1.544 MHz Outputs
10 MHz Output
Table 6-8. 1.544 MHz Specifications
Parameter Specification
Connector Type BNC & RJ48C
Connector Label OUT1, OUT2, OUT3 & OUT4
Amplitude 2.4 to 3.6 volts peak into 100
Wave Shape Square Wave
Termination Impedance 100
Table 6-9. 10 MHz Specifications
Parameter Specification
Connector Type BNC
Connector Label 10 MHz
Amplitude 7.5 dBm to 1.5 dBm nominal into 50
Wave Shape Sinusoidal
Termination Impedance 50
Phase Noise 1Hz 60 dBc/Hz
10 Hz 90 dBc/Hz
100 Hz 110 dBc/Hz
1 kHz 120 dBc/Hz
10 kHz 125 dBc/Hz
138 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 6
Component Specifications
E1 Outputs
2.048 MHz Outputs
Holdover
< 20 microseconds after 24 hours following loss of PTP reference
Test Conditions:
TimeProvider 500 subjected to 5 C temperature variation throughout test.
TimeProvider 500 referenced to PTP for at least 24 hours prior to the start of holdover.
TimeProvider 500 powered > 5 days prior to the test.
Table 6-10. E1 Output Specifications
Parameter Specification
Connector Type BNC & RJ48C
Connector Label OUT1, OUT2, OUT3 & OUT4
Framing (user selectable) CAS, CCS, CAS4, CCS4
Signal Waveshape Framed, all ones, Alternate Mark Inversion (AMI)
Per ITU-T Rec. G.703 Sec. 9
Pulse Amplitude 2.7 to 3.3 volts peak into 120
2.13 to 2.6 volts peak into 75
Termination Impedance 120 5% balanced; 75 5% unbalanced
Table 6-11. 2.048 MHz Specifications
Parameter Specification
Connector Type BNC & RJ48C
Connector Label OUT1, OUT2, OUT3 & OUT4
Amplitude 2.7 to 3.3 volts peak into 120
2.13 to 2.6 volts peak into 75
Wave Shape Square Wave
Termination Impedance 75
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 139
Chapter 6
Typical Performance
Typical Performance
Figure 6-1. MTIE Test Threshold
Table 6-12. Typical Performance
Test Cases
MTIE Test
Threshold
Fractional
Frequency
Offset
1PPS Output
(compared with
Grandmaster PPS)
Advanced 8261-based tests
(more severe conditions)
See Figure 6-1 <1ppb < +/-3s
8261-based tests (5 switches) See Figure 6-1 <1ppb < +/-1s
Transport includes microwave,
SHDSL, or TDM over packet
N/A <5ppb N/A
140 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 6
Factory Defaults
Factory Defaults
Table 6-13 provides general and communication default values.
Table 6-13. General and Communication Parameters
Description Default Value Value Range
Alarm Delay 3 seconds 086400 seconds
Alarm State Enabled Enable | Disable
Announce Interval 1 second 1, 2, 4, 8 second(s)
Bridge Time 420 seconds 12086400 seconds
Domain 0 0255
DSCP 0 063
EIA-232 Port 57.6k-8-N-1 Baud rate range:
4800 | 9600 | 19200 | 38400 | 57600
Firewall Allowed for telnet / ICMP Allowed | Blocked
Freerun Output ON { ais | on | squelch }
Gateway Address 0.0.0.0 Valid IPv4 Address
GM1 IP Address 192.168.1.11 Valid IPv4 Address
GM2 IP Address 0.0.0.0 Valid IPv4 Address
HDB3 Enabled Enable | Disable
Holdover Output ON { ais | on | squelch }
IP Address 192.168.1.9 (non-VLAN) Valid IPv4 address
IP Mode Static DHCP | Static
Lease Duration 300 seconds 103000 seconds
Network Mask 255.255.255.0 Valid IPv4 Mask
PTP State Enabled Enable | Disable
PPS Offset 2894 ns -1,000,000 +1,000,000 ns
PPS Width 100,000,000 ns, 500 ns
is the default for
090-03863-01 hardware.
100500,000,000 in steps of 1 ns
Signal Type (OUT1) clk_2048 [1pps | clk_2048 | e1_cas | e1_cas4 |
e1_ccs | e1_ccs4 | e1_ais| t1_sf | t1_esf |
clk_1544 | t1_iso_pulse]
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 141
Chapter 6
Electromagnetic Environment
Electromagnetic Environment
Categories that may be covered here include: Indirect and direct ESD immunity,
Electrical fast transients, radiated immunity, conducted immunity, and surge
protection.
Emissions/Immunity
FCC Pt. 15 Class B
ICES-003 Class B
Signal Type (OUT2) 1pps [1pps | clk_2048 | e1_cas | e1_cas4 |
e1_ccs | e1_ccs4 | e1_ais| t1_sf | t1_esf |
clk_1544 | t1_iso_pulse]
Signal Type (OUT3) clk_2048 [clk_2048 | e1_cas | e1_cas4 | e1_ccs |
e1_ccs4 | e1_ais | 1_sf | t1_esf | clk_1544 |
t1_iso_pulse]
Signal Type (OUT4) clk_2048 [clk_2048 | e1_cas | e1_cas4 | e1_ccs |
e1_ccs4 | e1_ais | 1_sf | t1_esf | clk_1544 |
t1_iso_pulse]
Sync Rate 64 pkt/second 16, 32, 64, pkt/sec
User Name admin 20 ASCII characters
User Password symmadmin** 32 ASCII characters, a minimum of 8
VLAN Interfaces Disabled Enable | Disable
VLAN ID if1=2
if2=3
if3=4
if4=5
14094
VLAN Priority 0 07
Note: When using the set configuration factory command,
the User Name and User Password do not return to the default value
in Table 6-13. When using the set configuration default
command, User Name, User Password, IP Mode, IP Address,
Gateway Address, Network Mask, Grandmaster IP Address,
Acc-Grandmaster IP Address, VLAN, VLAN ID, and VLAN Priority do
not return to the default value in Table 6-13.
Table 6-13. General and Communication Parameters (Continued)
Description Default Value Value Range
142 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Chapter 6
Regulatory Requirements
VCCI Class A
AS/NZS CISPR 22 Class B
ETSI 300 386 Class B
EN 55022/24 Class B
KN 55022/24 KCC Class B
EMC IMMUNITY MEETS CRITERIA A
EN61000-4-2 ESD
EN61000-4-3 RADIATED IMMUNITY
EN61000-4-4 ELECTRICAL FAST TRANCIENT BURST
EN61000-4-5 SURGE
EN61000-4-6 CONDUCTED IMMUNITY
NEBS EMC Fully Compliant
NEBS ESL Partially Compliant
Regulatory Requirements
Symmetricom is certified with the following safety compliant certificates:
UL
cUL
CB Scheme
CE Mark
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 143
Appendix A Tmecode Formats
In This Appendix
NMEA Format
T1 Format
NMEA Format
Example:
$GPRMC,122356,A,0000.0000,N,00000.0000,W,0.0.0.0,120508,,,A*F6
Table A-1. NMEA Format
Element Description
$GPRMC Message header
122356 UTC value (hhmmss)
A Status (A = active, V = void)
0000.0000,N Latitude, north (Normally fixed to zero, optionally grandmaster's position)
00000.0000,W Longitude, west (Normally fixed to zero, optionally grandmaster's position)
0.0 Speed over ground (fixed to zero)
0.0 Track angle (fixed to zero)
120508 Date (ddmmyy)
A A = autonomous, D = differential, E = estimated, S = simulation, N = not valid
*F6 NMEA Checksum - each byte value between the dollar sign ($) and asterisk (*)
is XOR'ed.
144 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
T1 Format
T1 Format
Example:
T1 003125 11182009 00 03 00022800 22 53
Table A-2. T1 Format
Byte Datatype Description
0 0xAA 1 bit binary SYNC character = 0xAA
1-2 T1 2 bytes ASCII Mode string = T1
3-8 003125 6 bytes ASCII time value (hhmmss) can be set to UTC,
local, GPS, or TAI timescale
9-16 11182009 8 bytes ASCII date value (ddmmyyyy)
17-18 00 2 bytes ASCII FOM = Output TDEV Estimate / 100.0
19-20 03 2 bytes ASCII Status Word
Bit 7 +1 pending leap sec
Bit 6 -1 pending leap sec
Bit 5 not used
Bit 4 not used
Bit 3 not used
Bit 2 Bit 0 =
0 = FLL_UNKNOWN
1 = FLL_WARMUP
2 = FLL_FAST
3 = FLL_NORMAL
4 = FLL_BRIDGE
5 = FLL_HOLD
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 145
T1 Format
21-28 00022800 8 bytes ASCII Alarm Word:
Bits assignment is the same as alarm
assignments (show alarm-config)
Bit Alarm:
0 Holdover
1 Free-run
2 Bridging
3 FPGA
4 10MHz LOS
5 LINK loss of signal
6 Outputs disabled
7 PTP disabled
8 Sync packet rate low(GM1)
9 Sync packet rate low(GM2)
10 Delay packet rate low
11 Announce Timeout(GM1)
12 Announce Timeout(GM2)
13 Signaling Ack Timeout(GM1)
14 Signaling Ack Timeout(GM2)
15 Upgrade TP500 firmware
16 Power Supply A
17 Power Supply B
18 Packet RTD too large
19 Excessive transients
29-31 22 2 bytes ASCII UTC-TAI offset (Hex: 00 to FF)
32-33 53 2 bytes ASCII Checksum (CRC) from byte 3 to byte 28
The CRC is generated using
Table A-2. T1 Format (Continued)
Byte Datatype Description
146 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
T1 Format
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 147
Appendix B Configuring the TimeProvider 5000 and 500
Example
TimeProvider 5000 and 500 Configuration Example
Table B-1 lists the actions to configure the TimeProvider 5000 and TimeProvider
500 and to verify that network communication between the TimeProvider 5000 and
TimeProvider 500 is enabled. In this example, the TimeProvider 500s configuration
is for non-VLAN Ethernet interface if0.
Table B-1. TimeProvider 5000 and 500 Configuration
TimeProvider 5000 TimeProvider 500
Connect to Craft Port
Use serial cable to connect Craft port to serial port
of laptop computer.
Connect to Craft Port
Use serial cable to connect Craft port to serial
port of laptop computer.
Serial Communication
Establish serial communication with TP5000 using
terminal emulation:
All Programs>Accessories>Communication>
HyperTerminal
COM1 port: 8 data bits, 1 stop bit, no parity, 57,600
baud rate, no flow control
Serial Communication
Establish serial communication with TP500
using terminal emulation
All Programs>Accessories>Communication>
HyperTerminal
COM1 port: 8 data bits, 1 stop bit, no parity,
57,600 baud rate, no flow control
Log on to TimeProvider 5000
User: admin
Password: symmadmin**
Log on to TimeProvider 500
User: admin
Password: symmadmin**
148 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
TimeProvider 5000 and 500 Configuration Example
Configure Static Management IP Address
For static IP, do not connect an Ethernet cable
until the following steps are completed to avoid
IP conflicts.
For a demo using a local network; default
settings can be used.
For customer networks; get the gateway
address of the customers router/switch.
Perform the following steps:
1. At the TP5000> prompt, type set
ip-mode imc static <enter>
2. At the TP5000> prompt, type set ip imc
address 192.168.9.20 netmask
255.255.255.0 gateway
192.168.9.1 <enter>
3. At the TP5000> prompt, type set ip imc
restart <enter>
Configure Ethernet Interface if0 IP Address
The TimeProvider 500s factory default for
addressing mode for all the interface
connections is static.
Perform the following steps:
1. At the TP-500> prompt, type set ip
if0 192.168.1.22 netmask
255.255.255.0 gateway
192.168.1.1 <enter>
2. To verify IP change, at the TP-500>
prompt, type show interface
config <enter>
Configure Dynamic Management IP Address
The Ethernet cable should already be connected
and the DHCP server configured.
Perform the following steps:
1. At the TP5000> prompt, type set
ip-mode imc dhcp <enter>
2. At the TP5000> prompt, type set ip imc
restart <enter>
3. At the TP5000> prompt, type show ip
mode <enter> {to verify DHCP change}.
Configure Dynamic Ethernet Interface if0
Address
The Ethernet cable should already be
connected and the DHCP server configured.
Perform the following steps:
1. At the TP-500> prompt, type set
ip-mode if0 dhcp <enter>
2. At the TP-500> prompt, type show
interface status <enter> {to
verify DHCP change}
Table B-1. TimeProvider 5000 and 500 Configuration (Continued)
TimeProvider 5000 TimeProvider 500
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 149
TimeProvider 5000 and 500 Configuration Example
Configure GrandMaster IP Address
Use the IP address of the grandmaster
customized for your system network and
attach the grandmaster to one of the
TimeProvider 500s Ethernet interfaces.
Perform the following steps:
1. At the TP-500> prompt, type set ptp
address gm1 192.168.1.15
2. At the TP-500> prompt, type set
interface attachments gm1 if0.
View Management IP Address
Perform the following step:
1. At the TP5000> prompt, type show ip
status imc <enter>
Confirm Grandmaster Address and PTP
Configuration
Perform the following step:
1. At the TP-500> prompt, type show ptp
<enter>
Enable Firewall for Telnet
Perform the following steps:
1. At the TP5000> prompt, type set
firewall imc telnet allow
<enter>
2. At the TP5000> prompt, type set ip imc
restart <enter>
Connect Through an Ethernet LAN
Use an Ethernet cable to connect the IMC module
to the switch /router.
To telnet from your computer to the IP address of
the TP5000, type the following user name and
password:
User: admin
Password: symmadmin**
Table B-1. TimeProvider 5000 and 500 Configuration (Continued)
TimeProvider 5000 TimeProvider 500
150 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
TimeProvider 5000 and 500 Configuration Example
Configure IOC Ethernet Ports
Redundant Ports
Perform the following steps:
1. At the TP5000>prompt, type set ip
ioc1-1 address 192.168.1.15
netmask 255.255.255.0 gateway
192.168.1.1 <enter>
2. At the TP5000> prompt, type set ip
ioc1-1 restart <enter>
3. At the TP5000> prompt, type set
redundancy port ioc1 enable
<enter>
Independent Ports
Perform the following steps:
1. At the TP5000> prompt, type set
redundancy port ioc1 disable
<enter>
2. At the TP5000> prompt, type set ip
ioc1-1 address 192.168.1.15
netmask 255.255.255.0 gateway
192.168.1.1 <enter>
3. At the TP5000>prompt, type set ip
ioc1-1 restart <enter>
4. At the TP5000> prompt, type set ip
ioc1-2 address 192.168.2.15
netmask 255.255.255.0 gateway
192.168.2.1 <enter>
5. At the TP5000> prompt, type set ip
ioc1-2 restart <enter>
Table B-1. TimeProvider 5000 and 500 Configuration (Continued)
TimeProvider 5000 TimeProvider 500
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 151
TimeProvider 5000 and 500 Configuration Example
Confirm Network Communication between
TimeProvider 5000 and TimeProvider 500
Connect the Ethernet cable from IOC
1-1
(and
IOC
1-2
, if desired) to the switch/router. The small
green LED on ETH1 should be lit. Connect the
Ethernet cable from the TimeProvider 500 1588
port to a switch/router on the same network. The
small green LED on the upper-right corner of
1588 connector should be lit.
Non-VLAN
Perform the following step:
1. At the TP5000> prompt, type ping <imc
|ioc-1|ioc-2> <ip address:
x.x.x.x> <enter>
Example for TimeProvider 500 IP address
192.168.1.22:
TP5000> ping ioc-1 192.168.1.22
<enter>
Response:
Ping ioc-1 success
VLAN
Perform the following step:
1. At the TP5000> prompt, type ping ioc-1
<vlanid Integer 1 - 4094> <ip
address x.x.x.x> <enter>
Example for a VLAN ID 25:
TP5000> ping ioc-1 25 192.168.1.22
<enter>
Response:
Ping ioc-1 success
To verify which clients are connected to a specific
port (lists clients and their settings and addresses),
perform the following step:
1. At the TP5000> prompt, type show
ptp-client ioc <y>. <y> is the port the
client is pointed to for the grandmaster.
Confirm Network Communication between
TimeProvider 5000 and TimeProvider 500
Connect the Ethernet cable from the
TimeProvider 500 1588 port to the
switch/router. The small green LED on the
upper-right corner of the 1588 connector
should be lit. On the TimeProvider 5000,
connect the Ethernet cable from IOC1-1 to the
switch/router on the same network. The small
green LED on ETH1 should be lit.
Perform the following step:
1. At the TP-500> prompt, type ping
<if0 |if1|if2|if3|if4> <ip
address: x.x.x.x> <enter>
Example for TimeProvider 5000 (GM1) IP
address 192.168.1.15:
TP-500> ping if0 192.168.1.15
<enter>
Response:
Pinging 192.168.1.15
[192.168.1.15]:
Reply from 192.168.1.15: time=0ms
Reply from 192.168.1.15: time=0ms
Reply from 192.168.1.15: time=0ms
Reply from 192.168.1.15: time=0ms
Table B-1. TimeProvider 5000 and 500 Configuration (Continued)
TimeProvider 5000 TimeProvider 500
152 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
TimeProvider 5000 and 500 Configuration Example
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 153
Appendix C Hardware Version 1.0 Units
This appendix provides version 1.0 hardware functional descriptions, part numbers,
specification and factory defaults. Table C-13 alphabetically identifies new
commands for version 2.0 and describes differences in similar commands when
upgrading from version 1.0 to version 2.0 firmware.
In This Appendix
Version 1.0 Component Functional Description
Version 1.0 System and Accessory Part Numbers
Version 1.0 Component Specifications
Version 1.0 Factory Defaults
Version 1.0 Electromagnetic Environment
Version 1.0 Regulatory Requirements
Syntax Changes and Additions Version 1.0 to Version 2.0 Firmware
Parameter Changes and Additions Version 1.0 to Version 2.0 Firmware
Figure C-1. TimeProvider 500 - Version 1.0
154 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 Component Functional Description
Version 1.0 Component Functional Description
Figure C-2 is a front view of the TimeProvider 500. All user connections are on the
panel.
Figure C-2. TimeProvider 500 Front Panel
Power Connector
A Molex-style connector is used to provide 48 volts DC (labeled Power). When the
unit is successfully powered, the PWR LED near the center of this panel will
illuminate green. If the power connection is reversed, the unit will not be damaged, it
simply will not power-up. Startup power will be < 17 watts. Steady-state power
(nominal 25 C) < 9.6 watts.
The TimeProvider 500 uses 48 VDC power and is not equipped with a power
switch. Power to the unit must be controlled by a Branch Circuit Over-Current
Protection Device to the DC power main.
Warning: To avoid serious personal injury or death, exercise caution
when working near high voltage lines and follow local building
electrical codes for grounding the shelf.
Differential
T1/E1 Output
Ports
LEDs
RS232
Serial Port
-48V DC Power
Connector
Coaxial T1/E1 Output
Ports
IEEE -1588 &
Remote
Management
Chassis
Ground
Link and Flow
LED
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 155
Version 1.0 Component Functional Description
RJ48C Connectors
The stack of 2 RJ48C connections labeled SPAN1 and SPAN2 (can use standard
Ethernet cable) provides two separately driven output signals, configurable as either
E1 or T1. These are differential outputs (tip and ring) conforming to signal levels
defined in G.703.
T1/E1 Frequency Output Connectors
TimeProvider 500 provides configurable outputs at either E1 (2.048MHz) or T1
(1.544MHz) frequencies. Specific signal types at each frequency are detailed in the
CLI command, set output signaltype, on page 71. Both outputs must be the same
signal type.
There are two independent, separately driven outputs, labeled SPAN1 and SPAN2.
For differential connection to either output, use the appropriate RJ48C connection
shown in Figure . SPAN1 is the upper connection and SPAN2 is the lower
connection. For single-ended connection to either output, use the BNC connectors
shown in Figure C-4.
Figure C-3. Differential T1/E1 Output Ports
Figure C-4. Single-Ended T1/E1 Output Ports
Note: The RJ48C physical connector is the same as RJ45 (an 8-pin
modular connector). RJ45 is used for Ethernet whereas the term
RJ48C is used for E1/T1 lines. The pinouts for RJ45 and RJ48C are
different. RJ45 (Ethernet) uses pins 1, 2, 3 and 6 whereas RJ48C uses
pins 4 and 5.
156 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 Component Functional Description
LEDs
At the center are four LEDs:
PWR illuminates green when the unit is powered.
SYNC provides high-level status indication.
OUT illuminates green when output is being generated on the SPAN
connections.
ALARM illuminates Red to indicate a CRITICAL or MAJOR active alarm,
AMBER to indicate MINOR alarm. Current alarm status can be checked
using the show alarm command. For more information, see the CLI
command, show alarm, on page 76.
Chassis Ground
Above the LEDs is a connection to chassis ground. A 4mm Grounding Terminal
Stud is located on the TimeProvider 500s front panel. The grounding terminal is
marked with the universal ground symbol.
Note: The outputs from the left BNC and lower RJ48C connection
(both labeled SPAN1) are generated from the same driver circuit,
so for proper signal level only one of those connections should
be used at any one time. The same situation applies to the right
BNC and upper RJ48C, both labeled SPAN2.
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 157
Version 1.0 Component Functional Description
RS232 MGMT Serial Port
The DE9 connector labeled RS232 MGMT provides a local serial connection to
TimeProvider 500. Through this connection, a Command Line Interface (CLI)
provides configuration and status monitoring capability. The RS-232 serial port
connection is made through a DE9S female connector. This port allows you to
connect to a computer using terminal emulation software for remote monitoring and
control. When connecting to this port, use a shielded direct connect cable. See
Establish Serial Communication, on page 40 for default settings.
Figure C-5. Serial Port Male Connector Pins
Table C-1 describes the EIA-232 connector pin assignments for the serial port.
IEEE 1588 Remote Management Port
The RJ-45 connector labeled 1588 is the connection into the network that is
providing the grandmaster clock(s). This same connection is also used for remote
telnet sessions and firmware upgrade capability.
Figure C-6. RJ-45 Connector
Table C-1. Serial Port Connector Pin Assignments
Signal Pin
TXD (Transmitted Data) 2
RXD (Received Data) 3
Ground 5
6
1
9
5
158 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 System and Accessory Part Numbers
Version 1.0 System and Accessory Part Numbers
This section provides part numbers and accessories available for the TimeProvider
500 Version 1.0.
Version 1.0 Component Specifications
This section provides the specifications for the TimeProvider 500 components and
input and output signals.
Mechanical
Table C-2. Component Part Numbers
Item Part Number
TimeProvider 500 IEEE 1588v2 Translator Kit 990-03863-01
Power Connector and Pins (included with part number 990-03863-01) 093-00063-000
TimeProvider 500 19 Rack Mount Kit 093-00090-000
TimeProvider 500 19 Dual Rack Mount Kit 093-00069-000
21 Mounting Adapter Bracket Kit 093-00011-000
23 Mounting Adapter Bracket Kit 093-00012-000
Table C-3. TimeProvider 500 Mechanical Specifications
Parameter Description
Mounting 19 in. / 48 cm Rack
Rack Mounting Position Front mounting location, unit protrudes 0.75 in. / 4.445cm
Width 8.53 in. / 216.7 mm
Height 1.63 in. / 41.4 mm
Depth 8.0 in. / 203.2 mm
Weight 870 g. fully loaded
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 159
Version 1.0 Component Specifications
Environmental
Power
Table C-4. TimeProvider 500 Environmental Specifications
Parameter Description
Operating Temperature -5 to +55 C, 23 to 131 F
Storage Temperature -40 to +70 C, -40 to +158 F
Operating Humidity 5% to 90% RH
Storage Humidity 10% to 100% RH
Table C-5. TimeProvider 500 Power Specifications
Parameter Description
DC Input -48 VDC / -60VDC Nominal 0.20A current @ -48V
Operating range: -40 VDC to -72 VDC
0.280A (warm-up) @ -48V
0.180A (operating) @ -48V
Branch Circuit
Over-Current Protection
Device
1.0 A
DC Power 9.6 W, typical
160 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 Component Specifications
Serial Port
Ethernet Port
Table C-6. Serial Port Specifications
Parameter Description
Connector Type 9-pin, female D connector
Connector Label RS232 MGMT
Interface RS-232, data terminal equipment (DTE)
Baud Rate 57.6 Kbps
Data Bits 8
Parity Bit None
Stop Bits 1
Flow Control None
Timeout Approximately 60 minutes
Table C-7. LAN Port Specifications
Parameter Description
Connector Type RJ-45
Connector Label 1588
Speed 100 Mbps
Interface IEEE 1588v2 and telnet
Timeout Approximately 10 minutes, applies for telnet
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 161
Version 1.0 Component Specifications
T1 Outputs
1.544 MHz Outputs
E1 Outputs
Table C-8. T1 Output Specifications
Parameter Specification
Framing (user selectable) D4/Super Frame (SF)
Extended Super Frame (ESF)
Signal Waveshape Framed, all ones, Alternate Mark Inversion (AMI) per
(ANSI) T1.102 and ITU Rec. G.703
Pulse Amplitude 2.4 to 3.6 volts peak into 100
Termination Impedance 100 5% balanced
Table C-9. 1.544 MHz Specifications
Parameter Specification
Amplitude 1.0 to 1.9 volts peak, 1.5 volts peak nominal into 120
0.8 to 1.5 volts peak, 1.2 volts peak nominal into 75
Wave Shape Square Wave
Termination Impedance 75
Table C-10. E1 Output Specifications
Parameter Specification
Framing (user selectable) CAS, CCS, CAS4, CCS4
Signal Waveshape Framed, all ones, Alternate Mark Inversion (AMI)
Per ITU Rec. G.703 Sec. 9
Pulse Amplitude 2.4 to 3.6 volts peak into 120
1.9 to 2.8 volts peak into 75
Termination Impedance 120 5% balanced; 75 5% unbalanced
162 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 Factory Defaults
2.048 MHz Outputs
Holdover
< 20 microseconds after 24 hours following loss of PTP reference.
Test Conditions:
TimeProvider 500 subjected to 5 C temperature variation throughout test.
TimeProvider 500 referenced to PTP for at least 24 hours prior to the start of holdover.
TimeProvider 500 powered > 5 days prior to the test.
Version 1.0 Factory Defaults
Table C-12 provides general and communication default values.
Table C-11. 2.048 MHz Specifications
Parameter Specification
Amplitude 1.0 to 1.9 volts peak, 1.5 volts peak nominal into 120
0.8 to 1.5 volts peak, 1.2 volts peak nominal into 75
Wave Shape Square Wave
Termination Impedance 75
Table C-12. General and Communication Parameters
Description Default Value Value Range
Acc-Grandmaster IP Address 0.0.0.0 Valid IPv4 Address
Alarm Delay 3 seconds { Alarm Alarm_Num | All } {Enable | Disable }
Alarm State Enabled Enable | Disable
Announce Interval 1 second 1, 2, 4, 8 second(s)
Bridge Time 180 seconds [0, 1, ..., 86400]
Domain 0 0-127
DSCP 0 0-63
EIA-232 Port 57.6k-8-N-1 Fixed
Firewall Allowed for
telnet / ICMP
Allowed | Blocked
Freerun Output ON { ais | on | squelch }
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 163
Version 1.0 Electromagnetic Environment
Version 1.0 Electromagnetic Environment
Categories that may be covered here include: Indirect and direct ESD immunity,
Gateway Address 0.0.0.0 Valid IPv4 Address
Grandmaster IP Address 192.168.1.11 Valid IPv4 Address
HDB3 Enabled Enable | Disable
Holdover Output ON { ais | on | squelch}
IP Address 192.168.1.9 Valid IPv4 address
IP Mode Static DHCP | Static
Note: DHCP is not supported in this release.
Lease Duration 300s 1-3000 second(s)
Network Mask 255.255.255.0 Valid IPv4 Mask
PTP State Enabled Enable | Disable
Signal Type (E1/T1) 2.048 MHz
(e1_2048m)
E1 signal type:
[e1_2048m | e1_cas | e1_cas4 | e1_ccs |
e1_ccs4 | e1_ais]
T1 signal type:
[t1_sf | t1_esf | t1_1544m | t1_iso_pulse]
Sync Rate 64 pkt/second 32, 64, 128 pkt/sec
User Name admin 20 ASCII characters
User Password symmadmin** 32 ASCII characters, a minimum of 8
VLAN Disabled Enable | Disable
VLAN ID 2 [1, ... , 4094]
VLAN Priority 0 [0, 1, ... , 7]
Note: When using the set configuration factory CLI
command, User Name and User Password does not return to the
default value in Table C-12. When using the set configuration
default CLI command, User Name, User Password, IP Mode, IP
Address, Gateway Address, Network Mask, Grandmaster IP Dress,
Acc-Grandmaster IP Address, VLAN, VLAN ID, and VLAN Priority
does not return to the default value in Table C-12.
Table C-12. General and Communication Parameters (Continued)
Description Default Value Value Range
164 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Version 1.0 Regulatory Requirements
Electrical fast transients, radiated immunity, conducted immunity, and surge
protection.
Emissions/Immunity
FCC Pt. 15 Class B
ICES-003 Class B
VCCI Class A
AS/NZS CISPR 22 Class B
ETSI 300 386 Class B
EN 55022/24 Class B
KN 55022/24 KCC Class B
EMC IMMUNITY MEETS CRITERIA A
EN61000-4-2 ESD
EN61000-4-3 RADIATED IMMUNITY
EN61000-4-4 ELECTRICAL FAST TRANCIENT BURST
EN61000-4-5 SURGE
EN61000-4-6 CONDUCTED IMMUNITY
Version 1.0 Regulatory Requirements
Symmetricom is certified with the following safety compliant certificates:
UL
cUL
CB Scheme
GS Mark
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 165
Syntax Changes and Additions Version 1.0 to Version 2.0 Firmware
Syntax Changes and Additions Version 1.0 to Version 2.0
Firmware
The following table describes the version 1.0 CLI commands that are updated or
replaced and also identifies new CLI commands in version 2.0. The order in the
table lists the new commands that have not been replaced or revised followed by
the CLI commands with name changes and syntax changes. Refer to TimeProvider
500 CLI Command Set, on page 81 for CLI command details.
Table C-13. Version 1.0 - 2.0 CLI Commands
Version 1.0 Version 2.0 Description
set alarm-config proxy New for 2.0
set auto-neg New for 2.0
set clock timescale New for 2.0
set clock timezone New for 2.0
set interface New for 2.0
set interface attachments New for 2.0
set ipdv New for 2.0
set output pps-offset New for 2.0
set output pps-mode New for 2.0
set output pps-width New for 2.0
set ptp address New for 2.0
set ptp mgmt New for 2.0
set ptp transport New for 2.0
set tod New for 2.0
set tod format New for 2.0
set tod timescale New for 2.0
set udesc New for 2.0
show announce New for 2.0
show auto-neg New for 2.0
show interface config New for 2.0
show interface status New for 2.0
show status list New for 2.0
166 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Syntax Changes and Additions Version 1.0 to Version 2.0 Firmware
show temperature New for 2.0
show tod New for 2.0
show vlan-config New for 2.0
clear log clear log Syntax unchanged in 2.0
help help Syntax unchanged in 2.0
logout logout Syntax unchanged in 2.0
ping ping Changed for 2.0 to support interface
connection.
reboot reboot system Syntax unchanged in 2.0
set alarm-config delay set alarm-config delay Syntax unchanged in 2.0
set alarm-config level set alarm-config level Syntax unchanged in 2.0
set alarm-config state set alarm-config state Syntax unchanged in 2.0
set bridge-time set bridge-time Default setting and range changed
in 2.0.
set clock set clock time The result will be overwritten if there
is a qualified master clock providing
time
set configuration set configuration Syntax unchanged in 2.0
set eia-232 set eia-232 baud The RS232 MGMT connector baud
rate can be configured in 2.0. the
baud rate was fixed at 57600 in 1.0.
set firewall set firewall Syntax unchanged in 2.0
set ip address set ip Syntax for configuring IP address
information is unchanged, but in 2.0
the IP addressing information is
assigned to an interface connection
(if0,if1,if2,if3, and if4). This is new
for 2.0. See set ip.
set ip-mode set ip-mode Syntax unchanged in 2.0. This
command enables static or DHCP
addressing mode for the interface
connections.
set output freerun set output freerun Syntax unchanged in 2.0
set output hdb3 set output hdb3 Syntax unchanged in 2.0
set output holdover set output holdover Syntax unchanged in 2.0
Table C-13. Version 1.0 - 2.0 CLI Commands (Continued)
Version 1.0 Version 2.0 Description
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 167
Syntax Changes and Additions Version 1.0 to Version 2.0 Firmware
set output signaltype set output Replaced and upgraded. Output
signals E1_2048m and T1_1544
have changed to clk_2048 and
clk_1544. Settings for 1PPS
included for OUT1 and OUT2.
set ptp acc-master set ptp address Acceptable Master (acc-master)
terminology is replaced with GM2
terminology in version 2.0. See set
ptp address, on page 106.
set ptp domain set ptp domain Syntax unchanged in 2.0.
set ptp dscp set ptp dscp Syntax unchanged in 2.0.
set ptp master set ptp address Master terminology is replaced
with GM1 terminology in version
2.0. See set ptp address, on page
106
set ptp state set ptp addr-mode Replaces set ptp state from 1.0 for
multicast in 2.0.
set ptp unicast announce-int set ptp unicast announce-int Syntax unchanged in 2.0.
set ptp unicast lease-int set ptp unicast lease-int Syntax unchanged in 2.0.
set ptp unicast sync-int set ptp unicast sync-int The settable range has changed in
2.0 to 16, 32, 64.
set user set user Syntax unchanged in 2.0
set vlan-config set vlan-config Changed for 2.0 to support
connection interfaces.
set vlan-mode set interface New for 2.0 and replaces 1.0
command and supports connection
interfaces.
show alarm show alarm Syntax unchanged in 2.0
show alarm-config show alarm-config Syntax unchanged. Alarms have
increased from 14-17.
show bridge-time show bridge-time Syntax unchanged in 2.0
show clock show clock Syntax unchanged in 2.0
show eia-232 show eia-232 baud This command shows the current
baud rate.
show firewall show firewall Syntax unchanged in 2.0
show image show image Syntax unchanged in 2.0
Table C-13. Version 1.0 - 2.0 CLI Commands (Continued)
Version 1.0 Version 2.0 Description
168 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Syntax Changes and Additions Version 1.0 to Version 2.0 Firmware
show inventory show inventory Enhanced for 2.0. Shows product
version and user description
settings.
show ip show interface config Changed for 2.0 to support interface
connection. The configured IP
address, subnet mask, and
gateway displays in the list of
interfaces.
show led show led Syntax unchanged. However, the
PWD LED is used for both POWER
A and POWER B.
show log show log Syntax unchanged in 2.0
show output show output Enhanced for 2.0. It includes
configuration status for 2.0 output
capabilities. Output signals
E1_2048m and T1_1544 have
changed to clk_2048 and clk_1544.
show ptp show ptp Changed for 2.0 to support PTP or
general management options.
show status show status Changed and upgraded for 2.0
show vlan-config show interface-config Changed in 2.0 to support
connection interfaces.
upgrade upgrade Syntax unchanged in 2.0
Table C-13. Version 1.0 - 2.0 CLI Commands (Continued)
Version 1.0 Version 2.0 Description
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 169
Parameter Changes and Additions Version 1.0 to Version 2.0 Firmware
Parameter Changes and Additions Version 1.0 to Version
2.0 Firmware
Table C-14 contains a list of the TimeProvider 500 parameters that either change or
are new when upgrading from version 1.0 to version 2.0 firmware. If a parameter is
not listed in Table C-14, then the parameter will retain its value after upgrading to
release 2.0 firmware.
Table C-14. Parameter Changes and Additions v1.0 to v2.0 Firmware
Parameter
Release 1.0
Firmware
After Upgrade from Version 1.0 to
Version 2.0 Firmware
set alarm-config delay Any value 3
set alarm-config level Any value MAJOR, except 15 is EVENT
set alarm-config state Any value Enable
set alarm-config proxy N/A Disable, except for 0,1,3,4,15
set auto-neg N/A True
set bridge-time n n+120, not greater than 86400
set clock timescale N/A UTC
set clock timezone N/A 0
Set interface Non-VLAN address Enable only if0
Make if0 ip addressing the same as
version 1.0
All attachments to if0
VLAN address Enable only if1
Make if1 ip addressing the same as
version 1.0
All attachments to if1
set ipdv interval N/A 1
set ipdv pacing N/A 16
set ipdv threshold N/A 50000
set output out1|2 Any value Both outputs set to version 1.0 output
set output pps-mode N/A Standard
set output pps-offset N/A 2984
set output pps-width N/A 500
set ptp domain 0 127 Range is 0 255
170 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
Parameter Changes and Additions Version 1.0 to Version 2.0 Firmware
set ptp mgmt N/A All enabled
set ptp address node-mgr N/A 0.0.0.0
set ptp transport N/A Ethernet
set tod enable|disable N/A Disable
set tod timescale N/A TAI
set tod format N/A T1
set udesc N/A , empty string
Table C-14. Parameter Changes and Additions v1.0 to v2.0 Firmware (Continued)
Parameter
Release 1.0
Firmware
After Upgrade from Version 1.0 to
Version 2.0 Firmware
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 171
Index
Numerics
1.0 unit 153
factory defaults 162
functional descriptions
chassis ground 156
LEDs 156
power connector 154
RJ48C connector 155
RS232 MGMT serial port 157
T1/E1 frequency output connectors 155
holdover 162
part numbers & accessories 158
specifications
2.048 MHz signals 162
E1 outputs 161
Ethernet port 160
mechanical 158
power 159
RS232 MGMTserial port 160
T1 outputs 161
1.544 MHz signals specifications 137
2.048 MHz signals specifications 138
A
accessories 130
alarms & events 68
C
chassis ground 30
checklist
installation and provisioning 50
clear log command 81
CLI command
set clock interface 89
set clock timescale 86
set eia-232 baud 88
set interface attachments 89
set tod 94
show status-list 120
CLI commands 77
clear log 81
command line format 80
conventions 78
help 81
keyboard usage 79
logout 82
ping 82
reboot system 83
set alarm-config 100
set alarm-config delay 99
set alarm-config level 99
set alarm-config proxy 100
set auto-neg 85
set bridge-time 85
set clock time 86
set clock timescale 86
set clock timezone offscale 87
set configuration 88
set eia-232 baud 88
set firewall 88
set interface 89
set interface attachments 89
set ip 91
set ip-mode 94
set output 103
set output freerun 101
set output hdb3 102
set output holdover 102
set output pps-mode 104
set output pps-offset 104
set output pps-width 105
set ptp address 106
set ptp domain 107
set ptp dscp 108
set ptp mgmt 108
set ptp mode 106
set ptp transport 109
set ptp unicast announce-int 109
set ptp unicast lease-int 110
set ptp unicast sync-int 110
set tod format 95
set tod timescale 95
set udesc 97
set user 96
set vlan-config 97
show alarm 111
show alarm-config 111
show announce 112
show auto-neg 113
show bridge-time 113
show clock 113
show correction 114
show eia-232 114
show firewall 114
show image 116
show interface config 115
show interface status 115
show inventory 116
show led 117
show log 117
show output 118
show ptp 118
show status 119
show temperature 121
show tod 121
upgrade 83
component specifications 133
configuration 33
configuring 33
acceptable grandmaster clock (GM2) 45
apply power 39
confirming network communication 43
confirming PTP flow 46
establishing serial communication 40
frequency outputs 47
IP address 41
Index
DS
172 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009
logging on 40
log on tips 41
setup 38
D
defaults
factory 140
documentation, related 18
E
E1 outputs specifications 138
EIA-232 connector pin assignments 30, 157
electromagnetic compatibility (EMC) 34
electromagnetic environment 141
electrostatic discharge (ESD) 34
environmental specifications 134
Ethernet port specifications 135, 136
F
factory defaults 140
factory defaults - 1.0 unit 162
features
hardware 22
software 22
firmware 126
firmware upgrade
2.0 firmware upgrade 71
version 1.0 to version 2.0
1.0 unit
upgrade to 2.0 firmware 165
flow state 65
flow states 65
frequency locked loop 67
frequency locked-loop state 67
front panel 154
functional description 26
chassis ground 30
IEEE 1588 remote management 31
IEEE 1588 remote management port 31
LEDs 29
power connector 26
RJ48C connectors 27
RS232 MGMT serial port 30
T1/E1 frequency output connectors 27
G
GM2- acceptable grandmaster 74
H
help command 81
holdover specifications 138, 162
I
IEEE 1588 remote management port 31
installation 33
installation checklist 50
installing
grounding the shelf 37
rack mounting 36
site survey 33
unpacking 34
interface connections 55
if0,if1, if2, if3 & if4 56
ptp management devices 55
reviewing interface configurations 58
L
LED
indicator descriptions 125
LEDs 29
log on tips 41
logout command 82
M
maintenance
preventive 123
mechanical specifications 133, 158
multicast support 58
O
operations 53
P
part numbers 130
pin assignments, EIA-232 30, 157
ping command 82
power specifications 134
product overview, TimeProvider 500 21, 33
provisioning checklist 50
PTP commands 106
PTP management overview 54
PTPv2 23
purpose of this guide 15
R
reboot system command 83
regulatory requirements 142
related documentation 18
return material authorization number (RMA) 131
returning
procedure 131
returning unit 130
RJ-45 connector 31
S
safety considerations 124
serial port 30
serial port specifications 135
service
technical assistance 33
set alarm commands 98
set alarm-config command 100
Index
TW
098-00172-000 Revision A December, 2009 TimeProvider 500 2.0 Users Guide 173
set alarm-config delay command 99
set alarm-config level 99
set alarm-config proxy 100
set auto-neg command 85
set bridge-time command 85
set clock time command 86
set clock timescale command 86
set clock timezone offscale command 87
set configuration command 88
set eia-232 baud 88
set eia-232 baud command 88
set firewall command 88
set interface attachments command 89
set interface command 89
set ip command 91
set ip-mode command 94
set output command 103
set output commands 101
set output freerun command 101
set output hdb3 command 102
set output holdover command 102
set output pps-mode command 104
set output pps-offset command 104
set output pps-width 105
set ptp address command 106
set PTP commands 106
set ptp domain command 107
set ptp dscp command 108
set ptp mgmt command 108
set ptp mode command 106
set ptp transport command 109
set ptp unicast announce-int command 109
set ptp unicast lease-int command 110
set ptp unicast sync-int command 110
set timescale command 86
set tod command 94
set tod format command 95
set tod timescale command 95
set udesc command 97
set user command 96
set vlan-config command 97
setting date 70
setting time 70
show alarm command 111
show alarm-config command 111
show announce command 112
show auto-neg command 113
show bridge-time command 113
show clock command 113
show commands 111
show correction command 114
show eia-232 command 114
show firewall command 114
show image command 116
show interface config command 115
show interface status command 115
show inventory command 116
show led command 117
show log command 117
show output command 118
show ptp command 118
show status command 119
show status example 63
show status-list command 120
show temperature command 121
show tod command 121
site survey 33
specifications
1.544 MHz signals 137
2.048 MHz signals 138
E1 outputs 138
electromagnetic environment 141
electromagnetic environment - unit 1.0 163
environmental 134
Ethernet port 135, 136
factory defaults 140
holdover 138, 162
mechanical 133, 158
power 134
regulatory requirements 142
regulatory requirements - 1.0 units 164
serial port 135
T1 outputs 136
structure of this guide 15
Symmetricom Global Services (SGS) 33
T
T1 outputs specifications 136
technical assistance 33
time setting 62
timecode formats 143
NMEA format 143
T1 format 144
TimeProvider 500 hardware version 1.0 153
TimeProvider 500 logs 70
configuration log 70
event log 70
TimeProvider 5000/500 configuration 147
tools and equipment 34
U
Unit 1.0
specifications
1.544 MHz signals 161
environmental 159
unit 1.0
component functional descriptions 154
IEEE 1588 remote management port 157
component specifications 158
electromagnetic environment 163
regulatory requirements 164
upgrade command 83
user sessions 71
logon UserID 71
password 71
W
web address 18
Index
WW
174 TimeProvider 500 2.0 Users Guide 098-00172-000 Revision A December, 2009