TimeProvider 1000 and 1100
Edge Clock
TL1 Reference Guide
Revision E – September 2006
Part Number 097-58001-01
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.
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
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
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
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
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
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
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.
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
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
How to Use This Guide
What’s New In This Guide
12 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Loading...