Symmetricom TimeProvider 500 series User Manual

Download

TELECOM

SOLUTIONS

a division of SymmetriCom, Inc.

DIGITAL CLOCK DISTRIBUTOR

500 SERIES

TL1 USER’S GUIDE

(USED WITH MIS CARD 090-45018-14)

CONTENTS PAGE

1. GENERAL . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2. USING THIS PRACTICE. . . . . . . . . . . . . . . . 2

3. DESCRIPTION. . . . . . . . . . . . . . . . . . . . . . . 2

A. Conventions . . . . . . . . . . . . . . . . . . . . . 2

B. Application Message Types. . . . . . . . 2

C. Command Deﬁnitions . . . . . . . . . . . . . 3

D. Response Deﬁnitions . . . . . . . . . . . . . . 3

E. Parameter Deﬁnitions and Values . . . 4 F. Task/Command Cross-reference . . . 4

G. Alarm Message Format . . . . . . . . . . . 8

4. COMMANDS . . . . . . . . . . . . . . . . . . . . . . 12

Security Commands

ACTIVATE USER (ACT-USER). . . . . . . . 14

CANCEL USER (CANC-USER) . . . . . . . 16

EDIT SECURITY PASSWORD

(ED-SECU-PID). . . . . . . . . . . . . . . . . 18

Card Conﬁguration Commands

EDIT EQUIPMENT (ED-EQPT) . . . . . . . . 20

EDIT PARAMETER T1 (ED-PRMTR-T1) . 22 INITIALIZE REGISTER T1 (INIT-REG-T1) 24

INITIALIZE SYSTEM (INIT-SYS) . . . . . . . 27

OPERATE ALARM CUTOFF

(OPR-ACO-ALL) . . . . . . . . . . . . . . . 29

REMOVE T1 (RMV-T1) . . . . . . . . . . . . 31

RESTORE T1 (RST-T1) . . . . . . . . . . . . . . 33

SET ATTRIBUTE LOG (SET-ATTR-LOG) . 35

SET ATTRIBUTE T1 (SET-ATTR-T1) . . . . . 37

SET DATE (SET-DAT) . . . . . . . . . . . . . . 40

SET SOURCE IDENTIFIER (SET-SID) . . . 42

TMSL 097-45018-02

Issue 3: Mar 96

COMMANDS (Contd) PAGE

Retrieve Alarms (Manual and Automatic) Commands

RETRIEVE ALARMS (RTRV-ALM-

{ALL|EQPT|T1}) . . . . . . . . . . . . . . . . 47

REPORT ALARM (REPT-ALM {EQPT|T1}) 55

REPORT EVENT (REPT-EVT) . . . . . . . . . . 59

RETRIEVE LOG (RTRV-LOG) . . . . . . . . . 62

Card Information and Date Commands

RETRIEVE ATTRIBUTE T1 (RTRV-ATTR-T1) 64 RETRIEVE CONDITIONS (RTRV-COND-

{EQPT|T1}) . . . . . . . . . . . . . . . . . . . . 67

RETRIEVE HEADER (RTRV-HDR) . . . . . . 73

RETRIEVE EQPT (RTRV-EQPT) . . . . . . . . 75

RETRIEVE PARAMETER T1 (RTRV-

PRMTR-T1) . . . . . . . . . . . . . . . . . . . . 78

RETRIEVE PERFORMANCE

MONITORING T1 (RTRV-PM-T1) . . . . 81

RETRIEVE THRESHOLD T1 (RTRV-TH-T1) 86

Figures

1. Command Format . . . . . . . . . . . . . . . . . . . 3

2. MIS Card Switch . . . . . . . . . . . . . . . . . . . . . 13

Tables

A. Parameter Definitions . . . . . . . . . . . . . . . . 4

B. Task/Command Cross-reference . . . . . . 7

C. Terminal Alarm Displays . . . . . . . . . . . . . . 9

D. Operational Considerations . . . . . . . . . . . 12

1. GENERAL

SET THRESHOLD T1 (SET-TH-T1) . . . . . 44

SWITCH DUPLEX EQUIPMENT

(SW-DX-EQPT) . . . . . . . . . . . . . . . . 46

1.01

This practice provides information on the input messages (commands), response messages, and automatic messages used with the Telecom Solutions DCD 500 series shelf and the NAS System. The

Page 1

TMSL 097-45018-02 Issue 3: Mar 96

language used in this practice is Transaction Language 1 (TL1). A Maintenance Interface, System (MIS) card (p/n 090-45018-14) must be installed in the DCD-500 series system, and the DCD system used in conjunction with the NAS software to use the tools and information presented here. Any command pertaining to a speciÞc DCD card (e.g., MRC-E or PSM-E) requires that the speciÞed card be installed.

1.02 This document is reissued for the following

reasons; changes and additions are marked with change bars:

• Update the following commands to include pa-

rameters for the MRC-EA card:

— EDIT PARAMETER T1

— SET-TH-T1

— SET-ATTR-T1

— INIT-REG-T1

— RTRV-PRMTR-T1

— RTRV-COND-T1

3. DESCRIPTION

A. Conventions

3.01 The syntax and language structure used with

the 500 series systems comply with speciÞcations in BellcoreÕs TR-TSY-000831, Section 12.1 of OTGR Issue 2, Feb. 1988. As a subset of the ITUÕs MML (ManMachine Language), the language speciÞes Applications Messages which allow communication between an OS (Operations System) and an NE (Network Element) such as one of the 500 series systems.

3.02 The following conventions are used in this

manual to deÞne the syntax of input and response messages:

< > enclose parameters which must be used

