Page 1
TimeProvider 1000 and 1100
Edge Clock
TL1 Reference Guide
Revision E – September 2006
Part Number 097-58001-01
Page 2
Symmetricom, Inc.
2300 Orchard Parkway
San Jose, CA 95131-1017
U.S.A.
http://www.symmetricom.com
Copyright © 2005-2006 Symmetricom, Inc.
All rights reserved. Printed in U.S.A.
All product names, service marks, trademarks, and registered trademarks
used in this document are the property of their respective owners.
Page 3
Table of Contents
Contents
How to Use This Guide
Purpose of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Who Should Read This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Structure of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Conventions Used in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Warnings, Cautions, Recommendations, and Notes . . . . . . . . . . . . . . . . . . . . . . . . . .10
Related Documents and Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Where to Find Answers to Product and Document Questions. . . . . . . . . . . . . . . . . . . 11
What’s New In This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Chapter 1 TL1 Overview
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
TL1 Command Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Command Code Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Staging Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Payload Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Error Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
In-Process Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Command Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Chapter 2 TL1 Command Syntax and Description
TL1 Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Activate Feature (ACT-FEATURE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Activate Software Download Mode (ACT-SWDL). . . . . . . . . . . . . . . . . . . . . . . . 28
The Firmware Download Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Activate User (ACT-USER). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Cancel User (CANC-USER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Copy Memory (CPY-MEM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Delete Performance Monitoring Data (DLT-PM-DATA) . . . . . . . . . . . . . . . . . . . 38
Delete Security (DLT-SECU). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Delete User Security (DLT-USER-SECU). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Edit Circuit Identifier (ED-CKTID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Edit Command Security (ED-CMD-SECU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Edit Date (ED-DAT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Edit Equipment (ED-EQPT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
ED-EQPT for NTP Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 3
Page 4
Table of Contents
Edit Password (ED-PID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Edit Sync (ED-SYNC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Edit User Security (ED-USER-SECU). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Enter Password (ENT-PID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Enter User Security (ENT-USER-SECU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Initialize Event Log (INIT-LOG). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Initialize System (INIT-SYS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Operate Alarm Cutoff (OPR-ACO-ALL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Ping (PING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Remove Equipment (RMV-EQPT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Retrieve Alarm Condition (RTRV-ALM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Retrieve Attribute (RTRV-ATTR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Retrieve BesTime Status (RTRV-BESTIME-STAT) . . . . . . . . . . . . . . . . . . . . . . 79
Retrieve Built-In Self Test (RTRV-BIST). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
Retrieve Circuit Identification (RTRV-CKTID) . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Retrieve Command Security (RTRV-CMD-SECU) . . . . . . . . . . . . . . . . . . . . . . . 85
Retrieve Condition (RTRV-COND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Retrieve Craft Data (RTRV-CRAFT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Retrieve Date (RTRV-DAT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Retrieve Equipment (RTRV-EQPT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Retrieve GPS Status (RTRV-GPS-STAT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Retrieve Header (RTRV-HDR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Retrieve Inventory (RTRV-INV). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Retrieve LED Status (RTRV-LED) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Retrieve Log (RTRV-LOG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Retrieve Network Equipment Type (RTRV-NETYPE). . . . . . . . . . . . . . . . . . . . 113
Retrieve NTP Information (RTRV-NTP-PEER). . . . . . . . . . . . . . . . . . . . . . . . . 114
Retrieve PM (RTRV-PM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Retrieve Sync (RTRV-SYNC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
Retrieve System Mode (RTRV-SYS-MODE) . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Retrieve Threshold (RTRV-TH). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Retrieve User (RTRV-USER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Retrieve User Security (RTRV-USER-SECU). . . . . . . . . . . . . . . . . . . . . . . . . . 129
Set Attribute (SET-ATTR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Set Source Identifier (SET-SID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Set System Mode (SET-SYS-MODE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Set Threshold (SET-TH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Appendix A TL1 Command by Function
Appendix B Alarms
Appendix C Events
Index
4 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 5
Table of Contents
Tables
1-1 Normal Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
1-2 Error Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1-3 Error Codes Returned in Error Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
1-4 In-Process Response Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
1-5 Autonomous Message Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
1-6 TimeProvider TL1 Command Types and Access Levels . . . . . . . . . . . . . . . . . . . . 22
2-1 TL1 Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
2-2 ED-DAT – Keywords and Values for <aid>=SYS. . . . . . . . . . . . . . . . . . . . . . . . . . 41
2-3 ED-CMD-SECU – Keyword and Values for <cid>=text string. . . . . . . . . . . . . . . . . 42
2-4 ED-DAT – Keywords and Values for <aid>=SYS. . . . . . . . . . . . . . . . . . . . . . . . . . 44
2-5 ED-EQPT – Keywords and Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2-6 ED-SYNC – Keywords and Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
2-7 ED-USER-SECU – Keyword and Values for <uid>=text string . . . . . . . . . . . . . . . 62
2-8 INIT-SYS Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2-9 RTRV-ALM Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
2-10 RTRV-ATTR – Keywords and Values for all <aids> . . . . . . . . . . . . . . . . . . . . . . . . 77
2-11 RTRV-ATTR Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
2-12 RTRV-BESTIME-STAT Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
2-13 Retrieve Built-In Self Test Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
2-14 RTRV-CMD-SECU Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
2-15 RTRV-COND Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2-16 RTRV-CRAFT Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93
2-17 RTRV-DAT Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
2-18 RTRV-EQPT Output Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
2-19 RTRV-GPS-STAT Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
2-20 RTRV-INV Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
2-21 RTRV-LED Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
2-22 RTRV-LOG – Keywords for all <aids> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2-23 RTRV-LOG Event Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2-24 RTRV-LOG Alarm Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
2-25 RTRV-NTP-PEER Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
2-26 RTRV-PM – Keywords for all <aids> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
2-27 RTRV-PM Keyword Modifier Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
2-28 RTRV-PM Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2-29 RTRV-SYNC Output Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
2-30 RTRV-TH – Output Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
2-31 RTRV-USER-SECU Output Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
2-32 SET-ATTR – Keywords and Values for all <aids> . . . . . . . . . . . . . . . . . . . . . . . . 132
2-33 SET-SID – Keyword and Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
2-34 SET-SYS-MODE – Keyword and Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
2-35 SET-TH – Keywords and Values for all <aids>. . . . . . . . . . . . . . . . . . . . . . . . . . . 136
2-36 Mask Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
A-1 Security and Administrative Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
A-2 System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
A-3 Performance Monitoring Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 5
Page 6
Table of Contents
B-1 Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
B-2 Alarm Code Condition Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
C-1 Event Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
C-2 Event Code Condition Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
6 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 7
How to Use This Guide
This section describes the format, layout, and purpose of this guide.
In This Preface
Purpose of This Guide
Who Should Read This Guide
Structure of This Guide
Conventions Used in This Guide
Warnings, Cautions, Recommendations, and Notes
Related Documents and Information
Where to Find Answers to Product and Document Questions
What’s New In This Guide
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 7
Page 8
How to Use This Guide
Purpose of This Guide
Purpose of This Guide
The TimeProvider TL1 Reference Guide provides information on TL1 command
conventions and parameters. It covers command types, formats, and responses. It
provides an explanation of the command function and a description of each
command parameter, value, and variable when applicable. It also describes
keywords used during provisioning and provides a troubleshooting guide.
Who Should Read This Guide
This guide is a command reference intended for engineers and telecommunications
professionals who provision and manage the TimeProvider Node Clock. Chapter 1,
TL1 Overview is for those who need a basic understanding of the Transaction
Language 1 (TL1) protocol and how it is implemented in the TimeProvider.
Chapter 2, TL1 Command Syntax and Description describes TimeProvider TL1
commands in detail (commands are listed in alphabetical order). Append ix A, TL1
Command by Function is a list of commands grouped by task (security and
administration, system performance, and performance monitoring). Appendix B,
Alarms and Appendix C, Events provide a list of alarms and events along with a
description of the cause of the event.
Structure of This Guide
This guide contains the following sections:
Chapter, Title Description
Chapter 1, TL1 Overview Provides a basic overview of the Transaction Language 1 (TL 1)
used by the TimeProvider.
Chapter 2, TL1 Command
Syntax and Description
Appendix A, TL1 Command
by Function
Appendix B, Alarms Provides a list of all alarms and a description of their cause.
Appendix C, Events Provides a list of all events and a description of their cause.
Index Provides references to individual topics within this guide.
Describes each of the TimeProvider’s TL1 commands in detail.
Provides task-oriented lists of security and administrative
commands, system commands, and performance monitoring
commands.
8 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 9
Conventions Used in This Guide
This guide uses the following conventions:
Acronyms and Abbreviations – T erms are spelled out the first time they appear
in text. Thereafter, only the acronym or abbreviation is used.
Revision Control – The title page lists the printing date and versions of the
product this guide describes.
Typographical Conventions – This guide uses the typographical conventions
described in the table below.
Conventions Used in This Guide
How to Use This Guide
When text appears
this way...
TimeProvider TL1 Reference
The title of a document.
... it means:
Guide
CRITICAL
An operating mode, alarm state, status, or chassis label.
PORT-A
J1
Select File, Open... Click the Open option on the File menu.
Press
Press
Enter.
Print Scrn.
A named keyboard key.
The key name is shown as it appears on the keyboard.
An explanation of the key’s acronym or function
immediately follows the first reference to the key, if
required.
TimeProvider
Username:
ENGINE TDATA
STATUS
Text in a source file or a system prompt or other text that
appears on a screen.
A command you enter at a system prompt or text you
enter in response to a program prompt. You must enter
commands for case-sensitiv e operating systems exactly
as shown.
A re-timing application A word or term being emphasized.
Symmetricom does not
A word or term given special emphasis.
recommend...
Structure of This Guide, on
page 8
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 9
The blue text, when viewed in a pdf file, indicates a
hyperlink to the indicated text.
Page 10
How to Use This Guide
Warnings, Cautions, Recommendations, and Notes
Warnings, Cautions, Recommendations, and Notes
Warnings, Cautions, Recommendations, and Notes attract attention to essential or
critical information in this guide. The types of information included in each are
explained in the following examples.
Warning: To avoid serious personal injury or death, do not
disregard warnings. All warnings use this symbol. Warnings are
installation, operation, or maintenance procedures, practices, or
statements, that if not strictly observed, may result in serious
personal injury or even death.
Caution: To avoid personal injury, do not disregard cautions. All
cautions use this symbol. Cautions are installation, operation, or
maintenance procedures, practices, conditions, or statements, that
if not strictly observed, may result in damage to, or destruction of,
the equipment. Cautions are also used to indi cat e a lon g- te rm
health hazard.
ESD Caution: To avoid personal injury and electrostatic discharge
(ESD) damage to equipment, do not disregard ESD cautions. All
ESD cautions use this symbol. ESD cautions are installation,
operation, or maintenance procedures, practices, conditions, or
statements that if not strictly observed, may result in possible
personal injury , electrostatic discharge damage to, or destruction of,
static sensitive components of the equipment.
Electrical Shock Caution: To avoid electrical shock and possible
personal injury, do not disregard electrical shock cautions. All
electrical shock cautions use this symbol. Electrical shock cautions
are practices, procedures, or statements, that if not strictly
observed, may result in possible personal injury, electr ical shock
damage to, or destruction of components of the equipment.
Recommendation: All recommendations use this symbol.
Recommendations indicate manufacturer-tested methods or known
functionality. Recommendations contain installation, operation, or
maintenance procedures, practices, conditions, or statements, that
provide important information for optimum performance results.
Note: All notes use this symbol. Notes contain installation,
operation, or maintenance procedures, practices, conditions, or
statements, that alert you to importa nt information, which may
make your task easier or increase your understanding.
10 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 11
Related Documents and Information
Other helpful documents are listed below. See your Symmetricom representative or
sales office for a complete list of available documentation.
TimeProvider Node Clock User’s Guide, part number 097-58001-02
Software Release Notice, part number 097-58001-20 or 097-58001-21
TimePictra management software – See the User’s manual provided on the
system CD
SynCraft management software – Help files within the application
Note: Symmetricom offers a number of applicable training courses
designed to enhance product usability. Contact your local
representative or sales office for a complete list of courses and
outlines.
Related Documents and Information
How to Use This Guide
Where to Find Answers to Product and Document Questions
For additional information about the products described in this guide, please cont act
your Symmetricom representative or your local sales office. You can also contact us
on the web at www.symmetricom.com.
What’s New In This Guide
Revision E of this guide contains new information for the following commands.
The RTMLBO keyword is not valid for the E1 Retimer module, as described in
Table 2-6.
Clarified the description of the command Remove Equipment (RMV-EQPT), on
page 71.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 11
Page 12
How to Use This Guide
What’s New In This Guide
12 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 13
Chapter 1 TL1 Overview
This chapter provides a basic overview of the Transaction Language 1 (TL1) used
by the TimeProvider.
In This Chapter
Overview
TL1 Command Structure
Responses
Autonomous Messages
Command Security
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 13
Page 14
Chapter 1 TL1 Overview
Overview
Overview
Transaction Language 1 (TL1) is the most widely used management language in
the telecommunications industry. TL1 provides a standardized set of
vendor-independent, ASCII-based instructions that can be used to manage network
elements (NEs) and their resources. The TimeProvider uses TL1 as its
human-to-machine command line interface (CLI).
Note: For a complete description of the TL1 syntax, refer to Telcordia
(Bellcore) General Requirements GR-831 and GR-833.
The remainder of this chapter explains the TL1 command language and how it
applies to the TimeProvider.
TL1 Command Structure
The TL1 commands used in the TimeProvider consist of the following three main
parts, or blocks:
The Command Code Block
The Staging Block
The Payload Block
These three main blocks are separated by a colon ( : ) block separator character
and the command is terminated by a semicolon ( ; ) terminating character. The
semicolon indicates that the command statement is completed and the command is
then executed.
Figure 1-1 shows the typical structure of a TL1 command, and the paragraphs that
follow further explain the elements that constitute each of the main blocks.
Block
Separator
Terminating
Character
cid:tid:aid:ctag::payload;
Command
Code
Block
Figure 1-1. Typical TL1 Command Structure
14 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Staging
Block
Payload
Block
Page 15
Chapter 1 TL1 Overview
TL1 Command Structure
Command Code Block
The Command Code Block uniquely identifies the command and identifies the
action to be taken. It consists of a verb and one or more modifiers, sep arated by the
dash character ( - ).
ED-DAT, for instance, is the command code block used in the TimeProvider’s “Edit
Date” TL1 command. ED is the verb and DAT is the modifier indicating that the
command will edit a date object.
Staging Block
The St aging Block is comprised of the following blocks, each separated by the block
separator character.
The Target Identifier (tid) – The tid identifies the specific TimeProvider unit to
which the command applies. The position of the tid is mandatory within the
command string, but it is usually optional sense its value can be null. If it is used
in the command, it must match the Source Identifier (sid) that is set within the unit
or the unit will not respond to the command. If the command is not directly sent to
the unit, as when the command is routed to the unit via a Gateway NE (called
indirect routing), a non-null tid is required.
The Access Identifier (aid) – The aid uniquely identifies the entity within the
associated target unit. In the TL1 syntax descriptions provided in Chapter 2 of
this manual, the <aid> syntax tag is used specifically to denote modules, inputs,
outputs, or ports. Other more specific syntax tags are used to denote types of
entities, such as <uid> a user identifier, or <cid> a command identifier. The
position of the aid block within the command string always occurs between the
second and third block separator character.
The Correlation Tag (ctag) – The ctag is used to correlate commands and
responses. It can be any alphanumeric string up to six ch aracters in length. In the
TimeProvider, use of the ctag is not mandatory, but is strongly recommended. If
the value for the ctag is null in the command string, the unit returns a zero ( 0 ) as
the ctag in responses.
The General Block – In the TimeProvider the General Block is not used so its
value should always be null. If the General Block is the last block in the command
syntax, it, and the remaining block separator characters can be omitted from the
command string.
Payload Block
The Payload Block contains the parameters associated with the command’s
operation. In the TimeProvider’s command syntax, the Payload Block can take on
either of the following two forms, depending on the command:
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 15
Page 16
Chapter 1 TL1 Overview
Responses
Position-Defined – In a position-defined payload block, the parameters that
make up the block are implied by their position within the block. The individual
parameters are separated by the comma character ( , ). If the value of a given
parameter is null, its position within the block still must be maintained by using
adjacent commas ( ,, ). Refer to Copy Memory (CPY-MEM), on page 36 for an
example of a command that uses a position-defined payload block.
Name-Defined – In a name-defined payload block, the parameters that make up
the block take on the form <keyword>=<value>. The <keyword> identifies the
parameter, and <value> is that parameter’s value. Keywords are not
case-sensitive. Refer to Edit Equipment (ED-EQPT), on page 45 for an example
of a command that uses a name-defined payload block.
Responses
When the TimeProvider receives and processes a command, it returns one of the
following types of responses:
Normal Response
Error Response
In-Process Response
The following paragraphs explain these response types.
Normal Response
The TimeProvider sends a Normal response when it receives and can properly
process a TL1 command. The format of a Normal response is as follows. Note that
M and COMPLD identify the response as a Normal response:
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
textblk<cr><lf>
textblk<cr><lf>
.
.
LG_textblk<cr><lf>
;
Note: The textblk and LG_textblk fields are only returned with the
Normal response when the command requires such a message be
returned.
Table 1-1 explains each field that is contained in the Normal response.
16 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 17
Chapter 1 TL1 Overview
Table 1-1. Normal Response Fields
Field Description
sid The unit’s Source Identifier (SID), which identifies the specific TimeProvider unit
within the synchronization network. The unit’s SID is set using the SET-SID TL1
command.
date The date of the response, in the format YY-MM-DD, where YY is the 2-digit yea r, MM
is the 2-digit representation of the month, and DD is the day of the month.
time The time of the response, in the format HH:MM:SS, wher e HH is the hour in 24-hour
format, MM is the minutes, and SS is the seconds.
ctag The correlation tag that was sent as part of the TL1 command string. If the value for
the ctag is null in the command string, the unit returns a zero ( 0 ) as the ctag in the
response.
textblk A double-quoted message containing less than 4 kBytes of information that the unit
returns in response to the command.
LG_textblk If the unit responds with a message containing more than 4 kBytes of information, the
message is divided into records of approximately 4 kBytes, each ending with
COMPLD<cr><lf>. The last record ends with <cr><lf>;.
Responses
Error Response
The TimeProvider sends an Error response when a command is mis-typed, an
invalid command is issued, or some other operator error is performed. The format of
an Error response is as follows. Note that M and DENY identify the response as an
Error response:
<cr><lf><lf>
sid date time<cr><lf>
M ctag DENY<cr><lf>
errcde<cr><lf>
;
Table 1-2 explains each field that is contained in the Error response.
Table 1-2. Error Response Fields
Field Description
sid The unit’s Source Identifier (SID), which identifies the specific TimeProvider unit
within the synchronization network. The unit’s SID is set using the SET-SID TL1
command.
date The date of the response, in the format YY-MM-DD, where YY is the 2-digit yea r, MM
is the 2-digit representation of the month, and DD is the day of the month.
time The time of the response, in the format HH:MM:SS, where HH is the hour in 24-hour
format, MM is the minutes, and SS is the seconds.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 17
Page 18
Chapter 1 TL1 Overview
Responses
Table 1-2. Error Response Fields (Continued)
Field Description
ctag The correlation tag that was sent as part of the TL1 command string. If the value for
the ctag is null in the command string, the unit returns a zero ( 0 ) as the ctag in the
response.
errcde
The error code, which identifies the condition that caused the Error response to be
returned. See
Table 1-3
for a description of each error code.
Table 1-3 describes each error code that might be returned in an Error response.
Table 1-3. Error Codes Returned in Error Responses
Error
Code
IBEX Extra Block in Command
IBMS Missing Block in Command
ICNV Command Not Valid (invalid TL1 syntax)
IIAC Invalid AID Code
IICM Invalid Command (invalid command or command
with insufficient security clearance)
IICT Invalid CTAG
IITA Invalid Target Identifier
IPEX Extra Parameter
Meaning
IPMS Parameter Missing
IPNV Parameter Not Valid
ISCH Invalid Character, syntax
ISPC Invalid Punctuation, syntax
SDBE Database Error
SDNR Data Not Ready
SRAC Requested Access Configuration Not Valid
SROF Requested Operation Failed
SROU Requested Operation Unnecessary
SWFA Working Unit Failed
18 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 19
In-Process Response
If the TimeProvider cannot send a Normal response or a n Error response within two
seconds of receipt of a command, it sends an In-Process response. The format of
an In-Process response is as follows. Note that IP identifies the response as an
In-Process response:
<cr><lf><lf>
sid date time<cr><lf>
IP ctag<cr><lf>
<
When the TimeProvider finishes processing the original command, the In-Process
response is followed with either a Normal or Error response, as is appropriate. Table
1-4 provides a description of each field contained in the In-Process response.
Table 1-4. In-Process Response Fields
Field Description
Chapter 1 TL1 Overview
Autonomous Messages
sid The unit’s Source Identifier (SID), which identifies the specific TimeProvider unit
within the synchronization network. The unit’s SID is set using the SET-SID TL1
command.
date The date of the response, in the format YY-MM-DD, where YY is the 2-digit yea r, MM
is the 2-digit representation of the month, and DD is the day of the month.
time The time of the response, in the format HH:MM:SS, where HH is the hour in 24-hour
format, MM is the minutes, and SS is the seconds.
ctag The correlation tag that was sent as part of the TL1 command string. If the value for
the ctag is null in the command string, the unit returns a zero ( 0 ) as the ctag in the
response.
Autonomous Messages
In addition to the TL1 responses described above, the TimeProvider might return
Autonomous Messages to report alarms, configuration changes, or condition
changes. Frequently, an Autonomous Message is returned at approximately the
same time as the TL1 response that is associated with a command, because the
command happens to cause a change in the unit’s state. Autonomous Messages
are not directly correlated with commands and they do not contain correlation tags
(ctags). They should, however, have an <atag>, which increments by one (from 1 to
999999) for each autonomous event.
Note: By default, Autonomous Messages are displayed in the user’s
session. The display of Autonomous Messages can be enabled or
disabled using the ED-EQPT TL1 command with the AOMERGE
keyword.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 19
Page 20
Chapter 1 TL1 Overview
Autonomous Messages
Autonomous Messages can be generated by the unit at any time, whether to report
that a user-initiated change has occurred to some setting within the unit, to report
that an active alarm condition has cleared, etc. The format of an Autonomous
Message is as follows. Note that REPT identifies the response as an Autonomous
Message: EVT for an event and ALM for an alarm.
Event Response Format:
<cr><lf><lf>
sid date time<cr><lf>
alrmcde atag REPT EVT [AIDTYPE]<cr><lf>
”aid,aidtype:condtype,condeff,ocrdat,ocrtim,,,,:condscr”<cr lf>
;
Alarm Response Format:
<cr><lf><lf>
sid date time<cr><lf>
alrmcde atag REPT ALM [AIDTYPE]<cr><lf>
”aid,aidtype:ntfcncde,condtype,srveff,ocrdat,ocrtim,,:condscr”<cr lf>
;
Table 1-5 explains each field that is contained in an Autonomous Message.
Table 1-5. Autonomous Message Fields
Field Description
sid The unit’s Source Identifier (SID), which identifies the specific TimeProvider unit within
the synchronization network. The unit’s SID is set using the SET-SID TL1 command.
date The date of the message, in the format YY-MM-DD, where YY is the 2-digit year, MM is
the 2-digit representation of the month, and DD is the day of the month.
time The time of the message, in the format HH:MM:SS, where HH is the hour in 24-hour
format, MM is the minutes, and SS is the seconds.
almcde The alarm code, which can be one of the following:
*C - The event being reported is a Critical alarm
** - The event being reported is a Major alarm
* - The event being reported is a Minor alarm
A - The event being reported is a Non-alarm Event
atag The Autonomous Message tag, which is a number up to six digits long that increments
by one each time an event is generated. It wraps back to 1 after reaching 999999.
reptype The type of report. It can be either EVT (the event is a non-alarm event), or ALM (the
event is an alarm event).
aid The access identifier, which denotes the system component that the repo rted alarm or
event applies to.
20 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 21
Table 1-5. Autonomous Message Fields (Continued)
Field Description
Chapter 1 TL1 Overview
Command Security
aidtype
ntfcncde The notification code for the alarm or event. The notification code can be CR (a critical
condtype The condition type, which is the TL1 code that is associated with the alarm or event.
condeff
srveff Whether the alarm or event is service affecting (SA) or non-service affecting (NSA).
ocrdat The date the alarm or event occurred, in the format YY-MM-DD.
ocrtim The time that the alarm or event occurred, in the format HH:MM:SS.
condscr The condition string, which is a description of the alarm or event. It is a quoted text
The aid type. It can be EQPT (the aid is associated with the internal operation of the
system) or T1 (the aid is external to the system or facility; for example, an input or output).
Note: The aidtype that follows the reptype in the Autonomous Messag e is included only
if the reptype is ALM.
alarm), MJ (a major alarm), MN (a minor alarm), CL (a clear ed alarm), or NA (a no n-alarm
event).
Table C-2 shows all of the possible TimeProvider event condition types, and Table B-2
shows all of the possible TimeProvider alarm condition types.
This defines an event’s effect on the system: CL indicates clearing of a standing condition,
SC
indicates a standing condition is raised, and TC indicates a transition of a condition.
Note: All events listed in Table C-2 set CONDEFF to TC. If alarms listed in Table B-2 are
provisioned as Not Alarmed (NA), CONDEFF is set to SC when the alarm becomes
active and CL when the alarm becomes inactive.
string, preceded with the “\” escape character. Table C-2 shows all of the possible
TimeProvider event condition strings, and Table B-2 shows all of the possible
TimeProvider alarm and clearing alarm condition strings.
Table B-2 shows all of the possible alarm condition types (condtypes) and alarm
condition strings (condscrs) that might be returned by the TimeProvider in an
Autonomous Message.
Table C-2 shows all of the possible event condition types (condtypes) and event
condition strings (condscrs) that might be returned by the TimeProvider in an
Autonomous Message.
Command Security
To protect system resources and information from unauthorized access, the
TimeProvider implements the concept of access levels for commands.
When security is enabled on the TimeProvider, most of the unit’s TL1 commands
require that users be logged into the system in order to access them. Each user in
the system has a user access level assigned to them, and it is their user access
level that determines which commands they can use.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 21
Page 22
Chapter 1 TL1 Overview
Command Security
Each of the TimeProvider’s TL1 commands have one of the following four access
levels assigned to them by default:
NONE – When a given command is assigned an access level of NONE, anyone
with access to the unit’s Serial or Ethernet ports can execute the command. A
user doesn’t even have to be logged into the system to use commands that have
an assigned access level of NONE.
USER – When a given command is assigned USER access level, any valid
system user having a user access level of either USER, ADMIN, or SECURITY
can execute the command after logging into the system.
Caution: Security is initially not enabled on the TimeProvider. With
security not enabled, anyone can execute any of the unit’s TL1
commands, severely compromising the integrity of the system.
Security is activated as soon as an initial user is entered into the
system with a user access level of SECURITY. Symmetricom strongly
recommends that an initial Security-level user be defined in the system
as soon as the system is installed. Refer to the TimeProvider User
Guide (097-58001-02) for information on defining the first user.
ADMIN – When a given command is assigned ADMIN access level, any valid
system user having a user access level of either ADMIN or SECURITY can
execute the command after logging into the system.
SECURITY – When a given command is assigned SECURITY access level, only
valid system users having a user access level of SECURITY can execute the
command after logging into the system.
Note: The factory default access level can be changed for most of th e
TimeProvider TL1 commands, however, the access level for the
following commands is fixed and cannot be changed: ACT-USER,
CANC-USER, ED-CMD-SECU, ED-USER-SECU, and
ENT-USER-SECU.
Table 1-6 lists each of the TimeProvider’s TL1 commands in alphabetical order . The
command type and default (factory set) access level is included in Table 1-6 for
each command.
Table 1-6. TimeProvider TL1 Command Types and Access Levels
Command Name Command Type
Factory-Set
Access Level
ACT-FEATURE Administrative ADMIN
ACT-SWDL Administrative ADMIN
ACT-USER Session NONE
CANC-USER Session USER
22 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 23
Table 1-6. TimeProvider TL1 Command Types and Access Levels (Continued)
Chapter 1 TL1 Overview
Command Security
Command Name Command Type
Factory-Set
Access Level
CPY-MEM System ADMIN
DLT-PM-DATA Administrative USER
DLT-SECU Administrative SECURITY
DLT-USER-SECU Administrative SECURITY
ED-CKTID System USER
ED-CMD-SECU Administrative ADMIN
ED-DAT System ADMIN
ED-EQPT System ADMIN
ED-PID Administrative USER
ED-SYNC System ADMIN
ED-USER-SECU Administrative SECURITY
ENT-PID Administrative SECURITY
ENT-USER-SECU Administrative SECURITY
INIT-LOG System ADMIN
INIT-SYS System ADMIN
OPR-ACO-ALL System USER
PING Session USER
RMV-EQPT System USER
RTRV-ALM System USER
RTRV-ATTR System USER
RTRV-BESTIME-STAT Administrative USER
RTRV-BIST System USER
RTRV-CKTID System USER
RTRV-CMD-SECU Administrative ADMIN
RTRV-COND System USER
RTRV-CRAFT System USER
RTRV-DAT System USER
RTRV-EQPT System USER
RTRV-GPS-STAT System USER
RTRV-HDR System NONE
RTRV-INV System USER
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 23
Page 24
Chapter 1 TL1 Overview
Command Security
Table 1-6. TimeProvider TL1 Command Types and Access Levels (Continued)
Command Name Command Type
Factory-Set
Access Level
RTRV-LED System USER
RTRV-LOG Administrative USER
RTRV-NETYPE System NONE
RTRV-NTP-PEER System U SER
RTRV-PM System USER
RTRV-SYNC System USER
RTRV-SYS-MODE System USER
RTRV-TH System USER
RTRV-USER Session USER
RTRV-USER-SECU Administrative SECURITY
SET-ATTR System ADMIN
SET-SID System ADMIN
SET-SYS-MODE System ADMIN
SET-TH System ADMIN
24 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 25
Chapter 2 TL1 Command Syntax and Description
This chapter describes each of the TimeProvider’s TL1 commands in detail.
In This Chapter
TL1 Syntax Conventions
Command Descriptions
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 25
Page 26
Chapter 2 TL1 Command Syntax and Description
TL1 Syntax Conventions
Table 2-1 describes the syntax used for commands and responses in this manual.
Table 2-1. TL1 Syntax Conventions
Symbol Description
<cr> Carriage return character (ASCII 0x0D).
<lf> Line-feed character (ASCII 0x0A).
[ ... ] Indicates the command parameter or data is optional.
< ... > Indicates a variable. The variable’s value is actually sent in the command
or returned in the response.
( ... ) Indicates numeric data that can be either positive or negative.
In addition, the following general rules apply to the TL1 syntax and command entry:
Adjacent colons indicate unused fields. If an unused field is the last parameter in
the command string, for example the General Block or Parameter Block is the
last block and is unused, you can omit the colons and simply enter the semicolon
terminating character to execute the command.
The TimeProvider ignores extra spaces in the TL1 command line.
TL1 commands are not case sensitive unless specified as such.
Command Descriptions
The TL1 commands that are included in the TimeProvider’s command set comprise
the remainder of this chapter. An entry is included for each command, and the
entries are organized in alphabetical order by verb-modifier command code. Each
command entry is comprised of the following parts:
A descriptive title for the command entry, followed by the command’s
verb-modifier command code enclosed in parentheses.
A brief description of the command, and the command’s default access level.
The command syntax, which is followed by the parameters and keywords that
can be used with the command.
Further explanation follows the parameters, keywords, and values where
necessary.
An example of how to use the command completes each command entry.
26 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 27
Chapter 2 TL1 Command Syntax and Description
Activate Feature (ACT-FEATURE)
Activate Feature (ACT-FEATURE)
This command enables the specified feature in the TimeProvider. Once the feature
has been enabled, it cannot be disabled.
This command has a default access level of ADMIN.
Syntax
ACT-FEATURE:[<tid>]:<fid>:[<ctag>]::<key>;
Parameter Value Description
<fid> NTP The name of the feature to be activated.
<key> The key to enable the feature. This can be up to 20
case-sensitive characters, and must be enclosed in quotes.
Contact your Symmetricom representative to obtain the key.
Example
To activate the NTP feature using the Symmetricom-supplied <key> parameter:
Input
ACT-FEATURE::NTP:TP1000::"Symmetricom-Key";
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10,13:35:56
A 2528 REPT EVT
"IMC,EQPT:FEATURE,TC,05-02-10,13-35-56,,,,:\"SYSTEM FEATURE HAS BEEN
ACTIVATED, NTP\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 27
Page 28
Chapter 2 TL1 Command Syntax and Description
Activate Software Download Mode (ACT-SWDL)
Activate Software Download Mode (ACT-SWDL)
This command places the information management card (IMC) in the firmware
download mode prior to a firmware download. IOC or IMC firmware can be
transferred from a users system to the TimeProvider using the Ymodem protocol,
and the command also allows firmware transfers directly from a specified IOC
module to a redundant IOC module.
This command has a default access level of ADMIN.
Syntax
ACT-SWDL:[<tid>]:<aid>:[<ctag>];
Parameter Value Description
<aid> IMC The Information Management Card (IMC) is placed in firmware
download mode to download firmware to the IMC module using
the Ymodem file receiver.
IOC The Information Management Card (IMC) is placed in firmware
download mode to download firmware to the Input/Output Card
(IOC) module using the Ymodem file receiver.
Note: In systems that have redundant IOC modules, both IOC
modules should be operating with the same version of firmware.
The system automatically ensures that both IOC modules
receive the same version of firmware.
IOCm The Information Management Card (IMC) is placed in firmware
download mode to download firmware to the Input/Output Card
(IOC) module and does not use the Ymodem file receiver.
If a new IOC is installed into a system (or if one IOC card has a
previous version of firmware), the active IOC can be used to
transfer its version of firmware to the target IOC.
m = “1” for the module marked “IOC 1" on the main shelf.
m = “2” for the module marked “IOC 2" on the main shelf.
28 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 29
The Firmware Download Process
Caution: To avoid a possible service call, do not issue any additional
TL1 commands to the TimeProvider, do not remove power from the
TimeProvider, and do not remove an IOC or IMC from the shelf
the firmware upgrade process (minimum 30 minutes). Doing so
corrupt the flash memory in a card, disabling the TimeProvider.
When the IMC module is in firmware download mode, most
commands are not executable because all users are logged off the
system; however, commands with an access level of NONE are
executable. Furthermore, if security is not enabled, for example no
users are assigned, any command is executable.
Notes:
Firmware upgrade files are periodically available from Symmetricom.
Contact Symmetricom customer support for informatio n on firmware
upgrades that are available for the TimeProvider.
Refer to the TimeProvider User’s Guide (097-58001-02) for more
complete firmware upgrade information.
Chapter 2 TL1 Command Syntax and Description
The Firmware Download Process
during
could
The ACT-SWDL command places either the IMC or IOC module (depending on the
specified AID) in the firmware download mode so that firmware upgrades can be
downloaded to the modules. If IOCm (m = 1 or 2) is the specified AID, firmware is
transferred from the specified IOC to the redundant IOC.
Note: Firmware transfer between IOCs is not allowed if the
destination IOC is active.
Firmware download to the IMC or IOC module
When the TimeProvider receives the ACT-SWDL command for either the IMC or
IOC module, it automatically logs all users off of the system and locks the system
against new logins. The system then disconnects TL1 from the connection that sent
the ACT-SWDL command and starts the TimeProvider’s internal Ymodem file
receiver on that connection.
Note: The Ymodem file receiver is not used in IOC-to-IOC firmware
transfers.
A Ymodem file sender utility, for example SynCraft or HyperTerminal, is required for
firmware downloads and it is this file sen der utility that initiate s the file transfe r. If the
file transfer is not initiated by a Ymodem file sender within approximately 60 seconds
of the ACT-SW DL co mman d being sent, the unit returns an error response and the
module returns to normal operation. If the file transfer is initiated within 60 seconds,
the transfer of the file to the module takes place.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 29
Page 30
Chapter 2 TL1 Command Syntax and Description
The Firmware Download Process
After the file transfer completes, the IMC module validates the file (the system
remains locked against logins at this point). If the file is not validated, the unit
returns an error response and the IMC module returns to normal operation.
If the file is validated, the next step depends on which module is receiving the
upgrade.
If the upgrade file applies to the IMC module
If the upgrade file that was downloaded is valid and is for the IMC module, the flash
memory on the IMC module is reprogrammed and the IMC module is rebooted
using the new firmware.
The system outputs are not interrupted when the IMC module is upgraded. If the
process fails at any time, the upgrade process aborts and the IMC module returns to
normal operation using the existing version of firmware.
If the upgrade file applies to the IOC modules
If the upgrade file that was downloaded is valid and is for the IOC modules, the
system checks the following criteria to determine how to proceed with the upgrade
process:
It checks if the shelf contains two installed and communicating IOC modules
It checks if both IOC control loops are locked
It checks if both IOC modules are in service
It checks if both IOC modules are alarm free
It checks if one of the IOC modules is active
If the system determines that any of the above criteria are false, it reprograms the
IOC1 module’s flash memory and reboots the module, then reprograms the IOC2
module’s flash memory and reboots that module. If the shelf contains only one IOC
module, that module’s flash memory is reprogrammed and the module is rebooted.
In these cases, the system outputs are interrupted for up to 30 minutes until the
upgraded IOC module enters Fast-Locked mode.
If the system determines that all of the above criteria are true, then the system
places the active IOC module in Standby mode, and the IOC module that was in
St andby mode is placed into Active mode. The system then reprograms the st andby
IOC module’s flash memory and reboots it. After the module reboots, the system
waits up to 30 minutes for its control loop to lock. After its control loop locks, the
system places it in Active mode and places the other IOC module in S t andby mode.
The system then reprograms the standby IOC module’s flash memory and reboots
it. In this case, the system outputs are not interrupted.
If at any time the above process fails for either IOC module, for example, if an IOC
module fails to transition from Standby to Active mode, the upgrade process aborts
and the IOC modules return to normal operation using the existing versions of
firmware.
30 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 31
Chapter 2 TL1 Command Syntax and Description
The Firmware Download Process
Firmware Transfer between two IOC modules
When the TimeProvider receives the ACT-SWDL command, it automatically logs all
users off of the system and locks the system against new logins. If the firmware
upgrade is an IOC to IOC transfer, and if the target IOC is not active, firmware is
transferred to the target IOC. The system remains locked against logins at this
point. The target IOC reboots after transfer is complete. If the transfer cannot be
completed, the unit returns an error response and the IMC module returns to normal
operation.
Note: The Ymodem file receiver is not used in IOC-to-IOC firmware
transfers.
Example 1
In this example, the ACT-SWDL command is issued to download a firmware file to
the IMC module, but the firmware download is not initiated within 60 seconds.
Notice the Progress Indicator that follows the in-process response. The unit returns
a string of “C’s” (
<CCCCCCCCCC), one “C” after approximately every second of wait
time, to indicate that the IMC module is waiting for an external Ymodem file sender
to initiate the download process:
Input
ACT-SWDL::IMC:TP1000;
Response Example
TP-SSU 05-03-09 14:07:45
A 395 REPT EVT
"IMC,EQPT:FWLOAD,TC,05-03-09,14-07-45,,,,:\"BEGINNING FIRMWARE UPGRADE\""
;CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCIP TP1000
<
TP-SSU 05-03-09 14:09:03
M TP1000 DENY
SROF
;
TP-SSU 05-03-09 14:09:03
A 397 REPT EVT
"IMC,EQPT:FWFAIL,TC,05-03-09,14-09-02,,,,:\"FIRMWARE UPGRADE UNSUCCESSFUL\""
;
Example 2
In this example, the ACT-SWDL command is issued to download a firmware file to
the IMC module, and the download and upgrade is successful:
Input
ACT-SWDL::IMC:TP1000;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 31
Page 32
Chapter 2 TL1 Command Syntax and Description
The Firmware Download Process
Response Example
TP-SSU 05-03-09 14:11:20
A 400 REPT EVT
"IMC,EQPT:FWLOAD,TC,05-03-09,14-11-20,,,,:\"BEGINNING FIRMWARE UPGRADE\""
;CCCCCCCCCCCCCIP TP1000
<
TP-SSU 05-03-09 14:19:59
M
TP1000
;
TP-SSU 05-03-09 14:19:57
A 401 REPT EVT
"IMC,EQPT:FWOK,TC,05-03-09,14-19-57,,,,:\"FIRMWARE UPGRADE SUCCESSFUL\""
;
COMPLD
Example 3
In this example, the system has redundant IOCs (IOC1 and IOC2) and the
ACT-SWDL command is issued to down load firmware to the modules (AID is IOC2).
IOC2 is active and IOC1 is in standby mode. After the file downloads, IOC1
becomes active and locked and IOC2 goes into standby to receive the firmware file.
The download and upgrade is successful for both modules:
Note: Some events in the following example were removed for space
considerations.
Input
ACT-SWDL::IOC:TP1000;
Response Example
TP-SSU 05-03-09 20:34:03
A 447 REPT EVT
"IOC,EQPT:FWLOAD,TC,05-03-09,20-34-03,,,,:\"BEGINNING FIRMWARE UPGRADE\""
;CCCIP 0
<
TP-SSU 05-03-09 20:36:06
A 448 REPT EVT
"IOC2,EQPT:IOCMODE,TC,05-03-09,20-36-06,,,,:\"IOC MODE IS, STANDBY\""
;
TP-SSU 05-03-09 20:36:07
A 449 REPT EVT
"IOC1,EQPT:IOCMODE,TC,05-03-09,20-36-07,,,,:\"IOC MODE IS, ACTIVE\""
;
TP-SSU 05-03-09 20:39:26
A 450 REPT EVT
"IOC2,EQPT:RESET,TC,05-03-09,20-39-26,,,,:\"MODULE HAS BEEN RESET\""
;
TP-SSU 05-03-09 21:02:45
A 461 REPT EVT
"IOC2,EQPT:CLKLOCK,TC,05-03-09,21-02-45,,,,:\"CLOCK ENTERED LOCK MODE\""
;
32 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 33
Chapter 2 TL1 Command Syntax and Description
TP-SSU 05-03-09 21:02:49
A 462 REPT EVT
"IOC2,EQPT:IOCMODE,TC,05-03-09,21-02-49,,,,:\"IOC MODE IS, ACTIVE\""
;
TP-SSU 05-03-09 21:02:49
A 463 REPT EVT
"IOC1,EQPT:IOCMODE,TC,05-03-09,21-02-49,,,,:\"IOC MODE IS, STANDBY\""
;
TP-SSU 05-03-09 21:06:06
A 464 REPT EVT
"IOC,EQPT:FWOK,TC,05-03-09,21-06-06,,,,:\"FIRMWARE UPGRADE SUCCESSFUL\""
;
TP-SSU 05-03-09 21:06:08
M 0 COMPLD
;
TP-SSU 05-03-09 21:06:11
A 465 REPT EVT
"IOC1,EQPT:RESET,TC,05-03-09,21-06-10,,,,:\"MODULE HAS BEEN RESET\""
;
The Firmware Download Process
Example 4
In this example, the ACT-SWDL command is issued to transfer a firmware file to the
IOC1 module from the IOC2 module and the download and upgrade is successful:
Input
ACT-SWDL::IOC1:TP1000;
Response Example
ACT-SWDL::IOC1:TP1000;
TP-SSU 05-03-09 14:36:09
A 15 REPT EVT
"IOC,EQPT:FWLOAD,TC,05-03-09,14-36-09,,,,:\"BEGINNING FIRMWARE UPGRADE\""
;IP TP1000
<
TP-SSU 05-03-09 14:39:35
A 16 REPT EVT
"IOC1,EQPT:RESET,TC,05-03-09,14-39-34,,,,:\"MODULE HAS BEEN RESET\""
;
TP-SSU 05-03-09 14:39:37
A 18 REPT EVT
"IOC,EQPT:FWOK,TC,05-03-09,14-39-37,,,,:\"FIRMWARE UPGRADE SUCCESSFUL\""
;
TP-SSU 05-03-09 14:39:38
M TP1000 COMPLD
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 33
Page 34
Chapter 2 TL1 Command Syntax and Description
Activate User (ACT-USER)
Activate User (ACT-USER)
This command logs the specified existing user onto the system, and begins a user
session. Each session is independent, allowing a user to have multiple sessions
with no interaction among sessions (requested data is delivered to the proper
session). If a user has a current session active, that user can log in using another
user name, which transfers the current session to the new user name. The system
records the log-in event, but does not record a log-out event for the previous use r. If
no users are defined in the system, then the user has access at the Security level.
This command has a default access level of NONE. This command’s access level
cannot be changed.
Syntax
ACT-USER:[<tid>]:<uid>:[<ctag>]::<pid>;
Parameter Value Description
<uid> text string The user name assigned to the user logging on.
<pid> text string The password assigned to the user logging on.
Note: Refer to <newpid>, on page 63 for valid password
specifications.
The maximum number of sessions is ten.
Note: A Security-level user initially sets up the user list by using the
Enter User Security (ENT-USER-SECU) command. Users log in
using the ACT-USER command, specifying the user name and
password that have been assigned by a Security-level user.
Example
To log user "FRED" into the TimeProvider system with the password "FRED.1":
Input
ACT-USER::FRED:TP1000::FRED.1;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10,13:35:56
A 2528 REPT EVT
"IMC,EQPT:LOGIN,TC,05-02-10,13-35-56,,,,:\"USER LOGGED IN, FRED\""
;
34 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 35
Chapter 2 TL1 Command Syntax and Description
Cancel User (CANC-USER)
Cancel User (CANC-USER)
This command terminates the specified user’s session, and logs the user out of the
system.
This command has a default access level of USER. This command’s access level
cannot be changed.
Syntax
CANC-USER:[<tid>]:[<uid>]:[<ctag>];
Parameter Value Description
<uid> text string The user name assigned to the user whose session is
being terminated.
Note: Users at the Admin or Security level can terminate
the active sessions of other users. In such cases, this
parameter must be specified. Including the <uid> in the
command line is not necessary for users to log themselves
out of their own user session.
(null) The owner’s current user session is terminated.
Example
To terminate the current session for user "FRED":
Input
CANC-USER::FRED:TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2529 REPT EVT
"IMC,EQPT:LOGOUT,TC,05-02-10,13-35-56,,,,:\"USER LOGGED OUT, FRED\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 35
Page 36
Chapter 2 TL1 Command Syntax and Description
Copy Memory (CPY-MEM)
Copy Memory (CPY-MEM)
This command saves a module’s Istate (instrument state) in another module’s
memory. IOC Istate is saved in IMC FLASH and IMC Istate is saved in IOC RAM.
This command has a default access level of ADMIN.
Syntax
CPY-MEM:[<tid>]::[<ctag>]::<fromdev>,<todev>,<istate>;
Parameter Value Description
<fromdev> IOC The specified Istate is copied from the IOC card.
IMC The specified Istate is copied from the IMC card.
<todev> IOC The specified Istate is copied to the IOC card.
IMC The specified Istate is copied to the IMC card.
<istate> IOC The IOC Istate is copied.
IMC The IMC Istate is copied.
Note: In order to from a valid command line, the <fromdev> and
<todev> parameter values cannot be the same.
The IState
The Istate is a “provisioning configuration file” for the module, and a copy of the
Istate from each of the IOC and IMC modules can be stored on each of the other
modules.
Use the CPY-MEM command to copy IStates in the following cases:
The IMC Module is Replaced – In this case, before you remove the IMC module,
copy the IMC Istate to the active IOC module. Replace the IMC module, then
copy the IMC Istate back to the replacement IMC module to provision it with the
settings of the IMC module it replaced.
Note: When the IMC Istate is copied from an IOC module to the IMC
module, all users are logged out of the system. This happens
because the IMC Istate can contain a different user list than the user
list in effect before the Istate transfer.
Additionally, other settings can change, including communications
parameters, baud rate, and IP address.
36 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 37
Chapter 2 TL1 Command Syntax and Description
Copy Memory (CPY-MEM)
Caution: If an IMC Istate is copied from an IOC module to the IMC
module and that IState contains a different user list, ensure that the
<uids> and <pids> are known to avoid being locked out of the
system.
The IOC Module is Replaced in a Single-IOC System – In this case, copying the
IOC Istate to the IMC module, replacing the IOC module, then copying the IOC
Istate back to the replacement IOC module effectively provisions the
replacement IOC module with the settings of the IOC module it replaced.
Both IOC Modules are Replaced Concurrently – In this case, copying the IOC
Istate from the active IOC module to the IMC module, replacing both IOC
modules, then copying the IOC Istate back to the replacement IOC modules
effectively provisions the replacement IOC modules with the settings of the IOC
modules they replaced.
Notes:
IOC modules are capable of transferring their Istates to each other
automatically. When both IOC modules are to be replaced, it might
desirable to allow this transfer to occur automatically:
Replace the IOC module that is in standby mode.
Allow the replacement IOC module to reboot and qualify the
reference inputs. This provides enough time for the Istate of the
active IOC module to automatically transfer to the replacement IOC
module.
Force the replacement card to the active state.
Replace the other IOC module. The Istate transfers automatically to
that module.
Example
To copy the IMC Istate from the IMC module to the active IOC module, as a prelude
to replacing the IMC module:
Input
CPY-MEM:::TP1000::IMC,IOC,IMC;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 314 REPT EVT
"IMC,EQPT:XFEROK,TC,05-02-10,13-35-56,,,,:\"CONFIGURATION TRANSFER
SUCCESSFUL\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 37
Page 38
Chapter 2 TL1 Command Syntax and Description
Delete Performance Monitoring Data (DLT-PM-DATA)
Delete Performance Monitoring Data (DLT-PM-DATA)
This command deletes the current set of performance monitoring dat a for one inp ut
channel. All Performance Data associated with the specified input is erased.
This command has a default access level of USER.
Syntax
DLT-PM-DATA:[<tid>]:[<aid>]:[<ctag>];
aid Description
IOC[m]-GPS GPS input on either of the two IOC modules (m = 1 or 2).
IOC[m]-PRS PRS input on either of the two IOC modules (m = 1 or 2).
IOC[m]-INP[p] Input 1 or Input 2 on either of the two IOC modules
(m = 1 or 2 and p = 1 or 2).
Example
To delete all performance data associated with the specified module:
Input
DLT-PM-DATA:::TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
38 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 39
Chapter 2 TL1 Command Syntax and Description
Delete Security (DLT-SECU)
Delete Security (DLT-SECU)
This command deletes all of the information from the user database.
This command has a default access level of SECURITY.
Syntax
DLT-SECU:[<tid>]::[<ctag>];
Note: The DLT-SECU command is typically used only after the initial
installation of the T imeProvider. When issued, all existing user names
and passwords are deleted from the user database. Anyone who logs
in to the TimeProvider in this condition has access to all commands.
Example
To delete all information from the user database, which includes three entries in this
example:
Input
DLT-SECU:::TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
Field Description
USRCLR All users have been deleted from the database.
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:57
A 266 REPT EVT
"IMC,EQPT:USRDEL,TC,05-02-10,13-35-57,,,,:\"USER HAS BEEN DELETED\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 39
Page 40
Chapter 2 TL1 Command Syntax and Description
Delete User Security (DLT-USER-SECU)
Delete User Security (DLT-USER-SECU)
This command allows a security-level user to delete any user in the user list.
Note: The system does not allow the last security-level user to be
deleted if other users are defined in the system.
This command has a default access level of SECURITY.
Syntax
DLT-USER-SECU:[<tid>]:<uid>:[<ctag>];
Parameter Value Description
<uid> text string The user name assigned to the user being deleted.
Example
To delete user "FRED" from the system:
Input
DLT-USER-SECU::FRED:TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2533 REPT EVT
"IMC,EQPT:USRDEL,TC,05-02-10,13-35-56,,,,:\"USER HAS BEEN DELETED\""
;
40 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 41
Chapter 2 TL1 Command Syntax and Description
Edit Circuit Identifier (ED-CKTID)
Edit Circuit Identifier (ED-CKTID)
This command edits the name of the equipment connected to the input or the output
of the TimeProvider.
This command has a default access level of ADMIN. This command’s access level
cannot be changed.
Syntax
ED-CKTID:[<tid>]::[<ctag>]::”<value>”;
Parameter Value Description
<aid> GPS, PRS, INP1, INP2,
OUTg[-p]
(g = A|B|C|D, p = 1 to 16),
RTMg[-p]
(g = A|B|C|D, p = 1|2),
E422g[-p]
(g = A|B|C|D, p = 1 to 8)
Table 2-2. ED-DAT – Keywords and Values for <aid>=SYS
<keyword> <value> Description Default
CKTIDCHG up to 40
characters
A valid CKTID is up to 40 characters, and must be
enclosed in quotes.
The command’s effect is on the specified input
or output.
Note:
See
Table 2-2
<value> descriptions.
for <keyword> and
N/A
Example
To change the circuit ID on INP1 to ABC123:
Input
ED-CKTID::INP1:TP1000::”ABC123”;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2535 REPT EVT
"SYS,EQPT:CKTIDCHG,TC,05-02-10,13-35-56,,,,:\"INPUT CIRCUIT ID HAS CHANGED, ABC123
13-35-56\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 41
Page 42
Chapter 2 TL1 Command Syntax and Description
Edit Command Security (ED-CMD-SECU)
Edit Command Security (ED-CMD-SECU)
This command changes the access level of the specified command.
Note: The access level for the following commands is fixed and
cannot be changed: ACT-USER, CANC-USER, ED-CMD-SECU,
ED-USER-SECU, and ENT-USER-SECU.
This command has a default access level of ADMIN. This command’s access level
cannot be changed.
Syntax
ED-CMD-SECU:[<tid>]:<cid>:[<ctag>][::<keyword>=<value>];
Parameter Value Description
<cid> text string The identifier of the command for which the access level is
being changed. The command identifier is the part of the
command syntax that appears before the first colon
( : ). It is not case-sensitive.
Note:
See
Table 2-3
for <keyword> and <value> descriptions.
FACTORY The access levels for all commands are set to their factory-
defined values.
Note: If FACTORY is used, no keyword is required and is
ignored if used.
Table 2-3. ED-CMD-SECU – Keyword and Values for <cid>=text string
<keyword> <value> Description Default
ACCLVL NONE The specified command allows any user to use it, even if
the user is not currently logged on to the system.
USER The specified command allows users with an access level
of USER, ADMIN, and SECURITY to use it.
ADMIN The specified command allows users with an access level
of ADMIN and SECURITY to use it.
SECURITY The specified command allows users with an access level
of SECURITY to use it.
N/A
42 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 43
Chapter 2 TL1 Command Syntax and Description
Edit Command Security (ED-CMD-SECU)
Example
To change the access level of the Retrieve Log (RTRV-LOG) command to ADMIN:
Input
ED-CMD-SECU::RTRV-LOG:TP1000::ACCLVL=ADMIN;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 3:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2534 REPT EVT
"IMC,EQPT:ACCLVL,TC,05-02-10,13-35-56,,,,:\"USER ACCESS LEVEL HAS
CHANGED, RTRV-LOG\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 43
Page 44
Chapter 2 TL1 Command Syntax and Description
Edit Date (ED-DAT)
Edit Date (ED-DAT)
This command changes the system date and time. If the date and time is set by
GPS, the date and time cannot be changed. The local time offset can always be
changed even after the time is changed by GPS.
This command has a default access level of ADMIN.
Syntax
ED-DAT:[<tid>]:[<aid>]:[<ctag>]::<keyword>=<value>;
Parameter Value Description
<aid> SYS The command’s effect is at the system level.
Note:
See
Table 2-4
Table 2-4. ED-DAT – Keywords and Values for <aid>=SYS
for <keyword> and <value> descriptions.
<keyword> <value> Description Default
DATCHG yy-mm-dd The year, month, and day set for the system:
yy = the 2-digit year, mm = the 2-digit representation of
the month, dd = the day of the month
TIMCHG hh-mm-ss The hours, minutes, and seconds set for the system:
hh = hour, in 24-hour format, mm = minutes, ss = seconds
LOCTIM
±
hh-mm
The hours and minutes that local time is offset from UTC:
hh = the local time’s hour offset from UTC;
mm = the local time’s minute offset from UTC
±12 hours,
N/A
N/A
N/A
Example
To change the system time to 1:56:00 PM:
Input
ED-DAT::SYS:TP1000::TIMCHG=13-35-56;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2535 REPT EVT
"SYS,EQPT:TIMCHG,TC,05-02-10,13-35-56,,,,:\"SYSTEM TIME HAS CHANGED,
13-35-56\""
;
44 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 45
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Edit Equipment (ED-EQPT)
This command is used to provision equipment parameters. To provision NTP
parameters, see ED-EQPT for NTP Parameters, on page 51.
This command has a default access level of ADMIN.
Syntax
ED-EQPT:[<tid>]:<aid>:[<ctag>]::<keyword>[=<value>];
Parameter Value
See
Table 2-5
for <keyword> and <value> descriptions.
Description
<aid> SYS The command’s effect is at the system level.
COMp The command’s effect is on the communication port
specified by p:
p = “L” for the local serial port
p = “R” for the remote serial port
p = “I” for the IP (Ethernet) port
IOCm The command’s effe ct is on the IOC module specified by m:
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
GPS The command’s effect is on the GPS input.
PRS The command’s effect is on the PRS input.
INPp The command’s effect is on the input port specified by p:
p = “1” for the input marked INP 1 on the Input Connector
module
p = “2” for the input marked INP 2 on the Input Connector
module
OUTg The command’s effect is on the output group specified by g:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
RTMg[-p] The command’s effect is on the Retimer group and port
specified by g[-p]:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
p = “1” for Port 1 on the Retimer module
p = “2” for Port 2 on the Retimer module
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 45
Page 46
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Parameter Value
<aid>
E422g The command’s effect is on the EIA-422 output group
cont’d
See
Table 2-5
for <keyword> and <value> descriptions.
specified by g:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Description
Table 2-5. ED-EQPT – Keywords and Values
<keyword> <value> Description Default
<aid> = SYS
INACTTIME 100 –
10000
The amount of user command inactivity time to be set.
This determines the amount of inactivity time before the
0
user is automatically logged off of the system.
The range for time is 100 to 10000 in increments of 0.1
seconds. A value of 0 disables automatic logoff.
LOGECHO ENABLE Login and logout events are echoed to the local terminal
ENABLE
and stored in the event log.
DISABLE Login and logout events are not echoed to the local
terminal and are not stored in the event log.
<aid> = COML | COMR | COMI
AOMERGE ENABLE Autonomous messages are displayed in the current
ENABLE
session.
DISABLE Autonomous messages are not displayed in the current
session.
ECHO ENABLE Input is echoed to the local terminal. DISABLE
DISABLE Input is not echoed to the local terminal.
TIDQUIET ENABLE The TID is not echoed in response messages. DISABLE
DISABLE The TID is echoed in response messages.
46 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 47
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Table 2-5. ED-EQPT – Keywords and Values (Continued)
<keyword> <value> Description Default
<aid> = COML | COMR only
BAUD 2400 The specified serial port’s baud rate is set to 2400 baud. 9600
9600 The specified serial port’s baud rate is set to 9600 baud.
19200 The specified serial port’s baud rate is set to 19200 baud.
28800 The specified serial port’s baud rate is set to 28800 baud.
38400 The specified serial port’s baud rate is set to 38400 baud.
57600 The specified serial port’s baud rate is set to 57600 baud.
FLOW NONE No flow control is set on the port. NONE
SW Software flow control (XON/XOFF) is set on the specified
port.
HW Hardware flow control (CTS/RTS) is set on the specified
port.
SWHW Both software and hardware flow control is set on the
specified port.
<aid> = COMI only
Note: For valid IP address ranges, refer to RFC1466 and RFC3330.
Note: To avoid unexpected interruptions in NTP service, you must restart the IMC card after you
change either the Subnet Mask or the IP Address when NTP is active.
IPGATE IP dot
notation
IPADDR IP dot
notation
IPSUBNET IP dot
notation
IPHOST (1, 2, 3,
The IP address of the default gateway.
The range is 1.0.0.1 to 254.255.255.254
The IP address of the Network Element.
The range is 1.0.0.1 to 254.255.255.254
The subnet mask.
The range is 1.0.0.1 to 255.255.255.254
Reserved for future use.
127.0.0.1
127.0.0.1
255.255.
255.0
4)
<aid> = IOCm
IOCMODE
ACTIVE The specified IOC card is forced to the active state. The
ACTIVE
other IOC card is set to the standby state.
ST ANDBY
The specified IOC card is forced to the standby state. The
other IOC card is set to the active state.
Note: If only one IOC card is installed, the
IOCMODE=STANDBY setting is ignored.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 47
Page 48
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Table 2-5. ED-EQPT – Keywords and Values (Continued)
<keyword> <value> Description Default
CLKTYPE
ST2 /
TYPEII
Rubidium
ST3E /
TYPEI
Quartz
IOCSTATE INSRV
OOSRV
The assumed SSM quality level for the Rubidium IOC
card’s clock is set to either ANSI stratum 2 traceable
TYPEI /
TYPEII
(ST2) or ETSI Type 2 (TYPEII) traceable. This value is
used for placing SSM bits in the output stream when in
Holdover mode. Any input to the unit that is of lesser
quality than ST2 / TYPEII is not used as a reference.
Note: ST2 and TYPEII can only be provisioned on the
Rubidium IOC card; they cannot be provisioned on the
Quartz IOC card.
The assumed SSM quality level for the Quartz IOC card’s
clock is set to either ETSI Type 1 (TYPEI) or ANSI
(ST3E). This value is used for placing SSM bits in the
output stream when in Holdover mode. Any input to the
unit that is of lesser quality than TYPEI / ST3E is not used
as a reference.
Note: ST3E and TYPEI can only be provisioned on the
Quartz IOC card; they cannot be provisioned on the
Rubidium IOC card.
The IOC card is placed into service. INSRV
The IOC card is taken out of service.
Note: A module that was taken out of service is not
selectable by the system to generate outputs or monitor
inputs, and no alarms are generated by the module.
<aid> = GPS
INSTATE ENABLE The specified input is enabled. DISABLE
DISABLE The specified input is disabled.
MONITOR
The specified input is in monitor-only mode.
Note: In monitor-only mode, the performance of the input
is monitored and it is monitored for signal faults, but
cannot be selected as a system reference.
MODE AUTO The antenna position (latitude, longitude, and height) is
AUTO
automatically computed or re-computed and then set.
MANUAL The user sets the antenna position (latitude, longitude,
and elevation) using the POS keyword.
POS
Note: The
position can
only be set
LAT dd-mm-ss.ssN or dd-mm-ss.ssS N/A
LONG dd-mm-ss.ssE or dd-mm-ss.ssW
ELEV ±hhhh.h elevation (altitude) in meters
when MODE =
Manual.
ELEVMASK 5° to 45° The specified elevation mask. 10°
48 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 49
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Table 2-5. ED-EQPT – Keywords and Values (Continued)
<keyword> <value> Description Default
<aid> = PRS
INSTATE ENABLE The specified input is enabled. DISABLE
DISABLE The specified input is disabled.
MONITOR
The specified input is in monitor-only mode.
Note: In monitor-only mode, the input is monitored for
signal faults and the performance of the input is
monitored, but the input cannot be selected as a system
reference or used as a BesTime backup reference.
<aid> = INPp
INSTATE ENABLE The specified input is enabled. ENABLE
DISABLE The specified input is disabled.
MONITOR The specified input is in monitor-only mode.
Note: In monitor-only mode, the input is monitored for
signal faults and the performance of the input is
monitored, but the input cannot be selected as a system
reference or used as a BesTime backup reference.
<aid> = OUTg
OUTSTATE ENABLE The specified output group is enabled. DISABLE
DISABLE The specified output group is disabled.
<aid> = E422g
OUTSTATE ENABLE The specified EIA-422 output group is enabled. DISABLE
DISABLE The specified EIA-422 output group is disabled.
<aid> = RTMg[-p]
RTMSTATE ENABLE The specified Retimer group is enabled. ENABLE
DISABLE The specified Retimer output group is disabled.
SLIPCLR NA Clears a current Slip alarm from the specified port. NA
Note: See Edit Sync (ED-SYNC), on page 55 for more provisioning
parameters.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 49
Page 50
Chapter 2 TL1 Command Syntax and Description
Edit Equipment (ED-EQPT)
Example
To enable Output Group B:
Input
ED-EQPT::OUTB:TP1000::OUTSTATE=ENABLE;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2537 REPT EVT
"OUTB,EQPT:OUTSTATE,TC,05-02-10,13-35-56,,,,:\"OUTPUT GROUP STATE HAS
CHANGED, ENABLED\""
;
05-02-10 13:35:56
50 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 51
Chapter 2 TL1 Command Syntax and Description
ED-EQPT for NTP Parameters
ED-EQPT for NTP Parameters
There are two sets of ED-EQPT commands to set up the NTP option on the
TimeProvider:
Peer Server
Authentication
These commands have a default access level of ADMIN.
Configuring the Peer Server
When you set the <func> value to ADD or MODIFY, you must include the <keyid>,
<minpoll>, <maxpoll> and <preferred> values.
Syntax
ED-EQPT:[<tid>]:NTP:[<ctag>]::SERVER,<func>,<serverIP>[,<keyid>,
<minpoll>,<maxpoll>,<preferred>];
<keyword> <value> Description Default
FUNC ADD | DELETE |
MODIFY
SERVERIP 1.0.0.1 –
254.255. 255.254
KEYID 1 to 65534 The Authentication identification value 0
MINPOLL 16 | 32 | 64 | 128 |
256 | 512 | 1024
MAXPOLL 16 | 32 | 64 | 128 |
256 | 512 | 1024
PREFERRED YES | NO Sets the server to be the Preferred server. NO
The SERVERIP address to be added, deleted,
or modified.
The NTP IP Mask
Note: If you change this parameter while NTP
is functioning, you must restart the IMC card
(using the INIT-SYS command) to use the new
address.
The minimum amount of time, in seconds,
between Server time requests.
The maximum amount of time, in seconds,
between Server time requests.
NA
0.0.0.0
16
1024
Example
This command adds the server mask of 192.168.10.1, set s t he Auth enticatio n ID to
1, the max poll to 64, the min poll to 1024, and the preferred to No.
Input
ED-EQPT::NTP:TP1000::SERVER,ADD,192.168.10.1,1,64,1024,NO;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 51
Page 52
Chapter 2 TL1 Command Syntax and Description
ED-EQPT for NTP Parameters
Normal Response
TP-SSU 03-05-15 10-04-32
A 1166 REPT EVT
“NTP,EQPT:SERVER,TC,
CHANGED,192.168.10.1,0,16,1024,NO”
03-05-15 10-04-32,,,,:\NTP SERVER CONFIGURATION HAS
;
Enabling NTP Authentication
This command enables or disables the use of the KeyID/Key pairs.
Syntax
ED-EQPT:[<tid>]:NTP:[<ctag>]::AUTHEN=<value>;
<keyword> <value> Description Default
AUTHEN ENABLE | DISABLE Enable or disable NTP Authentication DISABLE
Example
To enable NTP authentication:
Input
ED-EQPT::NTP:TP1000::AUTHEN=ENABLE;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2537 REPT EVT
"NTP,EQPT:SERVER,TC,05-02-10,13-35-56,,,,:\"NTP AUTHENTICATION=ENABLE\""
;
05-02-10 13:35:56
Configuring NTP Key Generation
This command creates a KeyID and Key pair that can be used to authenticate the
NTP timestamp that the TimeProvider sends as the NTP server. You can create up
to nine KeyID/Key pairs, and then specify which pair to use when you conf igure t he
NTP Server.
Note: To prevent confusion at a later date, be sure to write down and
store in a secure place the Key/KeyID pairs you create. There is no
provision for displaying the stored Key/KeyID pairs.
Note: The “ : and \ characters may not be used in the Key/KeyID
pairs.
52 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 53
Chapter 2 TL1 Command Syntax and Description
ED-EQPT for NTP Parameters
Syntax
ED-EQPT:[<tid>]:NTP:[<ctag>]::KEYGEN,<func>,<keyid>[,<key>];
<keyword> <value> Description Default
FUNC ADD | DELETE
Key to be added, deleted, or modified NA
| MODIFY
KEY 32-character
Authentication key Null
ASCII value
KEYID 1 to 65534 The Authentication identification value 1
Example
To add an NTP authentication key:
Input
ED-EQPT::NTP:TP1000::KEYGEN,ADD,ABC...XYZABCDEF,1024;
Normal Response
TP-SSU 05-02-10 13:35:56
M TP1000 COMPLD
;
Autonomous Message
TP-SSU 05-02-10 13:35:56
A 2537 REPT EVT
"NTP,EQPT:SERVER,TC,05-02-10,13-35-56,,,,:\"NTP AUTHENTICATION HAS
CHANGED\""
;
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 53
Page 54
Chapter 2 TL1 Command Syntax and Description
Edit Password (ED-PID)
Edit Password (ED-PID)
This command allows users to edit their own password in the user database.
This command has a default access level of USER.
Syntax
ED-PID:[<tid>]:<uid>:[<ctag>]::<oldpid>,<newpid>;
Parameter Value Description
<uid> text string The user name assigned to the user for which the password
<oldpid> text string The user’s currently existing password.
is being changed. This must be the <uid> of the user logged
into the current session.
Note: This parameter must exactly match the existing
password in the user database, or a DENY response is
returned.
<newpid> text string The user’s new password.
Notes:
The password can be up to twenty (20) characters. It
must include at least two non-alphabe tic cha r acters,
and must include at least one special character , which is
any printing character other than a letter of the alpha bet,
a number, a comma, a colon, or a semicolon.
To use case-sensitive passwords, <pid> must be
enclosed in quotes in the command line.
Example
To change user Fred’s password from "FRED.1" to "ETHEL!5":
Input
ED-PID::fred:TP1000::FRED.1,ETHEL!5;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2538 REPT EVT
"IMC,EQPT:PIDCHG,TC,05-02-10,13-35-56,,,,:\"USER PASSWORD HAS CHANGED\""
;
54 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
05-02-10 13:35:56
Page 55
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Edit Sync (ED-SYNC)
This command changes factory settings and input and output port parameter
settings that can influence how the system’s signal synchronization operates.
This command has a default access level of ADMIN.
Syntax
ED-SYNC:[<tid>]:<aid>:[<ctag>]::<keyword>=<value>;
Parameter Value
See
Table 2-6
Description
for <keyword> and <value> descriptions
<aid> SYS The command’s effect is on system-level input settings.
GPS The command’s effect is on the GPS system input.
PRS The command’s effect is on the PRS system input.
INPp The command’s effect is on the input port specified by p:
p = “1” for the input marked INP 1 on the Input Connector
module
p = “2” for the input marked INP 2 on the Input Connector
module
OUTg The command’s effect is on the output group specified by g:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
RTMg[-p] The command’s effect is on the Retimer group and port
specified by g[-p]:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
p = “1” for Port 1 on the Retimer module
p = “2” for Port 2 on the Retimer module
E422g The command’s effect is on the EIA-422 output group
specified by g:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 55
Page 56
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values
<keyword> <value> Description Default
<aid> = SYS
CLRDELAY 0 – 1000 The time, in seconds, that elapses after a signal fault
clears and before the associated alarm condition
clears. This delay helps prevent an alarm from
clearing before the signal is stable.
FL TDELAY 1 – 15 The time, in seconds, that elapses afte r an LOS, AIS,
or OOF fault occurs and before the associated alarm
condition is set. This delay helps prevent spurious
alarms.
REFMODE AUTO The system automatically selects the reference input
based on the QLEVEL and PRIORITY settings.
FORCED Input reference selection is determined by the
INPREF parameter setting.
INPREF GPS The GPS input is selected as the reference when
REFMODE=FORCED.
PRS The PRS input is selected as the reference when
REFMODE=FORCED.
INP1 Input 1 is selected as the reference when
REFMODE=FORCED.
INP2 Input 2 is selected as the reference when
REFMODE=FORCED.
5
5
AUTO
PRS
Note:
When INPREF is used as a keyword with the RTRV-SYNC
command, the input that is currently selected as the system
reference is returned.
CCALIGN NA Allows the user to clear an INPTRR alarm against the
NA
current reference by forcing the CC output into
polarity alignment with the reference. This is a
non-persistent value; when the alignment is
complete, the value returns to its previous value.
56 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 57
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values (Continued)
<keyword> <value> Description Default
<aid> = GPS
QLEVEL
Note: QLEVEL is
used when an
input cannot
determine the
received quality
level. If QLEVEL
is provisioned
below the quality
level of the local
oscillator, the
input is
disqualified. The
input QLEVEL
setting determines
if the switching
strategy is
revertive or
non-revertive.
This setting is
used when
REFMODE is set
to AUTO.
1 The user-assigned quality level of the GPS input is
specified as PRC/PRS (primary reference
clock/source).
2 The user-assigned quality level of the GPS input is
specified as UNK/STU (sync traceability unknown).
3 The user-assigned quality level of the GPS input is
specified as TYPE II/ST2 (stratum 2).
4 The user-assigned quality level of the GPS input is
specified as TYPE I.
5 The user-assigned quality level of the GPS input is
specified as TYPE V/TNC (transit node clock).
6 The user-assigned quality level of the GPS input is
specified as TYPE III/ST3E (stratum 3E).
7 The user-assigned quality level of the GPS input is
specified as TYPE IV/ST3 (stratum 3).
8 The user-assigned quality level of the GPS input is
specified as 811OPT3/SMC (G.811 option 3 SONET
minimum clock).
9 The user-assigned quality level of the GPS input is
specified as DUS (do not use for timing
synchronization).
1
PRIORITY 1 The priority level of the input is set to 1. 1
2 The priority level of the input is set to 2.
3 The priority level of the input is set to 3.
4 The priority level of the input is set to 4.
Note: If the QLEVEL on all inputs are equal, then the input with the highest
PRIORITY is selected. The input PRIORITY settings determine if the switching
strategy is revertive or non-revertive. This setting is used when REFMODE is
set to AUTO.
<aid> = PRS
QLEVEL Refer to the QLEVEL description under the <aid> =
GPS heading in this table.
PRIORITY Refer to the PRIORITY description under the <aid> =
GPS heading in this table.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 57
Page 58
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values (Continued)
<keyword> <value> Description Default
FRMTYPE 1.544M The PRS input frequency is provisioned as
1.544 MHz.
2M The PRS input frequency is provisioned as 2 MHz
(2048 kHz).
5M The PRS input frequency is provisioned as 5 MHz.
6.312M The PRS input frequency is provisioned as
6.312 MHz.
10M The PRS input frequency is provisioned as 10 MHz.
Note: If the input frequency does not match the FRMTYPE setting,
an input loss-of-signal (INPLOS) condition results.
<aid> = INPp
QLEVEL Refer to the QLEVEL description under the <aid> =
GPS heading in this table.
PRIORITY Refer to the PRIORITY description under the <aid> =
GPS heading in this table.
FRMTYPE
Note: When the
TimeProvider is in
Subtending mode,
2M Specified input frame signal type is 2M. 2M
CAS Specified input frame signal type is CAS.
CCS Specified input frame signal type is CCS.
see “Set System
Mode
(SET-SYS-MODE
)” on page 134,
the frame signal
type is
automatically set
to Composite
D4
ESF Specified input frame signal type is ESF (Extended
1.544M
6.312M
1
1
Specified input frame signal type is D4 (Super Frame).
Super Frame).
Specified input frame signal type is 1.544 MHz.
Specified input frame signal type is 6.312 MHz.
Clock (CC or JCC)
by the system.
The Composite
Clock FRMTYPE
cannot otherwise
be selected by the
user.
CC Specified input frame signal type is Composite Clock.
JCC
1
Specified input frame signal type is Japanese
Composite Clock.
JCC4
1
Specified input frame signal type is Japanese
Composite Clock 400 Hz.
2M
ESF
CRCENA ENABLE Enables the use of CRC4 checking on the input. DISABLE
DISABLE Disables the use of CRC4 checking on the input.
Note: If an input i s provisioned to read SSMs (SSMENA=ENABLE),
CRC4 must be provisioned first.
58 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 59
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values (Continued)
<keyword> <value> Description Default
SSMENA ENABLE The input is provisioned to read the received SSM. DISABLE
DISABLE The input is provisioned to not read (ignore) the
received SSM.
SSMBIT 4 The specified input is provisioned to read the E1
(CCS) SSM at bit position 4.
5 The specified input is provisioned to read the E1
(CCS) SSM at bit position 5.
6 The specified input is provisioned to read the E1
(CCS) SSM at bit position 6.
7 The specified input is provisioned to read the E1
(CCS) SSM at bit position 7.
8 The specified input is provisioned to read the E1
(CCS) SSM at bit position 8.
<aid> = OUTg
FRMTYPE 8K The framing type generated by the specified output
group is provisioned as 8 kHz.
1
1.544M
The framing type generated by the specified output
group is provisioned as 1.544 MHz.
2M The framing type generated by the specified output
group is provisioned as 2 MHz.
1
6.312M
The framing type generated by the specified output
group is provisioned as 6.312 MHz.
8
2M
CAS The framing type generated by the specified output
group is provisioned as CAS.
CCS The framing type generated by the specified output
group is provisioned as CCS.
D4 The framing type generated by the specified output
group is provisioned as D4 (Super Frame).
ESF The framing type generated by the specified output
group is provisioned as ESF (Extended Super Frame).
CC The framing type generated by the specified output
group is provisioned as Composite Clock.
JCC
1
The framing type generated by the specified output
group is provisioned as Japanese Composite Clock.
JCC4
1
The framing type generated by the specified output
group is provisioned as Japanese Composite Clock 4.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 59
Page 60
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values (Continued)
<keyword> <value> Description Default
FRMTYPE
(cont’d)
FREEFLT ON Outputs are generated based on system SSM when
ISOLATED_1The framing type generated by the specified output
group is provisioned as an ‘isolated one’ test pattern.
SQUELCH
the Local Oscillator enters Free-run mode.
SQUELCH Outputs are squelched (turned off) when the Local
Oscillator enters Free-run mode.
AIS Outputs generate an AIS signal when the Local
Oscillator enters Free-run mode.
HOLDFLT ON Outputs are generated based on system SSM when
ON
the Local Oscillator enters Holdover mode.
SQUELCH Outputs are squelched (turned off) when the Local
Oscillator enters Holdover mode.
AIS Outputs generate an AIS signal when the Local
Oscillator enters Holdover mode.
SSMENA ENABLE ESF or E1 (CCS) outputs generate SSMs. ENABLE
DISABLE ESF or E1 (CCS) outputs do not generate SSMs.
SSMBIT 4 The output SSM is placed in bit position 4. ALL
5 The output SSM is placed in bit position 5.
6 The output SSM is placed in bit position 6.
7 The output SSM is placed in bit position 7.
8 The output SSM is placed in bit position 8.
ALL The output SSM is placed in all bit positions.
<aid> =RTMg[-p]
RTMLBO
Note: For the E1
Retimer , the IPNV
(Invalid
0 Sets the Line Build-out length to 0 to 133 ft 0
1 Sets the Line Build-out length to 133 to 266 ft
2 Sets the Line Build-out length to 266 to 399 ft
Parameter) DENY
code is returned.
3 Sets the Line Build-out length to 399 to 533 ft
4 Sets the Line Build-out length to 533 to 650 ft
FREEFLT CUTTHRU Cut-thru mode is engaged when the Local Oscillator
enters Free-run mode.
RETIME Cut-thru mode is not engaged when the Local
Oscillator enters Free-run mode.
RETIME
60 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 61
Chapter 2 TL1 Command Syntax and Description
Edit Sync (ED-SYNC)
Table 2-6. ED-SYNC – Keywords and Values (Continued)
<keyword> <value> Description Default
HOLDFLT CUTTHRU Cut-thru mode is engaged when the Local Oscillator
enters Holdover mode.
RETIME Cut-thru mode is not engaged when the Local
Oscillator enters Holdover mode.
<aid> = E422g
FRMTYPE 1.544M The framing type generated by the specified EIA-422
output group is provisioned as 1.544 MHz.
2M The framing type generated by the specified EIA-422
output group is provisioned as 2 MHz.
FREEFLT ON Outputs are generated when the Local Oscillator
enters Free-run mode.
SQUELCH Outputs are squelched (turned off) when the Local
Oscillator enters Free-run mode.
HOLDFLT ON Outputs are generated when the Local Oscillator
enters Holdover mode.
SQUELCH Outputs are squelched (turned off) when the Local
Oscillator enters Holdover mode.
Note:
1
Used only in Japanese version.
RETIME
1.544M
SQUELCH
ON
Example
To provision the interface type of the inputs as T1 inputs:
Input
ED-SYNC::INP1:TP1000::FRMTYPE=D4;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2556 REPT EVT
"INP1,T1:FRMTYPE,TC,05-02-10,13-35-56,,,,:\"INPUT FRAMING TYPE HAS
CHANGED,D4\""
;
05-02-10 13:35:56
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 61
Page 62
Chapter 2 TL1 Command Syntax and Description
Edit User Security (ED-USER-SECU)
Edit User Security (ED-USER-SECU)
This command changes the specified user’s access level.
This command has a default access level of SECURITY. This command’s access
level cannot be changed.
Syntax
ED-USER-SECU:[<tid>]:<uid>:[<ctag>]::<keyword>=<value>;
Parameter Value Description
<uid> text string The user name assigned to the user for which the access
level is being changed.
Note:
See
Table 2-7
Table 2-7. ED-USER-SECU – Keyword and Values for <uid>=text string
for <keyword> and <value> descriptions.
<keyword> <value> Description Default
ACCLVL NONE The specified user is assigned an access level of NONE.
N/A
Note: With an access level of NONE, users can receive
autonomous messages, but have very limited command
access.
USER The specified user has USER access, and can issue
commands having an access level of NONE or USER.
ADMIN The specified user has ADMIN access, and can issue
commands having an access level of NONE, USER, or
ADMIN.
SECURITY The specified user has SECURITY access, and can issue
all commands.
Example
To change the access level for user "FRED” to ADMIN:
Input
ED-USER-SECU::FRED:TP1000::ACCLVL=ADMIN;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2562 REPT EVT
"IMC,EQPT:ACCLVL,TC,05-02-10,13-35-56,,,,:\"USER ACCESS LEVEL HAS CHANGED\""
;
62 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
05-02-10 13:35:56
Page 63
Chapter 2 TL1 Command Syntax and Description
Enter Password (ENT-PID)
Enter Password (ENT-PID)
This command allows a security-level user to edit any user’s password in the user
database.
This command has a default access level of SECURITY.
Syntax
ENT-PID:[<tid>]:<uid>:[<ctag>]::<newpid>;
Parameter Value Description
<uid> text string The user name assigned to the user for which the p assword
is being changed.
<newpid> text string The user’s new password.
Notes:
The password can be up to twenty (20) characters. It
must include at least two non-alphabetic characters, and
must include at least one special character , wh ich is any
printing character other than a letter of the alphabet, a
number, a comma, a colon, or a semicolon.
To use case-sensitive passwords, <newpid> must be
enclosed in quotes in the command line.
Example
To change the password for user “FRED” from "FRED.1" to "D1n0@br":
Input
ENT-PID::FRED:TP1000::D1n0@br;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 174 REPT EVT
"IMC,EQPT:PIDCHG,TC,05-02-10,13-35-56,,,,:\"USER PASSWORD HAS CHANGED\""
;
05-02-10 13:35:56
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 63
Page 64
Chapter 2 TL1 Command Syntax and Description
Enter User Security (ENT-USER-SECU)
Enter User Security (ENT-USER-SECU)
This command enters a new user in the user database.
Notes:
Up to 20 users can be stored in the user database. With no users
defined, anyone connecting to the system has access to all
commands.
The first user you create must be at the Security level. After you
create this user, that user must log into the system using th e Activate
User (ACT-USER) command to further provision the system.
This command has a default access level of SECURITY. This command’s access
level cannot be changed.
Syntax
ENT-USER-SECU:[<tid>]:<uid>:[<ctag>]::<pid>,<uap>;
Parameter Value Description
<uid> text string The user name for the user being set up.
Note: The user name can be up to twenty (20)
case-insensitive alphanumeric characters.
<pid> text string The password for the user being set up.
Notes:
The password can be up to twenty (20) characters
long. It must include at least two non-alphabetic
characters, and must include at least one special
character, which is any printing character other than a
letter of the alphabet, a number, a comma, a colon, or
a semicolon.
To use case-sensitive passwords, <pid> must be
enclosed in quotes in the command line.
<uap> NONE The specified user is assigned an access level of NONE.
Note: With an access level of NONE, users can receive
autonomous messages, but have very limited command
access.
USER The user being set up has USER access and is able to
issue commands having an access level of NONE or
USER.
ADMIN The user being set up has ADMIN access and is able to
issue commands having an access level of NONE, USER,
or ADMIN.
SECURITY The user being set up has SECURITY access and is able
to issue all commands.
64 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 65
Chapter 2 TL1 Command Syntax and Description
Enter User Security (ENT-USER-SECU)
Example
To add a user "FRANKJ" to the system, with a case-sensitive password of
"GyRo%23" and an access level of USER:
Input
ENT-USER-SECU::FRANKJ:TP1000::”GyRo%23”,USER;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2560 REPT EVT
"IMC,EQPT:USRADD,TC,05-02-10,13-35-56,,,,:\"USER HAS BEEN ADDED\""
;
05-02-10 13:35:56
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 65
Page 66
Chapter 2 TL1 Command Syntax and Description
Initialize Event Log (INIT-LOG)
Initialize Event Log (INIT-LOG)
This command clears the event log on the IMC module.
This command has a default access level of ADMIN.
Syntax
INIT-LOG:[<tid>]:<aid>:[<ctag>];
Parameter Value Description
<aid> IMC The command’s effect is on the Information Management
Example
To clear the event log on the IMC module:
Card module.
Input
INIT-LOG::IMC:TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2563 REPT EVT
"IMC,EQPT:INITLOG,TC,05-02-10,13-35-56,,,,:\"EVENT LOG HAS BEEN CLEARED\""
;
05-02-10 13:35:56
66 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 67
Chapter 2 TL1 Command Syntax and Description
Initialize System (INIT-SYS)
This command initializes the specified module, or the system.
Caution: This command causes the local oscillator in the specified
IOC to enter the Warm-up mode; the outputs are squelched until the
system enters FAST-LOCK.
After issuing the INIT -SYS command with the SYS aid and FACTORY
keyword, all system parameters are reset, including the entire user
list. Y ou must therefore create a new security-level user after the user
list is reset to avoid a service call. Refer to “Defining the First User” in
the TimeProvider User Guide (097-58001-02) for more information.
This command has a default access level of ADMIN.
Syntax
INIT-SYS:[<tid>]:<aid>:[<ctag>]::<keyword>;
Initialize System (INIT-SYS)
Parameter Value Description
<aid> SYS The command’s effect is at the system level.
Note: See Table 2-8 for the <keyword> description.
IMC The command’s effect is on the IMC module.
Note: See Table 2-8 for the <keyword> description.
IOCm The command’s effect is on the Input/Output Card module
specified by m:
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
Note: See Table 2-8 for the <keyword> description.
Table 2-8. INIT-SYS Keywords
<keyword> Description Default
<aid> = SYS
FACTORY Resets system settings to factory default values. N/A
<aid> = IMC | IOCm
RESET Performs a reset (reboot) of the specified card, which reinitializes
N/A
volatile memory, but does not affect non-volatile (persistent)
memory.
Note: Prior to resetting an IOC module, all alarms associated with
the module are cleared, and if the specified IOC module is the
active module, it is placed in Standby mode. Resetting an IOC in a
non-redundant system will squelch the outputs until the system
enters FAST-LOCK.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 67
Page 68
Chapter 2 TL1 Command Syntax and Description
Initialize System (INIT-SYS)
Example
To perform a reset on the IOC2 module:
Input
INIT-SYS::IOC2:TP1000::RESET;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 258 REPT EVT
"IOC2,EQPT:RESET,TC,05-02-10,13-35-56,,,,:\"MODULE HAS BEEN RESET\""
;
05-02-10 13:35:56
68 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 69
Chapter 2 TL1 Command Syntax and Description
Operate Alarm Cutoff (OPR-ACO-ALL)
Operate Alarm Cutoff (OPR-ACO-ALL)
This command deactivates (opens) the minor, major, and critical audible alarm
relays.
Note: When you deactivate the audible alarm relays using this
command, they reactivate when subsequent alarms occur.
This command has a default access level of USER.
Syntax
OPR-ACO-ALL:[<tid>]::[<ctag>];
Example
To deactivate the audible alarm relays:
Input
OPR-ACO-ALL:::TP1000;
Normal Response
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
TP-SSU
A 2564 REPT EVT
"IMC,EQPT:ACO,TC,05-02-10,13-35-56,,,,:\"AUDIO ALARM IS DEACTIVATED\""
;
05-02-10 13:35:56
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 69
Page 70
Chapter 2 TL1 Command Syntax and Description
Ping (PING)
Ping (PING)
This command allows the TimeProvider to test (ping) for network connectivity.
This command has a default access level of USER.
Syntax
PING:[<tid>]::[<ctag>]::<ipaddr>;
Parameter Value Description
<ipaddr> IP dot notation The IP address of the host system to be pinged from the
Example
To ping IP address 198.162.12.10 from the TimeProvider:
TimeProvider.
The range is 1.0.0.1 to 254.254.254.254.
Input
PING:::TP1000::192.168.12.10;
Response Example
TP-SSU
M TP1000 COMPLD
“Host 192.168.12.10 is alive. Roundtrip time was 165 milliseconds”
;
05-02-10 13:35:56
Autonomous Message
None
70 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 71
Chapter 2 TL1 Command Syntax and Description
Remove Equipment (RMV-EQPT)
Remove Equipment (RMV-EQPT)
This command allows the user to confirm that a redundant IOC, Output module,
Retimer module, Expansion Panel, or TPIU that was connected to the system when
it started up has been removed from the system and to clear the associated alarm. If
you issue the RMV-EQPT command before your physically remove the equipment,
then the alarm associated with the removal is silenced.
When you issue the RMV-EQPT command before removing a module, a 20-minute
timer starts. If you remove the equipment while the timer is running, the alarm
associated with the removal is silenced. If you do not remove the equipment while
the timer is running, then the system reverts to normal alarming.
If you reinstall the equipment after issuing the RMV-EQPT command, the message
“<module> IS EQUIPPED” is not reported.
This command has a default access level of USER.
Syntax
RMV-EQPT:[<tid>]:<aid>:[<ctag>]::<keyword>;
<aid> <keyword> Description
SYS IOCm Clears currently active IOCmEQPT alarms from the Input/
Output Card module specified by m, if the module is not to
be replaced:
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
E422g Clears currently active E422gEQPT alarms from the E422
Output module specified by g, if the module is not to be
replaced:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
OUTg Clears currently active OUTgEQPT alarms from the Output
module specified by g, if the module is not to be replaced:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 71
Page 72
Chapter 2 TL1 Command Syntax and Description
Remove Equipment (RMV-EQPT)
<aid> <keyword> Description
SYS
(cont’d)
RTMg Clears currently active RTMgEQPT alarms from the Retimer
module specified by g, if the module is not to be replaced:
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
EXPN Clears currently active EXPNEQPT alarms if the panel is not
to be replaced.
TPIU Clears currently active TPIUEQPT alarms if the TPIU is not
to be replaced.
Example
To clear the OUTBEQPT alarm after permanently removing the Output module from
group B:
Input
RMV-EQPT::SYS:TP1000::OUTB;
Response Example
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
Autonomous Message
None
72 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 73
Chapter 2 TL1 Command Syntax and Description
Retrieve Alarm Condition (RTRV-ALM)
Retrieve Alarm Condition (RTRV-ALM)
This command retrieves information on currently active alarms.
This command has a default access level of USER.
Syntax
RTRV-ALM:[<tid>]:[<aid>]:[<ctag>];
Parameter Value Description
<aid> ALL
(or null)
SYS Retrieves information for all currently active system-level
IMC Retrieves information for all currently active alarms from the
IOCm Retrieves information for all currently active alarms from the
GPS Retrieves information for all currently active alarms from the
PRS Retrieves information for all currently active alarms from the
INPp Retrieves information for all currently active alarms from the
Retrieves information for all alarms that are curren tly ac tive
in the entire system.
alarms.
Information Management Card module.
Input/Output Card module specified by m.
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
GPS module.
PRS module.
specified input port.
p = “1” for the input marked INP 1 on t he Input Connector
module
p = “2” for the input marked INP 2 on t he Input Connector
module
RTMg[-p] Retrieves information for all currently active alarms from the
specified Retimer module [and port].
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
p = “1” for Port 1 on the Retimer module
p = “2” for Port 2 on the Retimer module
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 73
Page 74
Chapter 2 TL1 Command Syntax and Description
Retrieve Alarm Condition (RTRV-ALM)
Parameter Value Description
<aid>
E422g Retrieves information for all currently active alar ms from the
(cont’d)
Command Output
The following shows the output format of the command, and Table 2-9 explains the
various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
”<aid>,aidtype:ntfcncde,condtype,srveff,ocrdat,ocrtim[:condscr]”<cr><lf>
”<aid>,aidtype:ntfcncde,condtype,srveff,ocrdat,ocrtim[:condscr]”<cr><lf>
.
.
”<aid>,aidtype:ntfcncde,condtype,srveff,ocrdat,ocrtim[:condscr]”<cr><lf>
;
Table 2-9. RTRV-ALM Output Fields
specified EIA-422 output module.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Field Description
aidtype Specifies if the event is associated with the internal operation of the system (EQPT),
or external to the system or facility (T1).
ntfcncde The notification code for the alarm or event. The notification code can be CR (critical
alarm), MJ (major alarm), or MN (minor alarm). If the alarm is set to NA, then this
field is empty.
condtype The TL1 alarm code that is associated with the event or alarm.
Note: Table B-2 shows all of the possible TimeProvider TL1 alarm codes (condition
types).
srveff Whether the event is service affecting (SA) or non-service affecting (NSA).
ocrdat The date the event occurred, in the format YY-MM-DD.
ocrtim The time that the event occurred, in the format HH:MM:SS.
condscr The description of the alarm or event. It is a quoted text string, preceded with the “\”
escape character.
Note: Table B-2 shows all of the possible TimeProvider alarm descriptions
(condition strings).
74 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 75
Chapter 2 TL1 Command Syntax and Description
Retrieve Alarm Condition (RTRV-ALM)
Example
To display all currently active alarms from the system:
Input
RTRV-ALM::ALL:TP1000;
Response Example
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"SYS,EQPT:MJ,EXPFAIL,SA,05-02-10,13-37-39,,:\"EXPANSION CONNECTIVITY FAILED\""
"IOC1,EQPT:MJ,CLKHOLD,SA,05-02-10,13-37-39,,:\"CLOCK ENTERED HOLDOVER MODE\""
"IOC2,EQPT:MJ,CLKHOLD,SA,05-02-10,13-37-39,,:\"CLOCK ENTERED HOLDOVER MODE\""
;
Autonomous Message
None
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 75
Page 76
Chapter 2 TL1 Command Syntax and Description
Retrieve Attribute (RTRV-ATTR)
Retrieve Attribute (RTRV-ATTR)
This command retrieves the alarm level set for a specified alarm.
This command has a default access level of USER.
Syntax
RTRV-ATTR:[<tid>]:[<aid>]:[<ctag>][::<keyword>];
Parameter Value
<aid> ALL (or
null)
SYS Retrieves the alarm level(s) set for all system-level alarms,
IMC
IOCm Retrieves the alarm level(s) set for all alarms in the specified
GPS Retrieves the alarm level(s) set for all GPS alarms, or for the
PRS Retrieves the alarm level(s) se t for all PRS alarms, or for th e
Description
See Table 2-10 for <keyword> descriptions.
Retrieves the alarm levels set for all alarms in the entire
system.
or for the specified system-level alarm.
Retrieves the alarm level(s) set for all Information Management
Card (IMC) alarms, or for the specified IMC alarm.
Input/Output Card module, or for the specified alarm from
the specified Input/Output Card module.
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
Note: Alarm level information is retrieved from the IOC
module that is currently active.
specified GPS alarm.
specified PRS alarm.
INPp Retrieves the alarm level(s) set for all alarms related to the
specified input port, or for the specified alarm related to the
specified input port.
p = “1” for the input marked INP 1 on the Input Connector
module
p = “2” for the input marked INP 2 on the Input Connector
module
RTMg[-p] Retrieves the alarm level(s) set for all alarms related to the
specified Retimer module [and port].
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
p = “1” for Port 1 on the Retimer module
p = “2” for Port 2 on the Retimer module
76 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 77
Chapter 2 TL1 Command Syntax and Description
Retrieve Attribute (RTRV-ATTR)
Parameter Value
<aid>
OUTg Retrieves the alarm level(s) set for all alarms related to the
cont’d
See Table 2-10 for <keyword> descriptions.
specified Output module.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Description
E422g Retrieves the alarm level(s) set for all alarms related to the
specified EIA-422 output module.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Table 2-10. RTRV-ATTR – Keywords and Values for all <aids>
<keyword> Description Default
Alarm ID The identifier of the alarm for which the level is to be retrieved.
Notes:
See Table B-1 for the possible alarm identifiers.
This keyword is not valid if the <aid> is ALL or null.
N/A
(null) or ALL Retrieves alarm attributes that are associated with all alarms
that are related to the specified <aid>.
Command Output
The following shows the output format of the command, and Table 2-11 explains the
various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
”<aid>:alarm id,alarm level”<cr><lf>
”<aid>:alarm id,alarm level”<cr><lf>
.
”<aid>:alarm id,alarm level”<cr><lf>
;
N/A
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 77
Page 78
Chapter 2 TL1 Command Syntax and Description
Retrieve Attribute (RTRV-ATTR)
Table 2-11. RTRV-ATTR Output Fields
Field Description
alarm id The identifier of the alarm for which the level is displayed.
Note: See Table B-1 for the possible alarm identifiers.
alarm level The level for the specified alarm. The alarm level can be CR (critical alarm), MJ
(major alarm), MN (minor alarm), NA (non-alarm event), NR (not reported), or CL
(clearing event).
Example
To display the current level set for the IMC module’s IOC1COMM alarm:
Input
RTRV-ATTR::IMC:TP1000::IOC1COMM;
Response Example
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"IMC:IOC1COMM,MN"
;
Autonomous Message
None
78 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 79
Chapter 2 TL1 Command Syntax and Description
Retrieve BesTime Status (RTRV-BESTIME-STAT)
Retrieve BesTime Status (RTRV-BESTIME-STAT)
This command displays the BesTime status, the data indicates predicted BesTime
ensemble information.
This command has a default access level of USER.
Syntax
RTRV-BESTIME-STAT:[tid]:<aid>:[<ctag>];
Parameter Value Description
<aid> IOCm Retrieves the BesTime status of the specified Input/Output
Card module.
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
Note: See Table 2-12 for output descriptions.
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"IOCm-SYS:<tfom>"<cr><lf>
"IOCm-PRS:<prs_wt>"<cr><lf>
"IOCm-INP1:<inp1_wt>"<cr><lf>
"IOCm-INP2:<inp2_wt>"<cr><lf>
"IOCm-LO:<lo_wt>"<cr><lf>
;
Table 2-12. RTRV-BESTIME-STAT Output Fields
Field Description
tfom Time Figure of Merit, estimated 2-Sigma accuracy of the system 1PPS
prs_wt PRS Input reference weight indicates the amount of influence (weight) the PRS
reference on the system timing when the system is not referenced to GPS.
1.00 indicates only input being used
0.00 indicates input not being used at all
inp1_wt
inp2_wt
Input 1(2) reference weight indicates the amount of influence (weight) the Input 1(2)
reference on the system timing when the system is not referenced to GPS.
1.00 indicates only input being used
0.00 indicates input not being used at all
<lo_wt> LO weight indicates the amount of influence (weight) the LO stability has on the
system timing when the system is not referenced to GPS.
1.00 indicates only input being used
0.00 indicates input not being used at all
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 79
Page 80
Chapter 2 TL1 Command Syntax and Description
Retrieve BesTime Status (RTRV-BESTIME-STAT)
Example
To display the BesTime status of IOC1:
Input
RTRV-BESTIME-STAT::IOC1:TP1000;
Response Example
TP-SSU 05-02-04 21:15:00
M TP1000 COMPLD
"IOC1-SYS:250ns"
"IOC1-PRS:0.85"
"IOC1-INP1:0.00"
"IOC1-INP2:0.00"
"IOC1-LO:0.15"
;
Autonomous Message
None
80 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 81
Chapter 2 TL1 Command Syntax and Description
Retrieve Built-In Self Test (RTRV-BIST)
Retrieve Built-In Self Test (RTRV-BIST)
This command displays all currently active faulted built-in self test information for
either the IMC or IOC or both.
This command has a default access level of USER.
Syntax
RTRV-BIST:[tid]:<aid>:[<ctag>];
Parameter Value Description
<aid> IMC Displays the currently active faulted built-in self test information
for the Information Management Card (IMC).
Note: See Table 2-13 for <condscr> descriptions.
IOCm Displays the currently active faulted built-in self test information
for the Information Management Card (IOC).
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
Note: See Table 2-13 for <condscr> descriptions.
Normal Response
IMC
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"IMC BIST"<cr><lf>
"<IMC condscr>"<cr><lf>*
;
IOC#
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"IOC# BIST"<cr><lf>
"<IOC# condscr>"<cr><lf>*
;
Note: An asterisk (*) indicates that multiple lines could be listed; all
active alarm conditions are shown on separate lines.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 81
Page 82
Chapter 2 TL1 Command Syntax and Description
Retrieve Built-In Self Test (RTRV-BIST)
Table 2-13. Retrieve Built-In Self Test Output Fields
Value Description
IMC condscr
IOC condscr
RAM FAULT
NVRAM FAULT
GPS 1PPS FAULT (may occur during IOC startup)
NETWORK FAULT
SOFTWARE FAULT
UNKOWN FAULT [fault number]
NO FAULTS
OUTPUT GROUP A CALIBRATION FAULT
OUTPUT GROUP B CALIBRATION FAULT
OUTPUT GROUP C CALIBRATION FAULT
OUTPUT GROUP D CALIBRATION FAULT
OUTPUT GROUP A FAULT
OUTPUT GROUP B FAULT
OUTPUT GROUP C FAULT
OUTPUT GROUP D FAULT
OUTPUT SYNTHESIZER UNLOCKED
VCXO CONTROL VOLTAGE FAULT
OCXO CURRENT LIMIT EXCEEDED
RUBIDIUM UNLOCKED
E1 PLL UNLOCKED
T1 PLL UNLOCKED
5V POWER SUPPLY FAULT
3.3V POWER SUPPLY FAULT
IMC POWER SUPPLY FAULT
15V POWER SUPPLY FAULT
1.8V POWER SUPPLY FAULT
–6V POWER SUPPLY FAULT
GPS POWER SUPPY FAULT
FPGA ACCESS FAULT
FPGA 40Hz FAULT
UNKNOWN FAULT [fault number]
NO FAULTS
82 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 83
Chapter 2 TL1 Command Syntax and Description
Retrieve Built-In Self Test (RTRV-BIST)
Example
To display the currently active faulted built-in self test information for IOC1:
Input
RTRV-BIST::IOC1:TP1000;
Response Example
TP-SSU
M TP1000 COMPLD
;
05-02-10 13:35:56
IOC1 BIST
OUTPUT GROUP A FAULT
E1 PLL UNLOCKED
IMC POWER SUPPLY FAULT
Autonomous Message
None
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 83
Page 84
Chapter 2 TL1 Command Syntax and Description
Retrieve Circuit Identification (RTRV-CKTID)
Retrieve Circuit Identification (RTRV-CKTID)
This command retrieves the circuit identification assigned to the designated aid.
This command has a default access level of USER.
Syntax
RTRV-CKTID:[<tid>]:<aid>:[<ctag>];
Parameter Value Description
<aid> GPS
PRS
Retrieves the circuit identification (cktid) for the designated
aid.
INPp
OUTg[-p]
RTMg[-p]
E422g[-p]
Command Output
The following shows the output format of the command.
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"GPS:<cktid>"<cr><lf>
"PRS:<cktid>"<cr><lf>
"INP1:<cktid>"<cr><lf>
"INP2:<cktid>"<cr><lf>
"OUTA-1:<cktid>"<cr><lf>
"OUTA-2:<cktid>"<cr><lf>
.
.
"OUTD-15:<cktid>"<cr><lf>
"OUTD-16:<cktid>"<cr><lf>
"RTMA-1:<cktid>"<cr><lf>
"RTMA-2:<cktid>"<cr><lf>
.
.
"RTMD-1:<cktid>"<cr><lf>
"RTMD-2:<cktid>"<cr><lf>
"E422A-1:<cktid>"<cr><lf>
"E422A-2:<cktid>"<cr><lf>
.
.
"E422D-7:<cktid>"<cr><lf>
"E422D-8:<cktid>"<cr><lf>
;
84 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 85
Chapter 2 TL1 Command Syntax and Description
Retrieve Command Security (RTRV-CMD-SECU)
Retrieve Command Security (RTRV-CMD-SECU)
This command retrieves the access level set for a specified command, or all
commands.
This command has a default access level of ADMIN.
Syntax
RTRV-CMD-SECU:[<tid>]:<cid>:[<ctag>];
Parameter Value Description
<cid> text string Retrieves the access level for the command with this identifier.
The command identifier is the part of the command synt ax that
appears before the first colon ( : ). It is not case-sensitive.
ALL Retrieves the access level for all commands.
Command Output
The following shows the output format of the command, and Table 2-14 explains the
various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"command,access"<cr><lf>
"command,access"<cr><lf>
.
.
"command,access"<cr><lf>
;
Table 2-14. RTRV-CMD-SECU Output Fields
Field Description
command The identifier of the command for which the access level is displayed. The command
identifier is the part of the command syntax that appears before the first colon ( : ).
access The access level for the specified command. The access level can be one of the
following:
NONE (command can be issued by all users)
USER (command can be issued by users with an access level of USER, ADMIN,
or SECURITY)
ADMIN (command can be issued by users with an access level of ADMIN or
SECURITY)
SECURITY (command can be issued by users with an access level of SECURITY)
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 85
Page 86
Chapter 2 TL1 Command Syntax and Description
Retrieve Command Security (RTRV-CMD-SECU)
Example
To display the current access level set for all TL1 commands:
Input
RTRV-CMD-SECU::ALL:TP1000;
Response Example
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"ACT-SWDL,ADMIN"
"ACT-USER,NONE"
"CANC-USER,NONE"
"CPY-MEM,ADMIN"
"DLT-SECU,SECURITY"
"DLT-USER-SECU,SECURITY"
"ED-CMD-SECU,ADMIN"
"ED-DAT,ADMIN"
"ED-EQPT,ADMIN"
"ED-PID,USER"
"ED-SYNC,ADMIN"
"ED-USER-SECU,SECURITY"
"ENT-PID,SECURITY"
"ENT-USER-SECU,SECURITY"
"INIT-LOG,ADMIN"
"INIT-SYS,ADMIN"
"OPR-ACO-ALL,USER"
"PING,USER"
"RTRV-ALM,USER"
"RTRV-ATTR,USER"
"RTRV-CMD-SECU,ADMIN"
"RTRV-COND,USER"
"RTRV-CRAFT,USER"
"RTRV-DAT,USER"
"RTRV-EQPT,USER"
"RTRV-HDR,NONE"
"RTRV-INV,USER"
"RTRV-LED,USER"
"RTRV-LOG,ADMIN"
"RTRV-MANF-INFO,SECURITY"
"RTRV-NETYPE,NONE"
"RTRV-SYNC,USER"
"RTRV-SYS-MODE,USER"
"RTRV-USER,USER"
"RTRV-USER-SECU,SECURITY"
"SET-ATTR,ADMIN"
"SET-SID,ADMIN"
"SET-SYS-MODE,ADMIN"
;
Autonomous Message
None
86 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 87
Chapter 2 TL1 Command Syntax and Description
Retrieve Condition (RTRV-COND)
Retrieve Condition (RTRV-COND)
This command retrieves information about the current state and status of system
components.
This command has a default access level of USER.
Syntax
RTRV-COND:[<tid>]:[<aid>]:[<ctag>];
Parameter Value Description
<aid> (null) or
ALL
SYS Retrieves expansion panel connectivity status and any alarm
IMC Retrieves all conditions related to the Information
IOCm Retrieves current setup and conditions related to the
GPS Retrieves GPS input state and any alarm events associated
PRS Retrieves PRS input state and any alarm events associated
INPp Retrieves input state and any alarm events associated with
Retrieves all state and status information for the entire
system.
events associated with the expansion panel.
Note: This information is reported by the active IOC.
Management Card module.
system-level functions of the Input/O utput Card module
specified by m.
m = “1” for the slot marked “IOC 1" on the main shelf
m = “2” for the slot marked “IOC 2" on the main shelf
Notes:
If neither IOC is active, the information for the input and
output components and some o f the system compon ents
are determined by the IOC1 module if it is installed, o r
the IOC2 module if the IOC1 module is not installed.
If either an IOC1(2)EQPT or IOC1(2)COMM alarm is
active, then no IOC1(2) information is displayed.
with the GPS input.
with the PRS input.
the input specified by p.
p = “1” for the input marked INP 1 on the Input
Connector module
p = “2” for the input marked INP 2 on the Input
Connector module
Note: This information is reported by the active IOC.
OUTg Retrieves status of the output group specified by g.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Note: This information is reported by the active IOC.
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 87
Page 88
Chapter 2 TL1 Command Syntax and Description
Retrieve Condition (RTRV-COND)
Parameter Value Description
<aid>
(cont’d)
RTMg Retrieves status of the Retimer group specified by g.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Note: This information is reported by the active IOC.
E422g Retrieves status of the EIA-422 output group specified by g.
g = “A” for the group marked “A” on the main shelf
g = “B” for the group marked “B” on the main shelf
g = “C” for the group marked “C” on the main shelf
g = “D” for the group marked “D” on the main shelf
Note: This information is reported by the active IOC.
Command Output
The following shows the output format of the command when the “ALL” a id is used ,
and Table 2-15 explains the various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"SYS:<pwra>,<pwrb>,<expneqpt>,<extfault>,<ioc1eqpt>,
<ioc2eqpt>,<sysqlevel> <lastdat>,<lasttim>
"IMC:<ioc1comm>,<ioc2comm>"<cr><lf>
[
"IOC1:<iocstatus>,<ioccomm>,<imccomm>"<cr><lf>]
[
"IOC2:<iocstatus>,<ioccomm>,<imccomm>"<cr><lf>]
"GPS:<gpsstatus>"<cr><lf>
"PRS:<prsstatus>"<cr><lf>
"INP1:<inpstatus>"<cr><lf>
"INP2:<inpstatus>"<cr><lf>
"OUTA:<outstatus>"<cr><lf>
"OUTB:<outstatus>"<cr><lf>
"OUTC:<outstatus>"<cr><lf>
"OUTD:<outstatus>"<cr><lf>
"RTMA:<rtm1status>,<rtm2status>"<cr><lf>
"RTMB:<rtm1status>,<rtm2status>"<cr><lf>
"RTMC:<rtm1status>,<rtm2status>"<cr><lf>
"RTMD:<rtm1status>,<rtm2status>"<cr><lf>
"E422A:<outstatus>"<cr><lf>
"E422B:<outstatus>"<cr><lf>
"E422C:<outstatus>"<cr><lf>
"E422D:<outstatus>"<cr><lf>
;
"<cr><lf>
88 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 89
Table 2-15. RTRV-COND Output Fields
Field Description
<aid> = SYS
Chapter 2 TL1 Command Syntax and Description
Retrieve Condition (RTRV-COND)
pwra
pwrb
Indicates if the IMC has detected a loss of power at the Power A(B) conne ction. The
possible returned values can be either PWRA(B)-OK (no PWRA(B) alarm is
currently active), or PWRA(B)-ALM (a PWRA(B) alarm is currently active).
expneqpt Indicates if the connection to the expansion output panel was lost. The possible
returned values can be either EXP-OK (no EXPFAIL alarm is currently active), or
EXP-ALM (an EXPFAIL alarm is currently active).
extalm1
extalm2
Indicates if external equipment is currently generating alarm(s). The possible
returned values can be either EXT1(2)-OK (no EXTALM1(2) alarm is currently
active), or EXT1(2)-ALM (an EXTALM1(2) alarm is currently active).
ioc1eqpt
ioc2eqpt
Indicates if the system is equipped with an IOC module in the specified slot. The
possible returned values can be either IOC1(2)-EQP T (an IOC1(2)-EQP T event wa s
received), or IOC1(2)-UNEQPT (no IOC1(2)-EQPT event was received).
sysqlevel Indicates the system output quality level (1 through 9)
lastdat The date the sys tem was last provisioned by a user. The format is YY-MM-DD.
lasttim The time the system was last provisioned by a user. The format is HH:MM:SS.
<aid> = IMC
ioc1comm
ioc2comm
Indicates if an IOC1(2) communication alarm currently is active. The possible returned
values can be either IOC1(2)COMM-OK (no IOC1(2)COMM alarm is currently active),
or IOC1(2)COMM-ALM (an IOC1(2)COMM alarm is currently active).
<aid> = IOC1 | IOC2
Note: The following status conditions are reported by the IOC modules, but are stored in the IMC.
When you issue the RTRV-COND command, the IMC reports the last status conditions it received
from the IOC modules. If a given IOC module is removed or develops a communication problem, the
status as reported by the IMC might not be accurate.
iocstatus The current status of the specified IOC mod ule. The status can be either OK (no IOC
alarms are currently active for the specified module), or ALM (one or more IOC
alarms are currently active for the specified module).
ioccomm Indicates if a communication alarm from the IOC1(2) to the IOC2(1) module is
currently active. The returned values can be IOC1(2)TO2(1)COMM-OK
(no IOC1(2)TO2(1)COMM alarm is currently active), or IOC1(2)TO2(1)COMM-ALM
(an IOC1(2)TO2(1)COMM alarm is currently active).
imccomm Indicates if a communication alarm from the IMC to the IOC2(1) module currently is
active. The returned values can be IMC1(2)COMM-OK (no IMC1(2)COMM alarm is
currently active), or IMC1(2)COMM-ALM (an IMC1(2)COMM alarm is currently
active).
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 89
Page 90
Chapter 2 TL1 Command Syntax and Description
Retrieve Condition (RTRV-COND)
Table 2-15. RTRV-COND Output Fields (Continued)
Field Description
<aid> = GPS
gpsstatus The current status of the GPS input. The status can be OK (no alarms are currently
active for the specified component), ALM (one or more alarms are currently active
for the specified component), or UNEQUIPPED (TPIUEQPT connectivity alarm).
<aid> = PRS
prsstatus The current status of the PRS input. The status can be OK (no alarms are currently
active for the specified component), or ALM (one or more alarms are currently active
for the specified component).
<aid> = INP1 | INP2
inpstatus The current status of the specified input, output, or system component. The status
can be OK (no alarms are currently active for the spe cified component), or ALM (one
or more alarms are currently active for the specified component).
<aid> = OUT A | OUTB | OUTC | OUTD
outstatus The current status of the specified output module. The status can be OK (no alarms
are currently active for the specified component), ALM (one or more alarms are
currently active for the specified component), or UNEQUIPPED (the OUTgEQPT
module is removed from the shelf).
<aid> = RTMA | RTMB | RTMC | RTMD
rtm1status
rtm2status
The current status of the indicated port on the specified Retimer module. The status
can be OK (no alarms are currently active for the spe cified component), ALM (one or
more alarms are currently active for the specified component), or UNEQUIPPED
(the RTMgEQPT module is removed from the shelf).
<aid> = E422A | E422B | E422C | E422D
outstatus The current status of the specified EIA-422 output module. The status can be OK (no
alarms are currently active for the specified component), ALM (one or more alarms
are currently active for the specified component), or UNEQUIPPED (the
E422gEQPT module is removed from the shelf).
Example
To display the current state and status for all AIDs:
Input
RTRV-COND::ALL:TP1000;
90 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 91
Chapter 2 TL1 Command Syntax and Description
Retrieve Condition (RTRV-COND)
Response Example
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"SYS:PWRA-OK,PWRB-OK,EXP-OK,EXT1-OK,EXT2-OK,IOC1-EQPT,
IOC2-EQPT,2,05-02-10 13:37:39"
"IMC:IOC1COMM-OK,IOC2COMM-OK"
"IOC1:OK,IOC1TO2COMM-OK,IMC1COMM-OK"
"IOC2:OK,IOC2TO1COMM-OK,IMC2COMM-OK"
"GPS:OK"
"PRS:OK"
"INP1:OK"
"INP2:OK"
"OUTA:OK"
"OUTB:OK"
"OUTC:OK"
"OUTD:OK"
"RTMA:UNEQUIPPED,UNEQUIPPED"
"RTMB:UNEQUIPPED,UNEQUIPPED"
"RTMC:UNEQUIPPED,UNEQUIPPED"
"RTMD:UNEQUIPPED,UNEQUIPPED"
"E422A:UNEQUIPPED"
"E422B:UNEQUIPPED"
"E422C:UNEQUIPPED"
"E422D:UNEQUIPPED"
;
Autonomous Message
None
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 91
Page 92
Chapter 2 TL1 Command Syntax and Description
Retrieve Craft Data (RTRV-CRAFT)
Retrieve Craft Data (RTRV-CRAFT)
This command retrieves information about the system state, clock mode of
operation, input provisioning, and output provisioning.
This command has a default access level of USER.
Syntax
RTRV-CRAFT:[<tid>]::[<ctag>];
Notes:
The information displayed for the system input, output, and
expansion components is reported by the active IOC.
If neither IOC is active, the information for the input and output
components and some of the system components is determined by
the IOC1 module if it is installed, or the IOC2 module if the IOC1
module is not installed.
If the IMC module cannot read information from either IOC module,
the related information is not displayed in the command output.
If either an IOC1(2)EQPT or IOC1(2)COMM alarm is active, then no
IOC1(2) information is displayed.
Command Output
The following shows the output format of the command, and Table 2-16 describes
the various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
"
SYS:<pwra>,<pwrb>,<expeqpt>,<extalm1>,<extalm2>,<ioc1eqpt>,<ioc2eqpt>,<sysqlevel>,
<lastdat>,<lasttim>,<syncmode>,<refmode>,<inpref>,<clrdelay>,<fltdelay>,<inacttime>,
"
<logecho>
"
IMC:<ioc1comm>,<ioc2comm>"<cr><lf>
"
COML:<baud>,<flow>,<echo>"<cr><lf>
"
COMR:<baud>,<flow>,<echo>"<cr><lf>
"
COMI:<ipaddr>,<ipgate>,<ipsubnet>,[<echo>]"<cr><lf>
[ "IOC1:<iocstatus>,<ioccomm>,<imccomm>,<iocstate>,<iocmode>,<clkmode>,<clktype>"<cr><lf>]
[ IOC2:<iocstatus>,<ioccomm>,<imccomm>,<iocstate>,<iocmode>,<clkmode>,<clktype>
"
GPS:<gpsstatus>,<instate>,<qlevel>,<priority>,<utc>,<mode>,<pos>,<elevmask>"<cr><lf>
"
PRS:<prsstatus>,<instate>,<qlevel>,<priority>,<frmtype>"<cr><lf>
"
INP1:<inpstatus>,<instate>,<qlevel>,<priority>,<frmtype>,<rqlevel>,<crcena>,
<ssmena>,<ssmbit>"<cr><lf>
”INP2:<inpstatus>,<inpstate>,<qlevel>,<priority>,<frmtype>,,
<ssmena>, <ssmbit>
"
OUTA:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>"<cr><lf>
"
OUTB:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>"<cr><lf>
"
OUTC:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>"<cr><lf>
"
OUTD:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>"<cr><lf>
"
RTMA-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMA-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMB-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
<cr><lf>
"
<cr><lf>
<rqlevel>,
<crcena>,
"
<cr><lf>]
92 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 93
"
RTMB-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMC-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMC-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMD-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
RTMD-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf>
"
E422A:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf>
"
E422B:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf>
"
E422C:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf>
"
E422D:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf>
"
NTP:AUTHENTICATION,<authen>"<cr><lf>
"
NTP:SERVER,<serveripl>,<keyid>,<minpoll>,<maxpoll>,>preferred>"<cr><lf>
...
"
NTP:SERVER,<serveripl>,<keyid>,<minpoll>,<maxpoll>,>preferred>"<cr><lf>
;
Table 2-16. RTRV-CRAFT Output Fields
Field Description
<aid> = SYS
Chapter 2 TL1 Command Syntax and Description
Retrieve Craft Data (RTRV-CRAFT)
pwra
pwrb
Indicates if the IMC has detected a loss of power at the Power A(B) connection.
PWRA(B)-OK – no PWRA(B) alarm is currently active
PWRA(B)-ALM – a PWRA(B) alarm is currently active
expneqpt Indicates if the connection to the expansion output panel was lost.
EXP-OK – no EXPFAIL alarm is currently active
EXP-ALM – an EXPFAIL alarm is currently active
extalm1
extalm2
ioc1eqpt
ioc2eqpt
Indicates if external equipment is currently generating alarm(s).
EXT1(2)-OK – no EXTALM1(2) alarm is currently active
EXT1(2)-ALM – an EXTALM1(2) alarm is currently active
Indicates if the system is equipped with an IOC module in the specified slot.
IOC1(2)-EQPT – an IOC1(2)EQPT event was received
IOC1(2)-UNEQPT – no IOC1(2)EQPT event was received
sysqlevel Indicates the system output quality level (1 through 9)
lastdat The date the system was last provisioned by a user.
The format is YY-MM-DD, where YY is the 2-digit year, MM is the 2-digit
representation of the month, and DD is the day of the month.
lasttim The time the system was last provisioned by a user.
The format is HH:MM:SS, where HH is the hour in 24-hour format, MM is the minutes,
and SS is the seconds.
syncmode The TimeProvider system’s currently provisioned operating mode:
SSU | SUB | PRR
refmode The reference selection mode:
AUTO | FORCED
inpref
The input reference selected when the reference mode (REFMODE) is set to FORCED:
GPS | PRS | INP1 | INP2 | NONE
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 93
Page 94
Chapter 2 TL1 Command Syntax and Description
Retrieve Craft Data (RTRV-CRAFT)
Table 2-16. RTRV-CRAFT Output Fields (Continued)
Field Description
clrdelay
The time that elapses after a signal fault clears and before the assoc iated alarm condition
clears. This delay helps prevent an alarm from clearing before the signal is stable.
0 | 1 | ... | 1000
fltdelay The time that elapses after an LOS, AIS, or OOF fault occurs and before the
associated alarm condition is set. This delay helps prevent spurious alarms.
0 | 1 | ... | 15
inacttime The amount of user command inactivity time, which determines the amount of
inactivity time before the user is automatically logged off of the system.
0 (Disabled) | 100 | 101 | ... | 10000
logecho Indicates if login and logout events are echoed to the local terminal:
ENABLE | DISABLE
<aid> = IMC
ioc1comm
ioc2comm
Indicates if an IOC1(2) communication alarm currently is active.
IOC1(2)COMM-OK – no IOC1(2)COMM alarm is currently active
IOC1(2)COMM-ALM – an IOC1(2)COMM alarm is currently active
<aid> = COML | COMR
baud The serial port’s baud rate setting.
2400 | 9600 | 19200 | 38400 | 57600 | 115200
flow The type of serial port flow control set).
NONE | SW | HW | SWHW
echo Indicates if input is echoed to the local terminal on the port.
ENABLE | DISABLE
<aid> = COMI
ipaddr The IP address of the Network Element.
ipgate The IP address of the default gateway.
ipsubnet The subnet mask.
echo Indicates if input is echoed to the local terminal on the port:
ENABLE | DISABLE
<aid> = IOC1 | IOC2
Note: The following status conditions are reported by the IOC modules, but are stored in the IMC
module. When the RTRV-COND command is received by the unit, the IMC module reports the last
status conditions it received from the IOC modules. If IOC1(2)EQPT = UNEQUIPPED or
IOC1(2)COMM = ALM, then IOC data is not displayed.
iocstatus The current status of the specified IOC module.
OK | ALM
ioccomm Indicates if a communication alarm from the IOC1(2) to the IOC2(1) module is active.
IOC1(2)TO2(1)COMM-OK – no IOC1(2)TO2(1)COMM alarm is currently active
IOC1(2)TO2(1)COMM-ALM – an IOC1(2)TO2(1)COMM alarm is currently active
94 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 95
Chapter 2 TL1 Command Syntax and Description
Table 2-16. RTRV-CRAFT Output Fields (Continued)
Retrieve Craft Data (RTRV-CRAFT)
Field Description
imccomm Indicates if a communicatio n alarm from the IMC to the IOC2(1) module is active
IMC1(2)COMM-OK – no IMC1(2)COMM alarm is currently active
IMC1(2)COMM-ALM – an IMC1(2)COMM alarm is currently active
iocstate The service mod e of the IO C mo du le.
INSERV | OOSRV
iocmode Indicates if the IOC module is active.
ACTIVE | STANDBY
clkmode The current mode of the local oscillator on the IOC module.
WARMUP | FREERUN | FASTLOCK | BRIDGING | HOLDOVER | LOCKED
clktype The assumed SSM quality level for the IOC module’s clock.
ST3E | TYPEI | ST2 | TYPEIII
<aid> = GPS
gpsstatus The current status of the GPS.
OK | ALM
instate The state of the GPS input.
ENABLE | DISABLE | MONITOR
qlevel The provisioned quality level for the GPS input.
1 | 2 | ... | 9
priority The provisioned priority level for the GPS input.
1 | 2 | 3 | 4
utc Universal Coordinated T ime setting.
The format is HH:MM:SS, where HH is the hour in 24-hour format, MM is the minutes,
and SS is the seconds.
mode The user-specified position mode.
AUTO | MANUAL
pos The antenna latitude, longitude, and height setting.
The format is dd-mm-ss.ss (N or S), dd-mm.ss.ss (E or W), +/- hhhh.hh, where dd is
degrees, mm is minutes, ss.ss is fractional minutes, and hhhh is altitude in meters.
elevmask The current elevation mask, in degrees.
5 | 6 | ... | 45
<aid> = PRS
prsstatus The current status of the PRS.
OK | ALM
instate The state of the PRS input.
ENABLE | DISABLE | MONITOR
qlevel The provisioned quality level for the PRS input.
1 | 2 | ... | 9
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 95
Page 96
Chapter 2 TL1 Command Syntax and Description
Retrieve Craft Data (RTRV-CRAFT)
Table 2-16. RTRV-CRAFT Output Fields (Continued)
Field Description
priority The provisioned priority level for the PRS input.
1 | 2 | 3 | 4
frmtype The PRS input frequency setting.
2M | 5M | 10M
<aid> = INPp
inpstatus The current status of the specified input.
OK | ALM
instate The state of the specified input.
ENABLE | DISABLE | MONITOR
qlevel The provisioned quality level for the specified input.
1 | 2 | ... | 9
priority The provisioned priority level for the specified input.
1 | 2 | 3 | 4
frmtype The frame signal type provisioned for the specified input.
2M | CCS | D4 ESF | CC
rqlevel The quality level received on the specified input.
1 | 2 | ... | 10
crcena The specified input is provisioned to utilize CRC4 checking.
ENABLE | DISABLE
ssmena The specified input is provisioned to read the received SSM.
ENABLE | DISABLE
ssmbit The bit position at which the specified input is provisioned to read SSM.
4 | 5 | 6 | 7 | 8
<aid> = OUTg
outstatus The current status of the specified output group.
OK | ALM | UNEQUIPPED
outstate The state of the specified output group.
ENABLE | DISABLE
frmtype The framing type that the specified output group is provisioned to generate.
2M | CAS | D4 | ESF | CC | ISOLATED_1
freeflt The type of signal to be generated on the specified output group when the Local
Oscillator enters Free-run mode.
ON | SQUELCH AIS
holdflt The type of signal to be generated on the specified output group when the Local
Oscillator enters Holdover mode.
ON | SQUELCH AIS
96 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 97
Chapter 2 TL1 Command Syntax and Description
Table 2-16. RTRV-CRAFT Output Fields (Continued)
Retrieve Craft Data (RTRV-CRAFT)
Field Description
<aid> = RTMg-p
rtmstatus The current status of the specified Retimer group and port.
OK | ALM | UNEQUIPPED
rtmstate The state of the specified Retimer group and port.
ENABLE | DISABLE
rtmlbo The line buildout for the specified Retimer group and port.
0 | 1 | 2 | 3 | 4
freeflt The type of signal to be generated on the specified Retimer group and port when the
Local Oscillator enters Free-run mode.
RETIME | CUTTHRU
holdflt The type of signal to be generated on the specified Retimer group and port when the
Local Oscillator enters Holdover mode.
RETIME | CUTTHRU
rtmslip The number of slips permitted in a 24-hour period.
0 | 1 | ... | 255
<aid> = E422g
outstatus The current status of the specified EIA-422 output group.
OK | ALM | UNEQUIPPED
outstate The state of the specified EIA-422 output group.
ENABLE | DISABLE
frmtype The framing type that the specified EIA-422 output group is provisioned to generate.
1.544MHz | 2M
freeflt The type of signal to be generated on the specified EIA-422 output group when the
Local Oscillator enters Free-run mode.
ON | SQUELCH
holdflt The type of signal to be generated on the specified EIA-422 output group when the
Local Oscillator enters Holdover mode.
ON | SQUELCH
<aid> = NTP:AUTHENTICATION
authen Displays the NTP configuration.
ENABLE | DISABLE
<aid> = NTP:Server
serverip# The IP address of NTP server #.
keyid The Authentication Identification value:
0 | 1 | ... | 32768
minpoll The minimum time (in seconds) between Server time requests.
16 | 32 | 64 | 128 | 256 | 512 | 1024
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 97
Page 98
Chapter 2 TL1 Command Syntax and Description
Retrieve Craft Data (RTRV-CRAFT)
Table 2-16. RTRV-CRAFT Output Fields (Continued)
Field Description
maxpoll The maximum time (in seconds) between Server time requests.
16 | 32 | 64 | 128 | 256 | 512 | 1024
preferred The Preferred Server setting.
YES | NO
Example
To display all current state, status, and provisioning information:
Input
RTRV-CRAFT:::TP1000;
Response Example
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"SYS:PWRA-OK,PWRB-OK,EXP-OK,EXT1-OK,EXT2-OK,IOC1-EQPT,IOC2-EQPT,1,05-02-02,
15-53-10,PRR,AUTO,GPS,5,5,0,ENABLE"
"IMC:IOC1COMM-OK,IOC2COMM-OK"
"COML:9600,NONE,DISABLE"
"COMR:9600,NONE,DISABLE"
"COMI:192.168.21.46,192.168.21.1,255.255.255.0,DISABLE"
"IOC1:OK,IOC1TO2COMM-OK,IMC1COMM-OK,INSRV,ACTIVE,LOCKED,TYPEI"
"IOC2:OK,IOC2TO1COMM-OK,IMC2COMM-OK,OOSRV,STANDBY,,ST2"
"GPS:OK,ENABLE,1,1,05-02-03,17-18-34,AUTO,30-28-8.39N,97-40-35.21W,266.4,10"
"PRS:OK,ENABLE,2,1,2M"
"INP1:ALM,ENABLE,2,1,2M,E1,2,DISABLE,DISABLE,8"
"INP2:ALM,ENABLE,2,1,2M,E1,2,DISABLE,DISABLE,8"
"OUTA:OK,DISABLE,2M,ON,ON"
"OUTB:OK,DISABLE,2M,SQUELCH,ON"
"OUTC:OK,ENABLE,2M,SQUELCH,ON"
"OUTD:OK,ENABLE,CC,ON,ON"
"RTMA-1:OK,ENABLE,0,RETIME,RETIME,ON"
"RTMA-2:OK,ENABLE,0,RETIME,RETIME,ON"
"RTMB-1:OK,ENABLE,2,RETIME,RETIME,ON"
"RTMB-2:OK,ENABLE,2,RETIME,RETIME,ON"
"RTMC-1:UNEQUIPPED,DISABLE,2,CUTTHRU,CUTTHRU,ON"
"RTMC-2:UNEQUIPPED,DISABLE,2,CUTTHRU,CUTTHRU,ON"
"RTMD-1:UNEQUIPPED,DISABLE,2,CUTTHRU,CUTTHRU,ON"
"RTMD-2:UNEQUIPPED,DISABLE,2,CUTTHRU,CUTTHRU,ON"
"E422A:OK,DISABLE,2M,SQUELCH,ON"
"E422B:OK,DISABLE,2M,SQUELCH,ON"
"E422C:OK,DISABLE,2M,SQUELCH,ON"
"E422D:OK,DISABLE,2M,SQUELCH,ON"
"NTP:AUTHENTICATION,ENABLE"
"NTP:SERVER,254.255.255.254,0,16,1024,NO"
;
Autonomous Message
None
98 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Page 99
Chapter 2 TL1 Command Syntax and Description
Retrieve Date (RTRV-DAT)
Retrieve Date (RTRV-DAT)
This command retrieves the system date, time, and local offset.
This command has a default access level of USER.
Syntax
RTRV-DAT:[<tid>]:<aid>:[<ctag>];
Parameter Value Description
<aid> SYS The command’s effect is at the system level.
Command Output
The following shows the output format of the command, and Table 2-17 explains the
various fields in the command output:
Response Format
<cr><lf><lf>
sid date time<cr><lf>
M ctag COMPLD<cr><lf>
”SYS:date,time,offset”<cr><lf>
;
Table 2-17. RTRV-DAT Output Fields
Field Description
date The currently set system date, in the format yy-mm-dd:
yy = the 2-digit year
mm = the 2-digit representation of the month
dd = the day of the month
time The currently set system time, in the format hh-mm-ss:
hh is the hour, in 24-hour format
mm is the minutes
ss is the seconds
offset
The currently set UTC offset, in the format
hh is the local time’s hour offset from UTC; ±12 hours
mm is the local time’s minute offset from UTC
±hh-mm:
097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 99
Page 100
Chapter 2 TL1 Command Syntax and Description
Retrieve Date (RTRV-DAT)
Example
To display the currently set system date, time, and local offset:
Input
RTRV-DAT::SYS:TP1000;
Normal Response
TP-SSU 05-02-10 13:37:39
M TP1000 COMPLD
"SYS:05-02-10 13:37:39,00-00"
;
Autonomous Message
None
100 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
Loading...