[ ] enclose optional parameter(s)

{ } enclose a series of parameters, at least one of

which must be used

| separates a list of parameters within the { }

symbols, of which one and only one parameter may be selected

— RTRV-ALM-T1

— RTRV-ATTR-T1

— RTRV-TH-T1

• Update documentation where necessary to in-

clude information regarding the MRC-EA card.

• Update Table A to include the new parameters

2. USING THIS PRACTICE

2.01 Part 3, Description, describes how to use the

commands and read the responses, including: explanations of the typestyle conventions and syntax, Þnding a command to perform a desired task, deÞnitions of the parameters, and other useful information.

2.02 Part 4, Commands, contains the commands,

each one starting at the top of a page. Each command has a description, a format, examples, values for the parameters, and responses to the command.

" " enclose a report of an alarm or event

: separates parameter blocks

... indicates one or more parameters are re-

peated an appropriate number of times, and hence are omitted

, separates parameters within a block

; terminates a command and causes execution

of the command

B. Application Message Types

3.03

Two TL1 standard types of messages are used:

a. Input/Response , a command with valid pa-

rameters is input to the 500 series system and a response message is returned.

b. Automatic , a message is generated by the 500

series system, stored in the Event Log, and sent to the Communications Port.

Page 2

Issue 3: Mar 96 TMSL 097-45018-02

C. Command Deﬁnitions

3.04 A command consists of a Command Code fol-

lowed by a colon, parameter blocks separated by colons, and a terminating semicolon; see Figure 1 for an example. A command can only be entered at the semicolon prompt (;).

3.05 Parameter blocks may be null (contain no pa-

rameters), or contain one or more parameters. Two colons occur next to each other if a parameter block is null. (Some parameters in the complete TL1 language set are not used. These unused parameters are left null in this command set.) Colons after the last active parameter and before the semicolon need not be entered.

Multiple parameters in a parameter block are

3.06

separated by commas. Two commas occur next to each other if a parameter is null. Commas after the last active parameter and before a colon or semicolon need not be entered.

3.07 Entering a semicolon at the end of the com-

mand causes the command to execute.

3.08 If any mistakes are made while entering a

command, send the bad command and reenter a good command. The system does not recognize edited commands.

3.09 In this practice, uppercase letters in a com-

mand are parameter values to be entered as shown. Lowercase letters in a command indicate a choice of values is available for that parameter. The values speciÞc to that command are listed with the command.

D. Response Deﬁnitions

3.10 A response is returned by the 500 series sys-

tem when it receives a command. All responses include the source identiÞer (the sender of the response), the date and time, and the correlation tag of the given command. A response to a command may be a Completed or an Error response.

Completed : The command has been completed

or information requested is returned. This re-

sponse carries the COMPLD message.

b. Error : The command was denied, and the re-

sponse carries the DENY message. The Error

Code parameter (errcde) shows the reason.

Note: All external communications ports are

software-configurable to set one character as the end-of-text message. This character does not replace the TL1 specified end-of-text message terminator (;). Refer to the instructions for the ED-EQPT command for additional information.

Parameters

SET-DAT:[<tid>]::<ctag>:<date>,<time>;

Command Code

Null parameter block

Optional

parameter block

Parameter block

Example of a command format

Parameter b lock with parameters separated by a comma

SET-DAT:::111:951208,153500;

Example of a command generated using the above format

Figure 1. Command Format

Terminating

semicolon

Page 3

TMSL 097-45018-02 Issue 3: Mar 96

E. Parameter Deﬁnitions and Values

3.11 The TL1 commands use parameters that di-

rect and constrain their operation. The general definitions of the parameters, and the type of message in which they appear, are listed in Table A. The values of the parameters are listed with the command.

Table A. Parameter Deﬁnitions

USED IN

MESSAGE

PARAMETER

aid Command,

almcde Response This parameter is the alarm code. It identiﬁes the severity of the alarm. If multiple

TYPE DEFINITION

This parameter is the access identiﬁer. When used in a command, the aid is the

response

equipment that the command affects. When seen in a response, the aid is the equipment reporting the condition.

alarms are reported, the value for almcde is the highest severity of those reported.

F. Task/Command Cross-reference

3.12 Consult Table B to Þnd the command appro-

priate for a task. This table also lists whether or not a command is password protected. Protected commands can only be accessed if the user logged on with a password. Unprotected commands can be accessed with or without a password.

atag Response This parameter is the automatic message tag, a decimal number with a maxi-

mum of 3 characters (1 through 999). It is assigned by the system to sequence and correlate automatic messages.

baud Command,

response

compri Command,

response

comtype Command,

response

condeff Automatic

message

conddescr Response This parameter is the condition description. It is a text description of the alarm or

condtype Command,

response, automatic message

This parameter is the communications port baud rate; the baud rate for COM2 can only be changed via DIP switch on the MIS card; ports 1 and 3 are softwareconﬁgurable only.

This parameter speciﬁes the priority level of the communications port from 0 to 3; 0 inhibits alarm/event messages from being transmitted from a port; 1 is the highest priority, and 3 is the lowest.

This parameter indicates the type of communications device used (X25 [PAD], MODEM, or [dumb] TERM)

This parameter is the condition effectivity. It reports that a standing condition is raised (SC), or that it is cleared (CL). This parameter is the only difference between a response that raises a standing condition, and a response that clears the same standing condition. If a standing condition is raised, it can be retrieved using the RTRV-COND-ALL or RTRV-COND-EQPT commands.

condition reported by the system, enclosed within escaped quotes (\"). The system returns one conddescr per response message.

This parameter is the condition type. When used in a command, it indicates the type of alarm condition requested. When seen in a response , it indicates the type of alarm condition being reported, which is fur ther explained in the conddescr parameter. When seen in an automatic message, it indicates the type of alarm condition reported as either raised or cleared (see the conddescr parameter).

Page 4

Issue 3: Mar 96 TMSL 097-45018-02

Table A. Parameter Deﬁnitions (Contd)

USED IN

MESSAGE

PARAMETER

crcmode Command This parameter speciﬁes whether the selected Multi-Reference Controller (MRC)

TYPE DEFINITION

reference uses CRC validation.

ctag Command,

response

date Command,

response

endoftext Command,

response

errcde Response This parameter is the error code retur ned by the system. It is a four-character

fmode Command This parameter speciﬁes the framing format for the selected MRC reference. keepalive Command,

response

This parameter is the correlation tag. The operator must enter a ctag for each command. This is the method the system uses to communicate the results of the command. For example, if “111” was entered as a ctag in a command, the response contains “111 COMPLD” or “111 DENY”.

If two commands were entered with the same ctag and one command was completed but the other was in error, both responses would have the same identiﬁcation number. The operator may not be able to identify the command to re-enter.

The ctag has a maximum of 6 characters beginning with either a letter or a numeral. It is assigned by the operator and must be included in a command.

This parameter is the current date in the 6-digit form yy-mm-dd (year, month, day). For example, 95-12-08 is December 8, 1995. To enter the date in a command, do not use the hyphens. For example, 951208 is December 8, 1995.

This parameter is the end-of-text terminator; it does not replace the TL1-speciﬁed end-of-text terminator (;).

mnemonic that identiﬁes the reason the command was denied.

This parameter is the keepalive message; if enabled, the keepalive message is sent every 15 to 20 minutes and consists of the response to the RTRV-HDR command (with the ctag used with this ED-EQPT command)

localecho Command,

response

mondat Command,

response

monmode Command,

response

montm Command,

response

montype Command,

response

monval Command,

response

This parameter enables or disables the local echo function; if enabled, local echo causes each character to be echoed back to the terminal when entered.

This parameter is the date of the beginning of the requested performance-monitoring period speciﬁed by the tmper parameter.

This parameter determines whether a port is allowed to view data trafﬁc associated with other ports in real-time

This parameter is the beginning time of day of the requested performance-monitoring period speciﬁed by the tmper parameter.

This parameter is the type of performance-monitoring register in the memory storage.

This parameter is the value in the speciﬁed performance-monitoring register.

Page 5

TMSL 097-45018-02 Issue 3: Mar 96

Table A. Parameter Deﬁnitions (Contd)

USED IN

MESSAGE

PARAMETER

TYPE DEFINITION

ntfcncde Command,

response

pid Command This parameter speciﬁes the password identiﬁcation; a pid is limited to a maxi-

priority Command This parameter speciﬁes the prior ity of the references available at the MRC. The

sid Response This parameter is the source identiﬁer. It identiﬁes the system sending the

srveff Command,

response

state Command This parameter contains the primary maintenance state (in-service or out-of-ser-

This parameter is the notiﬁcation code, indicating the severity of the alarm or event. When used in a command, it requests only those alarms or events of that severity level. When seen in a response, it indicates the severity of the alarm or event.

mum of 10 (upper, lower, or mixed case) characters.

reference with priority 1 is used ﬁrst, then the priority 2 reference, and so on.

response or automatic message. The sid in a response message matches the tid in the input command, if a tid was used.

The sid must be a valid TL1 identiﬁer of no more than 20 characters, limited to letters, numerals and hyphens, beginning with a letter. The sid is recommended to be the target’s ofﬁce name, if available. All systems are manufactured with the sid TELECOMSOLUTIONS as the default. Assign unique sids in a multi-system installation with the SET-SID command.

Note: The sids on the expansion shelves are automatically assigned. This parameter identiﬁes how the alarm condition affects service.

vice) into which the unit is moved, and may contain a secondary maintenance state indication that identiﬁes a reason for the move to that maintenance state.

tid Command This parameter is the target identiﬁer. Use this parameter in a command if there

are multiple systems and you want to address a system other than the current one. If this parameter is not used, the command goes to the current system.

The tid must be a valid sid, the name assigned to the target system with the SETSID command. The sid in the response message is the same value as the tid.

time Command,

response

tmper Command,

response

type Command This parameter speciﬁes the type of reference (GPS, Cesium, etc.) the selected

typereq Command This parameter is the type of condition or state to be retrieved.

Page 6

This parameter is the current time in the 6-digit form hh:mm:ss (hours, minutes, seconds). For example, 15:46:06 is 3:46:06 pm. To enter the date in a command, do not use the colons. For example, 154606 is 3:46:06 pm.

This parameter is the accumulation time period for the speciﬁed performancemonitoring information.

MRC reference uses.

Issue 3: Mar 96 TMSL 097-45018-02

Table B. Task/Command Cross-reference

CAN BE

TASK COMMAND / MESSAGE PAGE

SECURITY

Allows user to log on ACT-USER 14 No Allows user to log off CANC-USER 16 Yes Allows user to change password ED-SECU-PID 18 No

CARD CONFIGURATION AND CONTROL

Changes communications port conﬁguration ED-EQPT 20 Yes Changes reference parameters ED-PRMTR-T1 22 Yes Sets or clears performance-monitoring registers INIT-REG-T1 24 Yes

PROTECTED

Initializes (clear) the system INIT-SYS 27 Yes Silences audible alarms OPR-ACO-ALL 29 Yes Takes equipment out of service RMV-T1 31 No Puts equipment in service RST-T1 33 No Clears 64-event system log SET-ATTR-LOG 35 Yes Sets notiﬁcation code associated with a speciﬁc

event Sets system date and time SET-DAT 39 Yes Sets system identiﬁcation code (source identiﬁer) SET-SID 41 Yes Sets threshold for equipment parameters SET-TH-T1 43 Yes Switches to duplicate equipment SW-DX-EQPT 45 Yes

SET-ATTR-T1 37 Yes

Page 7

TMSL 097-45018-02 Issue 3: Mar 96

Table B. Task/Command Cross-reference (Contd)

TASK COMMAND / MESSAGE PAGE

RETRIEVE ALARMS (MANUAL AND AUTOMATIC)

Displays alarms for all or speciﬁc equipment RTRV-ALM- {ALL|EQPT|T1} 46 No Displays the occurrence of alarmed events REPT-ALM- {EQPT|T1} 54 No Displays the occurrence of nonalarmed events REPT-EVT 58 No Displays alarms and events in 64-event system log RTRV-LOG 61 No

CARD INFORMATION AND DATE

CAN BE

PROTECTED

Displays notiﬁcation code and condition type associated with a speciﬁc event

Displays condition of all or speciﬁc equipment that is not in alarm

Displays sid, date, and time (to v e rify equip. data path) RTR V-HDR 72 No Displays communications port conﬁguration informa-

tion for a speciﬁc port Displays performance-parameter data RTRV-PRMTR-T1 77 No Displays performance-monitoring data RTRV-PM-T1 79 Yes Displays threshold for equipment parameter RTRV-TH-T1 83 Yes

G. Alarm Message Format

3.13 In the event an alarm is detected, a message is

displayed on the terminal. The alarm message format displayed is as follows:

"<aid>:<ntfcncde>,<condtype>,<srveff>: \"[<conddescr>]\"

3.14 The

affects.

3.15 The

cating the severity of the alarm or event.

3.16 The

dicates the type of alarm condition reported as either

<aid>

is the equipment that the command

is the notiÞcation code, indi-

is the condition type which in-

RTRV-ATTR-T1 63 No

RTRV-COND- {EQPT|T1} 66 No

RTRV-EQPT 74 No

raised or cleared, which is also further explained in the conddescr parameter.

3.17 The

identiÞes how the alarm condition affects service.

3.18 The

alarm or condition reported by the system, enclosed within escaped quotes(\'').

3.19 Refer to Table C for a list of alarm messages;

the table is divided into two sections, one for alarm messages received from the GTI and the other section lists system alarm messages. The section for the GTI messages lists the entire terminal display; the section for the system messages lists only the condition description. Refer to Table A for additional information regarding the parameters for the alarm message format.

is the service effectivity which

is a text description of the

Page 8

Issue 3: Mar 96 TMSL 097-45018-02

Table C. Terminal Alarm Displays

DISPLAY MEANING

GTI MESSAGES

''GTI-x:GPS-FREQTOL,SC:\''GPS FREQ T OL\'' The GTI has determined that, compared to oscil-

lators A and B, the GPS timing solution from the GTR is out of tolerance (factory set) (x = 1 or 2).

''GTI-x:MN,OSCA-LOS,SA:\''OSC LOSS OF SIGNAL\'' The GTI detects no signal energy on OSC A

input (x = 1 or 2).

''GTI-x:MN,OSCB-LOS,SB:\''OSC LOSS OF SIGNAL\'' The GTI detects no signal energy on OSC B

input (x = 1 or 2).

''GTI-x:MJ,GPS-LOS,SA:\''GPS LOSS OF SIGNAL\'' The GTI detects no signal energy on the GTR

ﬁber link. This condition has exceeded the period of time set via DIP switch and has escalated into a major alarm (x = 1 or 2).

''GTI-x:MN,GPS-INVLD,NSA:\''GPS INVALID The timing information from the GTR has been

determined to be invalid for timing at this time (x = 1 or 2).

''GTI-x:MN,GTI-OUTFLT,SA:\''GTI OUT FAULT\'' The primary rate output of the GTI has been

faulted by a short, improper termination, or equipment failure (x = 1 or 2).

''GTI-x:MN,GTR-PWR,SA:\''GTR POWER FAULT\'' The GTR power supply has been faulted by a

short, an open, or equipment failure (x = 1 or 2).

''GTI-x:MN,FB,SA:\''FUSE OR POWER FAIL\'' A fuse of the DCD-LPR shelf has blown, or an

ofﬁce battery has failed (x = 1 or 2).

''GTI-x:MN,GTI-F AILxx,SA:\''GTI F AIL\'' The GTI has experienced a failure. Where x = 1

or 2, and xx = 1 through 3. The xx numbers are diagnostic codes for ﬁeld service/engineering use only.

''GTI-x:MN,GTR-FAILxx,SA:\''GTR FAIL\'' The GTR has experienced a failure. Where x =

1 or 2, and xx = 1 through 5. The xx numbers are diagnostic codes for ﬁeld service/engineering use only.

Page 9

TMSL 097-45018-02 Issue 3: Mar 96

Table C. Terminal Alarm Displays (Contd)

DISPLAY MEANING

SYSTEM MESSAGES

\''ALARM INDICATION SIGNAL RECEIVED\'' Received alarm indication \''CARD FAIL\'' Card has failed \''CLOCK ACTIVE\'' Clock is active \''CLOCK FREERUNNING\'' Clock is in the freerunning mode \''CLOCK IN HOLDOVER\'' Clock is in the holdover mode \''CLOCK NOT CONVERGED\'' Clock is not locked to the input signal \''DISCIPLINING REFERENCE SWITCHED\'' Timing input has switched to another reference \''EXPANSION MAJOR\'' Expansion shelf has a major alarm \''EXPANSION MINOR\'' Expansion shelf has a minor alarm \''FRAMER FAILURE\'' Framing \''FUSE OR POWER FAIL\'' Fuse or power at DCD system has failed \''INPUT OUT OF TOLERANCE\'' Input signal is out of the clock unit’ s pull-in r ange \''INPUT ACTIVE\'' Input signal is active \''LOSS OF SIGNAL\'' Signal is lost \''LOSS OF ALL PRIMARY TIMING INPUT REFERENCES\'' All primary timing input references have been

lost \''LOSS OF STRATUM A INPUT\'' Input from clock in ST A slot has been lost \''LOSS OF STRATUM B INPUT\'' Input from clock in ST B slot has been lost \''OUTPUT SYNC PORT FAIL\'' Output port on an output card has failed \''ST SYNTH SIGNAL FREQ DRIFT\'' The synthesized signal from the clock card is

showing frequency drift \''SYNC INPUTS UNLOCKED\'' Synchronization inputs are unlocked \''SYNC INPUT FAILED\'' Input reference signal input has failed \''SYNC SYSTEM FAIL\'' Entire system has failed \''THRESHOLD VIOLATION FOR BPV\'' Bipolar violation threshold has been exceeded

Page 10

Issue 3: Mar 96 TMSL 097-45018-02

Table C. Terminal Alarm Displays (Contd)

DISPLAY MEANING

SYSTEM MESSAGES (CONTD)

\''THRESHOLD VIOLATION FOR CRC\'' Cyclic redundancy check threshold has been

exceeded

\''THRESHOLD VIOLATION FOR FFREQ\'' Fractional frequency threshold has been

exceeded \''THRESHOLD VIOLATION FOR MTIE OBSERVATION\'' An MTIE threshold has been exceeded \''THRESHOLD VIOLATION FOR MTIE1 OBSERVATION\'' Threshold for MTIE 1-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE4 OBSERVATION\'' Threshold for MTIE 4-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE16 OBSERVATION\'' Threshold for MTIE 16-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE64 OBSERVATION\'' Threshold for MTIE 64-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE128 OBSERVA TION\'' Threshold for MTIE 128-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE512 OBSERVA TION\'' Threshold for MTIE 512-second observation has

been exceeded \''THRESHOLD VIOLATION FOR MTIE900 OBSERVA TION\'' Threshold for MTIE 900-second observation has

been exceeded \''THRESHOLD VIOLATION FOR TVAR1 OBSERVATION\'' Time variance for TVAR 1-second observation

has been exceeded \''THRESHOLD VIOLATION FOR TVAR4 OBSERVATION\'' Time variance for TVAR 4-second observation

has been exceeded \''THRESHOLD VIOLATION FOR TVAR16 OBSERVATION\'' Time variance for TVAR 16-second observation

has been exceeded \''THRESHOLD VIOLATIONFOR TVAR64 OBSERVATION\'' Time variance for TVAR 64-second observation

has been exceeded \''THRESHOLD VIOLA TION FOR TV AR128 OBSERV ATION\'' Time variance for TVAR 128-second \''THRESHOLD VIOLATION FOR OOF\'' Out-of-frame threshold has been exceeded <null> No descriptive information exists

Page 11

TMSL 097-45018-02 Issue 3: Mar 96

4. COMMANDS

4.01 The commands used with the 500 series sys-

tems are listed in this section. Each command starts on a separate page with the command code, message category, and type. The Þrst two paragraphs describe what the command is and what it does. The command paragraph shows the format and syntax of the command, shows an example of the command and what the example accomplishes, and provides the values for the parameters. The completed and error response formats are shown, with examples and messages that may be displayed for the parameters. Parameter deÞnitions are listed in Table A. For a list of the available commands, refer to Table B. Operational considerations are listed in Table D.

The command types include:

4.02

• Security

• Card conÞguration and control

• Retrieve manual and/or automatic alarms

• Card information and date

4.03 Security for the MIS -14 card is controlled by

two items: a password entered by command and a switch setting on the card (section 4 of SW1; see Figure 2). When assigning a password, the password is assigned to a speciÞc port. Only one password per port is allowed, and only one user per port is allowed at any one time.

4.04 From the factory, no password is entered and

the switch is set for no protection (section 4 is in the ON position). When set for no protection, all commands can be accessed without logging onto the system.

4.05 To activate protection, section 4 of SW1 must

be set to OFF and a password must be entered. A password is entered by using the mand. Once a valid password is entered, the protected commands (listed in Table B) can be accessed only by logging onto the system using the mand with the correct password. Those commands which cannot be protected (listed in Table B) can always be accessed without logging on.

4.06

Protection can be removed by either setting sec-

tion 4 of SW1 to ON or removing the password. The

ED-SECU-PID

word (or change the password). Refer to the

ED-SECU-PID

moving or changing a password.

4.07 If the

the system, the off. However, the user will be automatically logged off if no activity is detected for 5 minutes.

4.08 Card conÞguration and control commands are

used to conÞgure card and system parameters.

4.09 Retrieve manual and/or automatic alarm com-

mands are used to obtain alarm information.

4.10 Card information and date commands are used

to obtain MRC and/or PSM-E card information.

command is used to remove the pass-

command description for details on re-

ACT-USER

CANC-USER

command is used to log onto

ED-SECU-PID

ACT-USER

command is used to log

com-

Table D. Operational Considerations

NUMBER CONSIDERATION

1 All systems are shipped with the factory-set sid TELECOMSOLUTIONS. In multi-system installa-

tions, the SET-SID command sets a unique sid for each system before entering other commands.

2 Upon initial installation of the MIS card, it is recommended to set the time and date using the

SET-DAT command to allow for proper event correlation.

3 In a shelf, clock cards and clock input cards are labeled A and B. In the commands and

responses, these cards are designated 1 and 2. For example, input 4 of cloc k input card MRC A

is designated MRC-1-4 in the commands and responses. 4 All clock input cards are designated MRC, whether the y are ECI cards , ACI cards, or MRC cards. 5 If multiple autonomous alarms appear that include a major (MJ) alarm and a card failure (CARD

FAIL), ignore the MJ CARD FAIL message.

Page 12

Issue 3: Mar 96 TMSL 097-45018-02

SW1

LOCATED ON THE DAUGHTER BOARD

INDICATES OFF

INDICATES ON

Note: All switches are shown in the factory-set position.

J4 J5 J6 J7 J8 J9

LOCATED ON THE MOTHER BOARD

MOTHER BOARD

DAUGHTER BOARD

SET ALL JUMPERS TO THIS POSITION FOR LOCAL COMM

Note: When setting jumpers, if set for local comm, all ports will be local only; if set for RS-232,

SET ALL JUMPERS TO

all ports will be RS-232 only. THIS POSITION FOR COM2 RS-232 PORT

SW1 Switch Settings

Factory

SW1 Section Position Description

On 1200 Baud —

2 and 3

Note: Section 1 sets COM2 and the front panel RJ45 jack only (active port selected by jumpers).

Off 9600 Baud X

2=on, 3=any Odd Parity —

2=off, 3=on Even Parity — 2=off, 3=off No Parity X

On Password Protection Not Enabled X Off Password Protection Enabled — On Expansion Shelf — Off Master Shelf X On Remote System — Off Not a Remote System X

Setting

Figure 2. MIS Card Switch

Page 13

TMSL 097-45018-02 Issue 3: Mar 96

ACTIVATE USER

(ACT-USER)

MESSAGE CATEGORY: ADMINISTRATION

TYPE: INPUT

This command allows the user to log on and begin a session.

Note: During a session, if no activity is detected for five minutes, the system will initiate a CANCEL

USER and log the user off.

COMMAND

ACT-USER:[<tid>]:SUPER:<ctag>::<pid>;

pid: password identification; pid is limited to a maximum of 10 (upper, lower, or

Example:

ACT-USER::SUPER:155::CASSIOPEIA;

This example, tagged as command 155, logs onto the designated SIOPEIA and begins a session.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 95-12-08 15:04:13 M 155 COMPLD ;

mixed case) characters

<tid>

with the password CAS-

Page 14

Issue 3: Mar 96 TMSL 097-45018-02

ACTIVATE USER (Contd)

ERROR RESPONSE

M <ctag> DENY

;

errcde: ENEQ = not equipped

IIAC = invalid aid ICNV = command not valid IICT = invalid ctag IDNV = data not valid IISP = invalid syntax or punctuation IITA = invalid tid INUP = unimplemented non-null parameter SARB = system resources are busy SCSN = invalid sequence SDNA = duplex unit not available SROF = requested operation failed SNVS = not in valid state

Example:

M 155 DENY

;

TELECOMSOLUTIONS 95-12-08 15:12:47

IISP

Page 15

TMSL 097-45018-02 Issue 3: Mar 96

CANCEL USER

(CANC USER)

MESSAGE CATEGORY: ADMINISTRATION

TYPE: INPUT

This command logs the user out and ends the session. There is also a timeout feature; if no activity is detected for a five minute period, the system will initiate a CANCEL USER command.

COMMAND

CANC-USER:[<tid>]:SUPER:<ctag>;

Example:

CANC-USER::SUPER:155;

This example, tagged as command 155, logs out and ends a session.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 95-12-08 15:04:13 M 155 COMPLD ;

Page 16

Issue 3: Mar 96 TMSL 097-45018-02

CANCEL USER (Contd)

ERROR RESPONSE

M <ctag> DENY

;

errcde: ENEQ = not equipped

Example:

M 155 DENY

;

TELECOMSOLUTIONS 95-12-08 15:12:47

IISP

Page 17

TMSL 097-45018-02 Issue 3: Mar 96

EDIT SECURITY PASSWORD

(ED-SECU-PID)

MESSAGE CATEGORY: ADMINISTRATION

TYPE: INPUT

This command allows the user to change passwords.

Notes:

1. For password protection to be enabled, DIP switch SW1, section 4, of the MIS card must be set to the OFF position.

2. To password protect all commands which can be protected (see Table B), a password must be entered. The factory-setting is no password. As long as there is no password, no protection is performed.

3. To remove the password and assign a new password (for example, used if the password is forgotten), perform the following:

a. Remove the MIS card and set DIP switch SW1, section 4, to ON.

b. Replace the MIS card and let it go through the power up sequence.

c. Rename the password using the

d. Remove the MIS card and set DIP switch SW1, section 4, to OFF.

e. Replace the MIS card and let it go through the power up sequence.

COMMAND

ED-SECU-PID

command.

ED-SECU-PID:[<tid>]:SUPER:<ctag>::<pid>,<newpid>;

pid: password identification new pid: maximum of 10 (upper, lower, or mixed case) characters default pid: null; if a null password is detected, the system is placed in the non-secure (no

password protection) mode.

Example:

ED-SECU-PID::SUPER:150::,ORION;

Example:

Page 18

This example, tagged as command 150, changes the null password to ORION.

ED-SECU-PID::SUPER:155::ORION,CASSIOPEIA;

This example, tagged as command 155, changes the old password (ORION) to CASSIOPEIA.

Issue 3: Mar 96 TMSL 097-45018-02

EDIT SECURITY PASSWORD (Contd)

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 95-12-08 15:04:13 M 155 COMPLD ;

ERROR RESPONSE

<sid> <date> <time> M <ctag> DENY

<errcde> ;

Example:

M 155 DENY

;

errcde: ENEQ = not equipped

TELECOMSOLUTIONS 95-12-08 15:12:47

IISP

Page 19

TMSL 097-45018-02 Issue 3: Mar 96

EDIT EQUIPMENT

(ED-EQPT)

MESSAGE CATEGORY: ADMINISTRATION

TYPE: INPUT

This command allows the user to select the communications device type.

COMMAND

ED-EQPT:[<tid>]:<aid>:<ctag>::[<baud>],[<monmode>], [<keepalive>],

[<comtype>],[<endoftext>],[<localecho>],[<compri>];

where: aid: COM-1 = COM port 1

COM-2 = COM port 2 COM-3 = COM port 3

baud: 1200 = 1200 bps (factory set for Ports 1 and 3)

9600 = 9600 bps <null> = no change

monmode: ALW = allows a port to view data traffic associated with other user ports

in real-time

INH = inhibits a port from viewing data traffic associated with other

user ports in real-time (factory set for all ports)

<null> = no change

keepalive: ALW = allows a port to autonomously output a COMPL message every

15 to 20 minutes

INH = inhibits a port from autonomously outputting a COMPL message

every 15 to 20 minutes (factory set for all ports)

<null> = no change

comtype: X25 = PAD

MODEM = modem TERM = dumb terminal (factory set for all ports at powerup) <null> = no change

endoftext: 0 to 0xFF = sets the 1 character at the end-of-text message. This character

does not replace the TL1 end-of-text terminator (;). 0 indicates no end-of-text message (factory set for all ports); 0xFF is a hexadecimal number range (the prefix 0xFF is not required)

localecho ALW = allows local echo

INH = inhibits local echo (factory set for all ports) <null> = no change

compri: 0 = inhibits alarm/event messages from being transmitted from a

port

1, 2, or 3 = allows alarm/event messages to be transmitted from a port; 1 is

the highest priority, 3 the lowest (factory setting is 1 for ports 1 and 2, 0 for port 3)

<null> = no change

Page 20

Issue 3: Mar 96 TMSL 097-45018-02

EDIT EQUIPMENT (Contd)

Example:

ED-EQPT::COM-1:115::9600,,X.25,,,;

This example, tagged as command 115, identifies port COM1 as set for 9600 baud, using a PAD as the communications device, and using the factory settings for the remaining parameters.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 95-12-08 15:04:13 M 170 COMPLD ;

ERROR RESPONSE

<sid> <date> <time> M <ctag> DENY

<errcde> ;

Example:

TELECOMSOLUTIONS 95-12-08 15:12:47 M 170 DENY

IISP ;

errcde: ENEQ = not equipped

Page 21

TMSL 097-45018-02 Issue 3: Mar 96

EDIT PARAMETER T1

(ED-PRMTR-T1)

MESSAGE CATEGORY: PROVISIONING

TYPE: INPUT/RESPONSE

This command modifies the facility parameter values for priority, reference type, framing, and CRC that are stored in the system database. If the priority of the reference is reassigned, the other references rearrange their priorities automatically, for example, if MRC-1-2 (MRC A of span 2) is assigned a priority 4, the priority for MRC-1-3 becomes second, MRC-1-4 becomes third, and so on.

COMMAND

ED-PRMTR-T1:[<tid>]:<aid>:<ctag>:<priority>,<ref type>,

<signal type>,[<fmode>],[<crcmode>];

aid: MRC-1-x = Multi-Reference Controller A (x = span 1 to 4)

MRC-2-x = Multi-Reference Controller B (x = span 1 to 4) PSM-x-y = Precision Sync Monitor card (x = 1 to 9, y = span 1 to 4 or

ALL)

Examples:

priority: MRC-E and MRC-EA only (null for PSM):

1 to 4 = priority of the reference, 1 is highest priority

ref type: MRC-E and MRC-EA only (null for PSM):

GPS = global positioning system reference LORAN = LORAN reference CESIUM = cesium reference NETWORK = network reference

signal type: MRC-EA only:

ANALOG = analog signal E1 = E1 signal (factory setting)

fmode: MRC-E, MRC-EA, and PSM:

CAS = CAS framing CCS = CCS framing <null> = CCS framing at powerup; after that, framing is set by the

last setting

crcmode: MRC-E, MRC-EA, and PSM:

NONCRC4 = do not use CRC4 (factory set if E1 is selected) CRC4 = use CRC4 <null> = current crcmode does not change

Page 22

ED-PRMTR-T1::MRC-2-2:154:1,NETWORK,,CCS,NONCRC4;

This example, tagged as command 154, commands MRC B of span 2 to be the first priority reference, specifies it is using a network reference, E1 signal type, CCS framing, and no CRC4.

Issue 3: Mar 96 TMSL 097-45018-02

EDIT PARAMETER T1 (Contd)

ED-PRMTR-T1::MRC-2-2:154:1,NETWORK,ANALOG;

This example, tagged as command 154, commands MRC B of span 2 to be the first priority reference, specifies it is using a network reference and analog signal type; framing mode, and crcmode parameters are not available and will cause an error to be initiated if input.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 96-02-08 15:04:14 M 154 COMPLD ;

ERROR RESPONSE

<sid> <date> <time> M <ctag> DENY

<errcde> ;

errcde: ENEQ = not equipped

Example:

TELECOMSOLUTIONS 96-02-08 15:04:14 M 154 DENY

IISP ;

REFERENCE

AT&T 365-340-202, August, 1992

Page 23

TMSL 097-45018-02 Issue 3: Mar 96

INITIALIZE REGISTER T1

(INIT-REG-T1)

MESSAGE CATEGORY: SURVEILLANCE

TYPE: INPUT/RESPONSE

This command initializes the specified performance-monitoring storage registers on the specified equipment, and sets the register to the specified value. These registers contain PM information accumulated in previous intervals. The SET-ATTR-LOG command clears the 64-event system log. The INIT-SYS command performs a Òcold restartÓ, clearing all system registers.

Note: This command may be issued only once every 60 seconds.

COMMAND

INIT-REG-T1:[<tid>]:<aid>:<ctag>::[<montype>],[<monval>]

[,,,[<tmper>],[<mondat>][,<montm>]];

aid: MRC-1-x = Multi-Reference Controller A (x = span 1 to 4 or ALL)

MRC-2-x = Multi-Reference Controller B (x = span 1 to 4 or ALL) PSM-x-y = Precision Sync Monitor card (x = 1 to 9, y = span 1 to 4

or ALL)

montype: AIS = alarm indication signal

BPV = bipolar violations CRC = cyclic redundancy check errors OOF = out of frame errors LOS = loss of signal <null> = all montypes

Note: If the aid is MRC-1-x or MRC-2-x, the montypes AIS, BPV, CRC, OOF, and LOS

are to be used only if E1 is selected as the input; if analog is the input, and AIS, BPV, CRC, OOF, or LOS are the montypes, the command will be denied.

montype: For PSM only:

MTIE1 = maximum time interval error at 1 second MTIE4 = maximum time interval error at 4 seconds MTIE16 = maximum time interval error at 16 seconds MTIE64 = maximum time interval error at 64 seconds MTIE128 = maximum time interval error at 128 seconds MTIE512 = maximum time interval error at 512 seconds MTIE900 = maximum time interval error at 900 seconds TVAR1 = time variance error at 1 second TVAR4 = time variance error at 4 seconds TVAR16 = time variance error at 16 seconds TVAR64 = time variance error at 64 seconds TVAR128 = time variance error at 128 seconds <null> = all of the above montypes

Page 24

monval: x = value in the performance-monitoring register

<null> = zero

Issue 3: Mar 96 TMSL 097-45018-02

INITIALIZE REGISTER T1 (Contd)

tmper: For PSM only:

15-MIN = time period of the register to be initialized (always 15-MIN) <null> = current time period

mondat: For PSM only:

mm-dd = date of the first initialization register <null> = current date

montm: For PSM only:

hh-mm = start of the first register to be initialized (e.g., 14-00, 14-15, 14-30,

14-45) (registers are initialized from this point to the current register)

<null> = current time

Examples:

INIT-REG-T1::MRC-1-4:143::BPV,5;

The above example, if E1 is the input, tagged as command 143, sets the current BPV performancemonitoring register to 5 at MRC A, span 4.

The above example, if analog is the input, will be denied, and an IDNV error code produced.

INIT-REG-T1::PSM-1-ALL:144::,,,,,15-MIN,06-22,14-30;

The current date and time in this example are June 23 (06-23) and 2:17 pm (14-17). The example above, tagged as command 144, sets all 24 hours of PSM performance-monitoring registers to zero, losing all stored maintenance data.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 96-02-08 15:04:14 M 143 COMPLD ;

ERROR RESPONSE

<sid> <date> <time> M <ctag> DENY

<errcde> ;

Page 25

TMSL 097-45018-02 Issue 3: Mar 96

INITIALIZE REGISTER T1 (Contd)

errcde: ENEQ = not equipped

Example:

TELECOMSOLUTIONS 96-02-08 15:04:14

M 143 DENY

IISP

;

REFERENCE

TR-NWT-00833, Issue 5, Revision 1, April 1993

Page 26

Issue 3: Mar 96 TMSL 097-45018-02

INITIALIZE SYSTEM

(INIT-SYS)

MESSAGE CATEGORY: SURVEILLANCE

TYPE: INPUT/RESPONSE

This command performs a Òcold restartÓ by unconditionally executing the same routine performed on power-up. The cold restart initializes the system processor registers, which are on the MIS card, to the highest initialization level (9). All information except the sid, tid, date, and time are cleared. (The SETATTR-LOG command clears only the 64-event system log, and the INIT-REG-T1 command clears specific registers.) Use INIT-SYS with care.

COMMAND

INIT-SYS:[<tid>]:MIS:<ctag>::9;

Example:

INIT-SYS::MIS:110::9;

This example, tagged as command 110, erases all system information (which is stored on the MIS card) except the sid, tid, date, and time.

COMPLETED RESPONSE

<sid> <date> <time> M <ctag> COMPLD ;

Example:

TELECOMSOLUTIONS 95-12-08 15:41:32 M 110 COMPLD ;

ERROR RESPONSE

<sid> <date> <time> M <ctag> DENY

<errcde> ;

Page 27

+ 61 hidden pages

Symmetricom TimeProvider 500 series User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

1. GENERAL

3. DESCRIPTION

A. Conventions

2. USING THIS PRACTICE

B. Application Message Types

F. Task/Command Cross-reference

G. Alarm Message Format

4. COMMANDS