Anda di halaman 1dari 194

GILLAM-FEi

UNISYNCe
TL1 REFERENCE GUIDE

Written by

: C. HOUZARD

Approved by

: D. LEONARD

Quality Assurance :

Date :

24 February 2009

Doc. Ref. :

4396CHbf

Revision :

1.12

GILLAM-FEi

HISTORY SHEET

REV.

DATE

OBJECT

MODIFIED
PAGES

1.0

21 Dec 05

Creation of document for UNISYNCe


Software version 1.0

1.1

2 May 06

Update of document for UNISYNCe


Software version 1.1

1.2

21 Sep 06

Update of document for UNISYNCe


Software version 1.4

1.3

11 Oct 06

Update of document for UNISYNCe


Software version 1.4.4

1.4

20 Dec 06

Update of document for UNISYNCe


Software version 1.5
Support of new parameters:

1.5

25 Jan 07

NTPACT (SSU data dictionary)

CONF and FACTORYRESET


(GPXM data dictionary)

FFOFFTH, TDPLLGPS and


TDPLLINP (OSC data dictionary).

Update of document for UNISYNCe


Software version 1.5.2
New management of parameters:

1.6

16 Mar 07

4396CHbf Rev. 1.12


02/24/2009

CONF, FACTORYRESET and


SITESURVEY (GPS data
dictionary).

Update of document for UNISYNCe

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

Software version 1.5.4


o Elevation and azimuth parameters added
to the RTRV-SAT response.
o Support of new Time Zones to take into
account of the new DST 2007 rules in
US and Canada:
o AZERBAIJANST
o CENTRALBRAZILIANST
o CENTRALSTMEXICO
o GEORGIANST
o JORDANST
o MIDDLEEASTST
o MONTEVIDEOST
o MOUNTAINSTMEXICO
o NAMIBIAST
o PACIFICSTMEXICO.
o Delete of the following Time Zones to
take into account of the new DST 2007
rules in US and Canada:
o MEXICOST
o MEXICOST2.
o Support of two new alarms affecting the
SSU object:
o OSCMISSING alarm
o FPGAERR alarm.
o Modification of the alarm description
text for the UDCCOMERR alarm
affecting the GPS object.
1.7

6 Jun 08

Update of document for UNISYNCe


Software version 1.7
Support of the E1 FeedBack Monitoring
card:
new type of output module: E1FBM
new AID: FBM

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

new FBM data dictionary


new FBM <condtype> table
new <montype> DFF
update of the SCHED-PMREPT
command
new DFF REPT^PM message
new FBM PDMA examples:
provisioning and real time
supervision.

Support of new parameters:

WTRTIM (INP data dictionary)

WTRTIM (GPS data dictionary).

Support of new TL1 commands: SET-TH


and RTRV-TH.
Update of the INP <condtype> table.
Update of the OSC <condtype> table.
1.8

6 Aug 08

Update of document for UNISYNCe


Software version 1.7.1
Support of the NTP v4 TOD protocol on the
UNISYNCe TOD serial interface:
new parameter TODACT in the SSU
data dictionary to provision the TOD
protocol support
new "TOD Time Of Day on serial
interface" paragraph in the
appendices to explain the format of
the TOD messages and the TOD
physical interface.
Update of the INP <condtype> table and of
the GPS <condtype> table. A new "Input
signal validation" message is now reported
by the inputs and the GPS.
Update of the FBM <condtype> table. The
"Bad Frequency detected" alarm which was
reported by a FeedBack Monitoring object
(FBM) is now replaced by a "Configuration
error" alarm message.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

1.9

28 Aug 08

Update of document for UNISYNCe


Software version 1.7.2
New parameters indicating the state of the
LEDs available in the following objects:

SSU object

INP objects

OSC object

GPS object.

New "LED state change" message reported


from the following objects:

SSU object

INP objects

OSC object

GPS object.

Revision of the
documentation.
1.10

2 Sep 08

TOD

Frame

format

Update of document for UNISYNCe


Software version 1.7.3
Support of the "MTU" parameter in the SSU
object.

1.11

3 Oct 08

Update of document for UNISYNCe


Software version 1.7.4
Support of a new GPSDATE event
indicating the synchronization of the
UNISYNCe date/time to the GPS date/time.

1.12

24 Feb 09

Update of document for UNISYNCe


Software version 1.7.8
Support of a new DCF77 input module.
Support of an SNMP v1/v2c agent:

4396CHbf Rev. 1.12


02/24/2009

Examples of SNMP v1/v2c agent


configuration.

New SNMP v1/v2c data dictionary.

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

TABLE OF CONTENTS

1.

INTRODUCTION

2.

MEMORY ADMINISTRATION (GR-199-CORE)

2.1.

Introduction

2.2.



TL1 Database Model


Conceptual Database level
Logical Database level

2
2
2

2.3.

UNISYNC Memory administration functions

2.4.

Message structure

2.5.

UNISYNC Administration views

2.6.


Memory Administration Supported TL1 messages


Common Provisioning Input Commands
2.6.1.1.
RTRV-AO

Common Provisioning Autonomous Messages
2.6.1.2.
REPT^DBCHG

System Dependent Data Management Commands
2.6.1.3.
ED-DAT
2.6.1.4.
RTRV-NETYPE
2.6.1.5.
RTRV-NETYPE-ALL
2.6.1.6.
SET-SID

UNISYNC Provisioning Commands
2.6.1.7.
AID Format Description
2.6.1.8.
Provisioning Commands

7
7
7
9
9
11
11
13
14
16
17
17
19

2.7.

Data dictionaries

24

2.8.















Examples of PDMA functions


General comment
Provisioning of the SSU object
Configuration of the SNMP v1/v2c agent
Provisioning of the GPS object
Site Survey
Provisioning of an AUX output
Provisioning of an OUT output
Provisioning of a group of outputs
Provisioning of a Feedback Monitoring input
Real time supervision of a Feedback Monitoring input
Provisioning of an INP synchronization input
Provisioning of the TOD serial protocol
Reset of the Unisync
Factory reset of the Unisync

24
24
24
24
25
26
26
26
27
27
27
28
28
28
28

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi







3.

Forced Reference Switch


Manual Reference Switch
Modification of the CRAFT ports parameters
Modification of some Telnet parameters
Modification of some TL1MNG resources

MAINTENANCE AND SURVEILLANCE MANAGEMENT (GR833-CORE)


3.1.

Introduction

31
31

3.2.


Supported messages
Input Commands and Responses
3.2.1.1.
ALW-MSG
3.2.1.2.
HELP
3.2.1.3.
INH-MSG
3.2.1.4.
INIT-LOG
3.2.1.5.
INIT-REG
3.2.1.6.
INIT-SYS
3.2.1.7.
MENU
3.2.1.8.
OPR-ACO
3.2.1.9.
RTRV-ALM
3.2.1.10. RTRV-ATTR
3.2.1.11. RTRV-COND
3.2.1.12. RTRV-HDR
3.2.1.13. RTRV-LOG
3.2.1.14. RTRV-PM
3.2.1.15. RTRV-SAT
3.2.1.16. RTRV-TH
3.2.1.17. SCHED-PMREPT
3.2.1.18. SET-ATTR
3.2.1.19. SET-TH

Automatic Messages
3.2.1.20. REPT^ALM
3.2.1.21. REPT^EVT
3.2.1.22. REPT^PM

4.

28
29
29
29
30

31
32
32
34
35
36
37
38
39
40
41
43
45
47
48
50
53
55
57
59
61
62
62
64
66

SECURITY ADMINISTRATION (TR-NWT-835)

68

4.1.

Introduction

68

4.2.

Data Model of NESSA

68

4.3.

UNISYNC NESSA functions

68

4.4.

Message structure

69

4.5.


Supported messages
Security Commands
4.5.1.1.
ACT-USER
4.5.1.2.
ALW-USER-SECU
4.5.1.3.
CANC-CID-SECU
4.5.1.4.
CANC-USER
4.5.1.5.
CANC-USER-SECU

4396CHbf Rev. 1.12


02/24/2009

70
70
70
72
73
74
75

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

4.5.1.6.
DLT-SECU
4.5.1.7.
DLT-USER-SECU
4.5.1.8.
ED-CID-SECU
4.5.1.9.
ED-CMD-SECU
4.5.1.10. ED-PID
4.5.1.11. ED-USER-SECU
4.5.1.12. ENT-USER-SECU
4.5.1.13. INH-USER-SECU
4.5.1.14. RTRV-ALM-SECU
4.5.1.15. RTRV-CID-SECU
4.5.1.16. RTRV-CMD-SECU
4.5.1.17. RTRV-STATUS
4.5.1.18. RTRV-USER
4.5.1.19. RTRV-USER-SECU

Security Automatic Messages
4.5.1.20. REPT^ALM^SECU
4.5.1.21. CANC
4.6.

5.

76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
90
92

Data dictionaries

93

APPENDICES
5.1.



94

Procedure to upgrade UNISYNC software


Introduction
Procedure

94
94
94

Data dictionaries
Equipment data dictionaries
5.2.1.1.
SSU data dictionary
5.2.1.2.
GPXM data dictionary
5.2.1.3.
SNMP v1/v2c data dictionary
5.2.1.4.
OUTMODULE data dictionary
5.2.1.5.
GPS data dictionary
5.2.1.6.
INP input data dictionary
5.2.1.7.
AUX output data dictionary
5.2.1.8.
OUT output data dictionary
5.2.1.9.
OSC data dictionary
5.2.1.10. FBM data dictionary

Users interface port/channel data dictionary
5.2.1.11. Craft port data dictionary
5.2.1.12. TL1 remote manager data dictionary
5.2.1.13. Telnet channels data dictionary

Security data dictionary
5.2.1.14. User-Related Security data dictionary
5.2.1.15. Channel-Related Security data dictionary
5.2.1.16. Command-Related Security data dictionary

95
95
95
103
105
108
109
116
121
123
126
130
133
133
136
138
139
139
141
142

5.2.


5.3.

List of Time Zones

143

5.4.

<aid> - Access Identifier

146

5.5.

<almcde> - Alarm Code

147

5.6.

<almescl> - Alarm Escalation

148

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

6.

5.7.

Command Access Privilege (CAP) List

149

5.8.

<conddescr> - Condition Description

151

5.9.








<condtype> - Condition Types


<condtype> affecting SSU card
<condtype> affecting GPS
<condtype> affecting AUX output ports
<condtype> affecting OUT output ports
<condtype> affecting INP input ports
<condtype> affecting oscillator
<condtype> affecting FBM input ports

152
153
154
155
156
157
162
163

5.10.

<ctag> - Correlation Tag

164

5.11.

<errcde> - Error Codes

165

5.12.

<inhn> - Inhibition

168

5.13.

<logctl> - Logging Control

169

5.14.

<lognm> - Log Name

170

5.15.

<mondat> - Monitor Date

171

5.16.

<montm> - Monitor Time

172

5.17.

<montype> - Monitored Parameter Types

173

5.18.

<ntfcncde> - Notification Code

177

5.19.

<ocrdat> - Occurrence Date

178

5.20.

<ocrtm> - Occurrence Time of Day

179

5.21.

<srveff> - Service Effecting

180

5.22.

<state> - Entity State

181

5.23.

<tid> - Target Identifier

182

5.24.



TOD Time Of Day on serial interface


TOD Physical interface
TOD Frame format

183
183
183

REFERENCES

4396CHbf Rev. 1.12


02/24/2009

185

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

1.

INTRODUCTION
This document presents a description of the TL1 commands that an UNISYNC
supports in order to be fully TL1 manageable.
The data model of the UNISYNC is introduced based on the TL1 terminology
(administrative view, object entity, object instance, object attribute, data dictionary,
). All these TL1 concepts are very similar to the ones found in an object model
described in UML.
Four main functional areas of a TMN are covered:
Configuration management
Fault management
Performance management
Security management

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

2.

MEMORY ADMINISTRATION (GR-199-CORE)


2.1.

Introduction

Memory administration of the UNISYNC refers to functions such as adding, deleting


or altering data stored in the UNISYNC database.
The input commands that request database changes in a NE (UNISYNC) are known as
provisioning messages.
2.2.

TL1 Database Model

The Conceptual Database level of an NE database is defined as an arrangement of the


data elements into sets of one or more matrixes (or tables) called administrative views.
These views provide a high-level conceptual view of the major data files in the
database and identify the data elements in each file.
The Logical Database level of an NE database is a set of tables in which each data
item within each administrative view is defined in terms of its mnemonic
representation, data type, range of permissible values (domain), function and interdata
relationships. This level is presented in the form of a data dictionary.
2.2.1. Conceptual Database level
The administrative views are conceptual, representing the various data elements in the
form of tables or matrixes. Each row of the tables represents an instance of an object
entity of the NE that is a logical service or physical resource entity associated with the
NE. Each column of the tables represents a parameter (attribute) of the object entities.
Each individual attribute is called a data element. Examples of UNISYNC object
entities are an equipment unit, a synchronization input, a synchronization output, .
The OS transmits to the NE various commands that cause either a query or an update
of the database. These commands specify the portions of the database to be queried or
modified in terms of the conceptual data forms seen in the administrative views.
2.2.2. Logical Database level
The logical model of NE data defines the set of administrative views a NE may have
and specifies the various data items that make up each administrative view. The
method of representing data at this logical level is by means of a data dictionary.
For each administrative view in a NE, each data item (or parameter) is defined in
terms of the following characteristics:
The acronym or keyword that uniquely identifies the data item
The data type (e.g., alphanumeric character string, integer, Boolean or an
enumeration of specific acronyms or abbreviations)
The domain or range of values permissible for the data item
A brief description of the data item

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

Restrictions (data contingencies, associations, etc.) imposed on the data item


and identification of interdependencies with other data items (i.e., data items
may be independent, dependent on the existence of another data item, or may
be mutually exclusive with another data item.)
The data items as described in the data dictionaries are the form used within the
data blocks of the memory administration message structures.
2.3.

UNISYNC Memory administration functions

The following is a partial list of the PDMA (Provisioning Driven Memory


Administration) functions for UNISYNC:
Edit equipment card (SSU card, )
Query equipment card attributes and states
Edit oscillator attributes and states
Query oscillator attributes and states
Edit GPS attributes and states
Query GPS attributes and states
Create/Edit/Delete synchronization inputs
Query synchronization inputs
Create/Edit/Delete synchronization outputs
Query synchronization outputs
Create/Edit/Delete measurement inputs
Query measurement inputs
Edit users interface ports/channels
Query users interface ports/channels
2.4.

Message structure

The messages from OSs to UNISYNC are called input commands. These messages
can be entered by a user at craft ports or via telnet sessions. They can also be sent
from a TMN Manager on TCP/IP sessions.
General Input Command Format
Command Code Block
Staging Parameter Blocks
Verb

Modifier

Modifier

TID

AID

CTAG

GEN
BLK

<verb>

-<modifier>

[-<modifier>]

:[a]

:b

:c

[:[d]

Data Blocks

[:e[:[f][:g]]]];

The command code describes the action to be performed on an object entity in the
UNISYNC. The verb defines the specific action to be performed, while the modifiers
indicate the nature of the object entity to be acted on. Through a small set of verbs, all
memory administration tasks can be performed with a minimum of command
messages.
The modifiers are references to Administrative Views, whose data components are
defined in the data dictionaries.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

TID
AID
CTAG
GEN BLK

Staging Blocks
Target Identifier
Access Identifier
Correlation Tag
General Block

The TID may be null, but that block may not be omitted from the input command. If
the TID is received by the UNISYNC, it will be checked against the Source Identifier
(SID). The GEN BLK may be omitted altogether if no blocks follow it in the input
command message. The termination character (semicolon) may immediately follow
the CTAG.
The AID block uniquely identifies the object entity within the target UNISYNC.
Functional AIDs will be used in the UNISYNC.
The CTAG block contains one position-defined parameter to serve as a means of
correlating an input command with its associated output response(s). The value of
CTAG must either be a TL1 identifier or a non-zero decimal number, consisting of no
more than six characters.
The GEN BLK will be null (i.e., the GB is represented by two successive colons).
All three blocks e, f and g apply (format used in TL1 to control the Transport
NEs). Block e is referred to as the Common Data Block, while f is called the
Specific Data Block and g is the State Block. The Common Data Block and the
State Block are position-defined, while the Specific Block is keyword-defined.
The Common Data Block is used for parameters needed for a large majority of
instances of a command, and/or the parameter(s) in the Common Data Block puts the
Specific Data Block in context.
The Specific Data Block is used for parameters not used in the majority of instances or
in the case where, for a given instance of a command, only a few parameters are
needed from a choice of many possible parameters.
The State Block is used for the state parameters (GR-1093-CORE).

VERB
DELETE

EDIT
ENTER

RETRIEVE

4396CHbf Rev. 1.12


02/24/2009

UNISYNC Verbs and Abbreviations


ABBREV
MEMORY ADMINISTRATION FUNCTION
DLT
Remove completely an object entity with associated
attributes, or unassign an object entity and its attributes
and make the object entity ready for reinitialization.
ED
Change the attributes associated with an existing object
entity.
ENT
Add a new object entity including associated attributes,
or initialize (assign) the attributes associated with a
given object entity.
RTRV
Retrieve specified service attributes from an object
entity.

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

Output messages, which originate from the UNISYNC, may indicate either a
completed state or an error state for the input command to which they respond.
Messages that indicate a completion shall have the following general format:
NORMAL RESPONSE
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>
^^<completion_code> ([cr lf
^^^ <AID>|[AID] ( :<parameter block>)+) ] [cr lf
^^^/*<optional_free_format_text>*/])* cr lf;
where <completion_code>::= COMPLD (we will not support DELAY)
COMPLD shall be returned upon successful completion of DLT, ED, ENT and RTRV
commands submitted for immediate execution.
Output messages that indicate a failure shall adhere to the following formats:
DENIAL RESPONSE
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<error_code> ([cr lf
^^^ (<AID>|[<AID>] (:<parameter block>)+)]
[cr lf
^^^/*<optional_free_format_text>*/])* cr lf;
PARTIAL ERROR RESPONSE
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^PRTL ([cr lf
^^^[<AID>]:ERCDE=<error_code>[,<parameter
block>](:<parameter block>)*] [cr lf
^^^/*<optional_free_format_text>*/])+ cr lf;
PRTL shall be returned for responses to input commands specifying multiple AIDs of
which only a subset have been successfully executed. If all AIDs have failed to be
executed, the response shall indicate a DENY code.
ACKNOWLEDGMENTS
If an UNISYNC experiences an excessive delay in the processing of an input
command, the UNISYNC will send an acknowledgment message indicating the
pending state to the OS. The message format that indicates this In-Progress (IP) state
of the input command is:
IP^<CTAG> cr lf <
The CTAG is the CTAG of the input command to which the acknowledgment refers.
The UNISYNC continues to send IP acknowledgments at every interval of the delay
period (typically 2 seconds) until the actual response is sent.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

2.5.

UNISYNC Administration views


EQPT view modelling the equipment card (SSU card), the GPS, the oscillator,
the synchronization inputs, the synchronization outputs or some UNISYNCe
functional blocks (SNMP, ).
CID view modelling the users interface ports/channels.

A modifier ALL specifies all entity types (no specific address is provided).

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

2.6.

Memory Administration Supported TL1 messages


2.6.1. Common Provisioning Input Commands
2.6.1.1.RTRV-AO

2.6.1.1.1Command format:
RTRV-AO:[<tid>]::<ctag>:::<keyword>=<value>;

2.6.1.1.2Description:
RETRIEVE-AUTOMATIC_OUTPUT allows the OS to retrieve a copy of a queued
autonomous message or a missing autonomous message.
The UNISYNC keeps a copy of every already sent autonomous message for the purpose of
later retrieval in case the message is missed by the OS.
Upon an activation of the communication link, the UNISYNC passively waits for the OS to
retrieve the queued messages by using the RTRV-AO command.
2.6.1.1.3Description of parameters:
Name
Description
<keyword> ATAGSEQ - integral part of the ATAG of the
autonomous message to be retrieved.
DBCHGSEQ - sequence number of REPT
DBCHG message.
<value>

Valid values are integers between 0 and 9999.


Multiple or range of values can be specified by
using the "&" or "&&" notation.

2.6.1.1.4Example:
RTRV-AO:::SS20:::ATAGSEQ=2;

2.6.1.1.5Response format:
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD [cr lf
/* cr lf
(<autonomous message including the message header,

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

but without the termination indicator, i.e., ";">)+ cr lf


*/] cr lf;
See REPT^ALM, for AO format details.

2.6.1.1.6Example of normal response:


UNISYNCSID 05-12-22 09:16:56
M SS20 COMPLD
/*
UNISYNCSID 05-12-22 09:12:54
A 0002 REPT EVT EQPT
"SSU:DBLOAD,TC,12-22,09-12-54,,,,\"Start WKG DB loading from PRI DB\""
*/

2.6.1.1.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

2.6.2. Common Provisioning Autonomous Messages


2.6.2.1.REPT^DBCHG
2.6.2.1.1Message format:
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS><cr> <lf>
A^^<atag>^REPT^DBCHG(<cr> <lf>
^^^b:c:d([:e])*)+
<cr> <lf>;

2.6.2.1.2Description:
REPORT^DATA_BASE_CHANGE is an immediate report to the OS(s) on the UNISYNC
database changes that have occurred (results of commands, card insertion or removal, .).
The UNISYNC temporarily stores the queued autonomous messages in a log (DBCHG).
Upon an activation of the communication link, the UNISYNC passively waits for the OS to
retrieve the queued messages by using the RTRV-AO command.
2.6.2.1.3Description of parameters:
Name
<SID>
<atag>
b

c
d
e

Description
System Identifier.

Autonomously generated correlation tag.


This block has a keyword defined format, the
list of keywords is following:
TIME=HH-MM-SS
DATE=YY-MM-DD
SOURCE=<ctag of the original command>
LINKID=<channel identifier>
USERID=<name of the user who originated the
command>
DBCHGSEQ=<integer from 0 to 9999>
This block contains the command code block of
the original command
AID(s) that were affected by the original
command
Describes the details of the change effected.
There may be up to three blocks : the Common
Block, the Specific Block and the State Block.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

GILLAM-FEi

2.6.2.1.4 Examples:
UNISYNC 04-03-03 14:45:04
A 0663 REPT DBCHG
"DATE=04-03-03,TIME=14-45-04,SOURCE=t1,LINKID=TELN,USERID=RP,DBCHGSEQ=2:EDCID:CRAFT2::PMRFSH=1000"
;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

10

GILLAM-FEi

2.6.3. System Dependent Data Management Commands


2.6.3.1.ED-DAT
2.6.3.1.1Command format:
ED-DAT:[<tid>]::<ctag>::[<DATE>][,<TIME>[,<UTC>]];

2.6.3.1.2Description:
EDIT-DATE_AND_TIME instructs the UNISYNC to change its system date and time to a
given value that should be interpreted as UTC or LOCAL time. Changing the system date
and time may result in corruption of performance monitoring data for one or more time
periods.
When the UNISYNC is equipped with an In Service GPS receiver, the UNISYNC UTC time
is continuously updated from the GPS. In that situation, the command ED-DAT will be
denied.
The conversion between UTC time and LOCAL time depends on the value of the
programmable parameters DST (Daylight Saving Time) and TZ (Time Zones) (see GPXM
data dictionary).
All the TL1 messages generated by the UNISYNC use the local time.
2.6.3.1.3Description of parameters:
Name
<DATE>

<TIME>

<UTC>

Description
New value of the system date in a format YY-MM-DD, where YY is
the last two digits of the year ranging from 00 to 99, MM is the month
of the year ranging from 01 to 12, and DD is the day of the month
ranging from 01 to 31.
New value of the system time in a format of HH-MM-SS, where HH
is the hour in a 24 hour format ranging from 00 to 23, MM is the
minute ranging from 00 to 59, and SS is the second ranging from 00 to
59.
This field can take two values:
UTC: the system date and time introduced by the user is
considered as being UTC (Coordinated Universal Time).
LOCAL: the system date and time introduced by the user is
considered as being local time.
If this field is omitted in the command, the system date and
time programmed by the user is considered as being LOCAL.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

11

GILLAM-FEi

2.6.3.1.4Examples:
ED-DAT:::T1::05-01-12,23-59-59,UTC;
ED-DAT:::T2::06-05-03,10-01-30;
ED-DAT:::T3::06-04-10,02-08-09,LOCAL;

2.6.3.1.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command
UNISYNC configuration with GPS and GPS set In Service

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

12

GILLAM-FEi

2.6.3.2.RTRV-NETYPE
2.6.3.2.1Command format:
RTRV-NETYPE:<tid>::<ctag>;

2.6.3.2.2Description:
RETRIEVE-NETWORK_ELEMENT_TYPE retrieves the equipment related information.
2.6.3.2.3Description of parameters:
There should be no parameter.
2.6.3.2.4Examples:
RTRV-NETYPE:::T34;

2.6.3.2.5Response format:
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<vendor>,<model>,<netype>,<version>" cr lf
;

Name
<vendor>
<model>
<netype>
<version>

Description
Equipment vendor name.
Equipment model name.
Equipment type.
Software release version.

2.6.3.2.6Example of a normal response:


M

UNISYNCSID 05-01-12 18:58:41


T34 COMPLD
"\"FEi\",\"UNISYNCe\",\"PRS\",\"V1.0\""

2.6.3.2.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

13

GILLAM-FEi

2.6.3.3.RTRV-NETYPE-ALL
2.6.3.3.1Command format:
RTRV-NETYPE-ALL:<tid>::<ctag>;

2.6.3.3.2Description:
This command retrieves the UNISYNC inventory information.
2.6.3.3.3Description of parameters:
There should be no parameter.
2.6.3.3.4Examples:
RTRV-NETYPE-ALL:::T34;

2.6.3.3.5Response format:
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
/* cr lf
<rspblk>+
*/ cr lf
;

where rspblk has the format:


^^^^"<aid>,<clei>,<hwversion>,<sn>,<swversion>" cr lf
Name
<aid>
<clei>

Description
Identifies the object instance.

Indicates the CLEI (Common Language Equipment Identifier) of the concerned


equipment.
<hwversion> Indicates the hardware version of the installed card.
Indicates the serial number of the installed card.
<sn>
<swversion> Indicates the version of the software installed in the card (if any).

2.6.3.3.6Example of a normal response:


M

UNISYNCSID 05-01-12 18:58:41


T34 COMPLD
/*
"SSU,\"\",\"V1.0\",\"UNIS19103-054500003\",\"\""
"GPXM,\"\",\"V1.0\",\"GPXM11901-054300003\",\"V1.1\""

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

14

GILLAM-FEi

"OUTMODULE,\"\",\"V2.0\",\"E110
-060800001\",\"\""
"INP1,\"\",\"V1.0\",\"INPM24314-034600019\",\"\""
*/
;

2.6.3.3.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

15

GILLAM-FEi

2.6.3.4.SET-SID
2.6.3.4.1Command format:
SET-SID:::<ctag>::<system identifier>;

2.6.3.4.2Description:
This command changes the UNISYNC system identification code.
2.6.3.4.3Description of parameters:
Name
<system
identifier>

Description
New system identification code.

Type
TL1
identifier,
quoted string.

or

2.6.3.4.4Examples:
SET-SID:::T90::New SID;

2.6.3.4.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

16

GILLAM-FEi

2.6.4. UNISYNC Provisioning Commands


2.6.4.1.AID Format Description
The AID identifies the specific instance of an object entity that is addressed by a
message. The AID for each of the UNISYNC entity types will be specified as a
functional identifier.
AIDs in a message can be grouped so a single occurrence of a message may be applied
to more than one entity (interest to minimize the number of views and so the number
of messages). The grouping can be done to generate a list of AIDs or a range of AIDs:
use of ampersand (&) character or .double-ampersand (&&).
If the command verb modifier is ALL, then the <aid> parameter must be ALL or null.
To address all entities of a given type specified by the command verb modifier, ALL is
used as the AID.
The first column of the following table gives the modifier for the particular object
entity to be specifically identified by the AID. Verbs in all cases can include ENTER,
EDIT, DELETE and RETRIEVE. The second column gives the name that is used on
the message page (message description) to identify the AID parameter. The next two
columns TYPE and DESCRIPTION supply additional information on the allowed
values.
AID Staging Parameter Details
MODIFIER(S) KEYWORD TYPE
DESCRIPTION
EQPT
AID
A/N
1. For the SSU card
SSU: identifies the UNISYNC main card.
2. For the CPU module
GPXM: identifies the GPXM module
(General Purpose Xscale Module). The
GPXM module is a versatile piggy-back
card that must be plugged into the
UNISYNC main card.
3. For the GPS
GPS: identifies the GPS.
4. For the oscillator
OSC: identifies the oscillator.
5. For an output module
OUTMODULE: identifies the pluggable
output module. This module is optional.
Several types of module are available:
 10 outputs E1/2048 Khz
 10 outputs E1/2048 Khz and
10 E1/2048 Khz Feedback
Monitoring inputs

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

17

GILLAM-FEi

CID&CIDSECU

4396CHbf Rev. 1.12


02/24/2009

AID

A/N


6. For a synchronization input
INPn: where n varies between 1 and 2
identifies the synchronization input #n.
The input module is optional and supports
one input. Two input modules can be
plugged into the UNISYNC main card.
7. For an AUX output
AUXn: where n varies between 1 and 2
identifies the AUX synchronization output
#n (1, 5 or 10 Mhz).
AUX1 and AUX2 are supported by the
UNISYNC main card.
8. For an OUT output
OUTn: where n varies between 1 and 12
identifies the OUT synchronization output
#n (E1 or 2048 Khz).
OUT1 and OUT2 are supported by the
UNISYNC main card.
OUT3, OUT12 are supported by an
additional output module which is supplied
as an option. Two types of modules are
now available: E1 or E1FBM.
9. For a Feedback Monitoring input
FBMn: where n varies between 3 and 12
identifies the Feedback Monitoring input
#n (E1 or 2048 Khz).
FBM3, FBM12 are supported by an
additional E1FBM module which is
supplied as an option.
10. For the SNMP functional block
SNMP: addresses the SNMP configuration
parameters.
1. For a CRAFT port
CRAFTn: where n varies between 1 and 2
identifies the craft port #n of the
UNISYNC.
2. For a remote OS
TL1MNGn: where n varies between 1 and 6
identifies the remote TL1 manager #n
accessible in TCP/IP.
3. For Telnet channels
TELN: identifies the Telnet channels

UNISYNCe
TL1 REFERENCE GUIDE

18

GILLAM-FEi

2.6.4.2.Provisioning Commands
2.6.4.2.1DLT-<view name>
Command format:
DLT-<view name>:[<tid>]:<aid>:<ctag>;

Description:
This command deletes an object entity from the database. In order to be deleted, an object
entity must have been set 00S-MA(Out Of Service).

Possible view names:


EQPT,

Description of parameters:
Name
<aid>

Description
Identifies the object entity.

Type
Any suitable AID(s) for
the given view.

Examples:
DLT-EQPT::OUT3:T1;
DLT-EQPT::AUX1:T2;

Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

19

GILLAM-FEi

2.6.4.2.2ED-<view name>
Command format:
ED-<view name>:[<tid>]:<aid>:<ctag>:::[f][:g];

Description:
This commands changes the attributes associated with an existing object entity.
See Object-Entity Data Dictionaries for data parameters details.
Possible view names:
EQPT,
CID,

Description of parameters:
Name
<tid>
<aid>
<ctag>
f
g

Description
Target Identifier
AID parameter for object entity(ies)
Correlation Tag
Specific Block (name-defined)
State Block (position-defined) : only the
desired Primary State (IS or OOS)

Examples:
ED-CID::CRAFT1:112:::AO=N,DATA=7,ECHO=Y,FLOW=NONE,HMI=Y;
ED-EQPT::AUX1:T1::::OOS;
ED-EQPT::OUT12:T2::::IS;
ED_EQPT::OUT3:T7:::TYPE=S2048KHZ:IS;
ED-EQPT::SSU:T3:::IPADDR=212-1-2-5,SUBNET=255-255-255-0;
ED-EQPT::GPS:T5:::LATITUDE="50D 38M 42.386S N",LONGITUDE="5D 33M 55.200S E";
ED-EQPT::GPS:T6:::HEIGHT="156.28m";

Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

20

GILLAM-FEi

2.6.4.2.3 ENT-<view name>


Command format:
ENT-<view name>:[<tid>]:<aid>:<ctag>[:::[f][:g];

Description:
This command creates an object entity in the database.
See Object Entity Data Dictionaries for data parameters.
Possible view names:
EQPT,

Description of parameters:
Name
<tid>
<aid>
<ctag>
<f>
<g>

Description
Target Identifier
AID parameter for object entity(ies)
Correlation Tag
Specific Block (name-defined)
State Block (position-defined) : only the
desired Primary State (IS or OOS). By default :
IS.

Examples:
ENT-EQPT::OUT1:t1:::TYPE=E1;
UNISYNCSID 05-01-03 19:02:38
M t1 COMPLD
;
ENT-EQPT::OUT4:t2:::TYPE=S2048KHZ;
UNISYNCSID 05-01-03 19:02:50
M t2 COMPLD
;
ENT-EQPT::AUX1:t3:::TYPE=S10MHZ;
UNISYNCSID 05-01-03 19:02:55
M t3 COMPLD
;

Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

21

GILLAM-FEi

2.6.4.2.4 RTRV-<view name>


Command format:
RTRV-<view name>:[<tid>]:<aid>:<ctag>[:[:[:[<list of parameters>]]]];

Description:
This command retrieves the data parameters and state parameters for the object entities. See
Object-Entity Data Dictionaries for data parameters details.
Possible view names:
ALL
EQPT
CID

Description of parameters:
Name
<aid>

Description
Identifier of the object entity. There can be grouped values.
To retrieve all object entities in a particular view, use the value
ALL in the AID field
<list of
List of any parameters present in the data dictionary of the
parameters> mentioned AID. In case of using ALL instead of AID only
parameters common to all AIDs are accepted. This list of
parameter sets search conditions that limit the retrieved result set.
The command response will return all the parameters of all object
entities that match the specified conditions. The symbols : and ,
act as a logical AND, the & and && act as logical OR.
An additional parameter in the keyword-defined block named
PARAMETER can define a subset of parameters to be retrieved.
Its value is a list of parameters combined by & . The format is:
PARAMETER=<parameter1>&<parameter2>&&<parameterN>
Examples:
RTRV-CID::CRAFT1&&CRAFT2:123:::PARAMETER=PRTY&SPEED, AO=Y;

Response format:
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>
^^<completion_code> ([cr lf
^^^ <AID>|[AID] ( :<parameter block>)+) ] [cr lf
^^^/*<optional_free_format_text>*/])* cr lf;
Where <parameter block> has a format: <parameter name>=<parameter value>

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

22

GILLAM-FEi

Example of normal response:


M

UNISYNCSID 03-122 18:08:09


123 COMPLD
CRAFT2:PRTY=NONE,SPEED=9600

;
Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

23

GILLAM-FEi

2.7.

Data dictionaries

The following data dictionaries are provided in the appendices:

2.8.

Equipment data dictionaries


Users interface port/channel data dictionaries

Examples of PDMA functions


2.8.1. General comment

Any UNISYNC parameter is provisionable:


Locally from 2 craft ports (TL1/ASYNC)
o CRAFT1 (configured in local mode)
o CRAFT2 (configured in local mode)
Remotely from
o 4 telnet sessions (TL1/Telnet/TCP/IP/Ethernet)
o 6 TCP/IP sessions (TL1/TCP/IP/Ethernet)
o 2 ASYNC sessions (TL1/ASYNC/PSTN)
 CRAFT1 (configured in remote mode)
 CRAFT2 (configured in remote mode)
2.8.2. Provisioning of the SSU object
Login
ACT-USER::fei:t::fei.1;
Modification of the network parameters
ED-EQPT::SSU:t:::DHCP=N, IPADDR=192-10-7-8, GATEW=192-10-7-62;
ED-EQPT::SSU:t:::SUBNET=255-255-255-0;
Programming of the E1 output type and E1 alarming modes
ED-EQPT::SSU:t:::E1TYPE=E1MF,E1SFALM=AIS,E1MFALM=SSM;
Programming of the ID parameter
ED_EQPT ::SSU :t :::ID="UNISYNC system";
TCP/IP restart of the Unisync (needed after a modification of the network
parameters)
ED-EQPT::SSU:t:::ETHRST=Y;
ED-EQPT::SSU:t:::ETHRST=Y,CONF=Y;
2.8.3. Configuration of the SNMP v1/v2c agent

By default:

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

24

GILLAM-FEi

o The UNISYNCe allows any SNMP managers to issue SNMP v1/v2c


requests
o The report of authentication failure traps is enabled but no trap
addresses are programmed
o Any programmed trap reports are formatted in SNMP v2
o The read-only access community name is set to public
o The read-write access community name is set to private
o The trap community name is set to public
Modification of the read-only access community string
ED-EQPT::SNMP:t:::ROCOMMUNITY=my ro community name;
Modification of the read-write access community string
ED-EQPT::SNMP:t:::RWCOMMUNITY=my rw community name;
Modification of the trap community string
ED-EQPT::SNMP:t:::TRAPCOMMUNITY=my trap community name;
Programming of a trap destination (i.e., all the traps are sent to the remote
station located at IP address 216.45.78.125)
ED-EQPT::SNMP:t:::TRAP1ADDR=216-45-78-125;
Programming of the access control (i.e., only the remote station 216.45.78.125
is authorized to issue SNMP operations)
ED-EQPT ::SNMP :t :::ACCESSCTL=y ;
ED-EQPT ::SNMP :t :::NMS1ADDR=216-45-78-125 ;
Provisioning of the contact (can be controlled from SNMP)
ED-EQPT::SNMP:t:::SYSCONTACT=My contact;
Provisioning of the location (can be controlled from SNMP)
ED-EQPT::SNMP:t:::SYSLOCATION=My location;
Provisioning of the name (can be controlled from SNMP)
ED-EQPT::SNMP:t:::SYSNAME= My name ;
To modify the reported traps version (if necessary)
ED-EQPT ::SNMP :t :::TRAPVERSION=v1 ;
To deactivate a trap destination
ED-EQPT::SNMP:t:::TRAP1ADDR=0-0-0-0;
To remove the SNMP access control of a remote NMS
ED-EQPT::SNMP:t:::NMS1ADDR=0-0-0-0;
To disable the SNMP access control logic
ED-EQPT::SNMP:t:::ACCESSCTL=N;
To disable the report of authentication failure traps
ED-EQPT::SNMP:t:::ENBAUTHTRAP=N;

2.8.4. Provisioning of the GPS object


Programming of the antenna cable length
ED-EQPT::GPS:t:::ANTCABLELGTH= 10;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

25

GILLAM-FEi

Programming of the cable length between the Up Down Converter and the
Unisync
ED-EQPT::GPS:t:::SSUCABLELGTH = 20;
Programming of the mask angle
ED-EQPT::GPS:t:::MASKANGLE=15;
Manual programming of the GPS position (see also "Site Survey").
Before programming the GPS parameters, always be sure that the GPS is
correctly connected to the UNISYNC and that no communication alarm is
generated.
ED-EQPT::GPS:t:::HEIGHT= "140.00m";
ED-EQPT::GPS:t:::LATITUDE="10D 34M 45.090S N",LONGITUDE="24D 12M
34.800S E";
2.8.5. Site Survey

Automatic programming of the GPS position.


Before starting a site survey, always be sure that the GPS is correctly
connected to the UNISYNC and that there is no communication alarm.
ED-EQPT::GPS:t:::SITESURVEY=Y;
2.8.6. Provisioning of an AUX output
Creation of an AUX output
ENT-EQPT::AUX1:t:::TYPE=S1MHZ,ALMDE=SQUELCH;
Set it Out Of Service
ED-EQPT::AUX1:t::::OOS;
Change its type (when Out Of Service)
ED-EQPT::AUX1:t:::TYPE=S5MHZ;
Set it In Service
ED-EQPT::AUX1:t::::IS;
Set it Out Of Service
ED-EQPT::AUX1:t::::OOS;
Delete it (when Out Of Service)
DLT-EQPT::AUX1:t;
2.8.7. Provisioning of an OUT output
Creation of an OUT output
ENT-EQPT::OUT5:t:::TYPE=S2048KHZ,ALMDE=SQUELCH;
Set it Out Of Service
ED_EQPT::OUT5:t::::OOS;
Change its type (when Out Of Service) and set it In Service

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

26

GILLAM-FEi

ED-EQPT::OUT5:t:::TYPE=E1:IS;
Modify its E1 framing
ED-EQPT::OUT5:t:::E1TYPE=E1MF;
Set it Out Of Service
ED-EQPT::OUT5:t::::OOS;
Delete it (when Out Of Service)
DLT-EQPT::OUT5:t;
2.8.8. Provisioning of a group of outputs
Creation of outputs OUT1, OUT2, OUT3 and OUT4 as 2048 Khz
ENT-EQPT::OUT1&&-4:t:::TYPE=S2048KHZ;
Creation of outputs OUT5, OUT11 and OUT12 as E1
ENT-EQPT::OUT5&&-12:t:::TYPE=E1;
Set OUT1 OUT12 Out Of Service
ED-EQPT::OUT1&&-12:t::::OOS;
Delete OUT1 OUT12 (When Out Of Service)
DLT-EQPT::OUT1&&-12:t;
2.8.9. Provisioning of a Feedback Monitoring input
Creation of a Feedback Monitoring input
ENT-EQPT::FBM5:t:::TYPE=S2048KHZ;
Change its type
ED-EQPT::FBM5:t:::TYPE=E1;
Set it Out Of Service
ED-EQPT::FBM5:t::::OOS;
Delete it (when Out Of Service)
DLT-EQPT::FBM5:t;
2.8.10. Real time supervision of a Feedback Monitoring input
Creation of a Feedback Monitoring input
ENT-EQPT::FBM3:t:::TYPE=E1;
Start a SCHEDULE-PERFORMANCE MONITORING REPORT
SCHED-PMREPT-EQPT::FBM3:t::,,,DFF,,,,;
REPT^PM messages are sent every 4 seconds
Stop the SCHEDULE-PERFORMANCE MONITORING REPORT
SCHED-PMREPT-EQPT::FBM3:t::,,0,DFF,,,,;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

27

GILLAM-FEi

2.8.11. Provisioning of an INP synchronization input


Creation of an INP input
ENT-EQPT::INP2:t:::TYPE=S2048KHZ;
Set it Out Of Service
ED-EQPT::INP2:t::::OOS;
Modify its type (when Out Of Service)
ED-EQPT::INP2:t:::TYPE=E1SF;
Set it In Service
ED-EQPT::INP2:t::::IS;
Change its priority
ED-EQPT::INP2:t:::PRTY=2;
Set it Out Of Service
ED-EQPT::INP2:t::::OOS;
Delete it (when Out Of Service)
DLT-EQPT::INP2:t;
2.8.12. Provisioning of the TOD serial protocol
Activation of the TOD serial protocol
ED-EQPT::SSU:t:::TODACT=Y;
Deactivation of the TOD serial protocol
ED-EQPT::SSU:t:::TODACT=N;
2.8.13. Reset of the Unisync
Force the hardware reset of the Unisync
ED-EQPT::SSU:t:::RESET=Y;
Confirm the operation as requested
ED-EQPT::SSU:t:::RESET=Y,CONF=Y;
2.8.14. Factory reset of the Unisync
Force the factory reset of the Unisync
ED-EQPT::GPXM:t:::FACTORYRESET=Y;
Confirm the operation as requested
ED-EQPT::GPXM:t:::FACTORYRESET=Y,CONF=Y;
2.8.15. Forced Reference Switch
Select reference input #2 (OSC goes to HOLDOVER if INP2 is in alarm)
ED-EQPT::SSU:t:::SYNMDE=FRCD,INPFRCD=INP2;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

28

GILLAM-FEi

Select GPS reference input (OSC goes to HOLDOVER if GPS is in alarm)


ED-EQPT::SSU:t:::SYNMDE=FRCD,INPFRCD=GPS;
Return to AUTO synchronization mode
ED-EQPT::SSU:t:::SYNMDE=AUTO;
2.8.16. Manual Reference Switch
o Configuration 1
 No alarm on GPS (PRTY=1, QLCUR=PRS)
 No alarm on INP1 (PRTY=1, QLCUR=PRS)
 No alarm on INP2 (PRTY=2, QLCUR=PRS)
ED-EQPT::SSU:t:::INPSEL=GPS; selects GPS reference input
ED-EQPT::SSU:t:::INPSEL=INP1; selects reference input #1
ED-EQPT::SSU:t:::INPSEL=INP2; is denied (because of PRTY)
ED-EQPT::SSU:t:::INPOVR=INP2; selects reference input #2
o Configuration 2
 No alarm on GPS (PRTY=1, QLCUR=PRS)
 No alarm on INP1 (PRTY=2, QLCUR=PRS)
 No alarm on INP2 (PRTY=2, QLCUR=STU)
ED-EQPT::SSU:t:::INPSEL=GPS; selects GPS reference input
ED-EQPT::SSU:t:::INPSEL=INP1; is denied (because of PRTY)
ED-EQPT::SSU:t:::INPOVR=INP1; selects reference input #1
ED-EQPT::SSU:t:::INPSEL=INP2; is denied (because of PRTY)
ED-EQPT::SSU:t:::INPOVR=INP2; is denied (because of QLCUR)

2.8.17. Modification of the CRAFT ports parameters


Modification of some CRAFT1 parameters
ED-CID::CRAFT1:t:::SPEED=115200, PRTY=NONE, STOP=1, DATA=8;
Modification of some CRAFT2 parameters
ED-CID::CRAFT2:t:::ECHO=Y, HMI=Y;
2.8.18. Modification of some Telnet parameters
Suppress the echo
ED-CID::TELN:t:::ECHO=N;
Suppress the generation of the Autonomous Output messages
ED-CID::TELN:t:::AO=N;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

29

GILLAM-FEi

2.8.19. Modification of some TL1MNG resources

Reserve the TL1MNG1 communication resource for the remote OS


(143.13.7.5)
ED-CID::TL1MNG1:t:::IPADDR=143-13-7-5;
Reserve the TL1MNG2 communication resource for the remote OS
(12.7.98.5)
ED-CID::TL1MNG2:t:::IPADDR=12-7-98-5;
Use TL1MNG3, TL1MNG6 with other remote Oss
ED-CID::TL1MNG3&&-6:t:::IPADDR=0-0-0-0;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

30

GILLAM-FEi

3.

MAINTENANCE AND SURVEILLANCE MANAGEMENT (GR833-CORE)


3.1.

Introduction

The generic functions and messages defined in the GR833-CORE document pertain
among others to the Timing Signal Generator (TSG) generic type of NE.
The access parameters of the messages address a particular entity within the NE. The
entity type is expressed in the final modifier in the VERB-MODIFIER-MODIFIER
structure of the message.
In general, the messages use a single access parameter called the AID. The AID for
various types of entities will have a format or meaning appropriate for each particular
entity type. The AID formats used in the UNISYNC equipment are described in the
memory administration section of this document.
The second (or final) of the two allowed modifiers will be one of the following:
Modifier
EQPT
CID
ALL
3.2.

Equivalence
SSU card, GPS, Oscillator, Synchronization
inputs, Synchronization outputs,
CRAFT ports, remote OS channels, Telnet
channels,
All entity types (no specific address is provided)

Supported messages

The messages specified are of two types: input commands and responses, and
automatic messages (autonomous messages, unsolicited site reports).
Message names beginning with the verb REPORT are automatic messages; the others
are input commands and responses.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

31

GILLAM-FEi

3.2.1. Input Commands and Responses


3.2.1.1.ALW-MSG
3.2.1.1.1Command format:
ALW-MSG-<modifier>:[<tid>]:[<aid>]:<ctag>::[<ntfcncde>],[<condtype>][,];

3.2.1.1.2Description:
ALLOW-MESSAGE permits or allows the UNISYNC to resume transmission of automatic
messages to an OS after having been in the INHIBIT-MESSAGE mode.
Parameters are provided to selectively enable messaging. Unreported alarms in existence at
the time of resumption will be transmitted to the OS with the REPORT ALARM message.
Unreported non-alarmed standing conditions in existence at the time of resumption will be
transmitted to the OS with the REPORT EVENT message.
ALLOW-MESSAGE commands sent on one OS/UNISYNC or user session will not impact
other sessions.
3.2.1.1.3Possible values of <modifier>:
ALL
EQPT

3.2.1.1.4Description of parameters:
Name
<aid>

Description
Identifies
the
single
equipment
unit,
synchronization interface etc. that has an alarm
condition.
<ntfcncde> Notification code associated with a single alarm
condition.
<condtype> A single type of alarm condition being reported.

Type
Any suitable AID(s) for
the given view
CR, MJ, MN, NA, NR

3.2.1.1.5Examples:
ALW-MSG-EQPT::SSU:t1234:: MJ,LOGBUFROVFL-SECU;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

32

GILLAM-FEi

3.2.1.1.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

33

GILLAM-FEi

3.2.1.2.HELP
3.2.1.2.1Command format:
HELP:[<tid>]::<ctag>::<command verb>[,<modifier1>][,<modifier2>];

3.2.1.2.2Description:
This command provides the help information about all the TL1 commands supported by the
US5G/UNISYNC product family. Some of these commands could not be supported by the
UNISYNC.
3.2.1.2.3Description of parameters:
Name
<command
verb>
<modifier1>

Description
Valid UNISYNC command verb.

<modifier2>

Valid UNISYNC command modifier

Valid UNISYNC command modifier

Type
All allowed UNISYNC
command verbs
Allowed
UNISYNC
command
modifiers.
The complete command
name should be valid
for UNISYNC.

3.2.1.2.4Examples:
HELP:::006::ACT,USER;

3.2.1.2.5Example of normal response:


UNISYNCSID 04-12-02 14:10:11
M 006 COMPLD
Command format is:
act-user::<user_name>:<Ctag>:password
;

3.2.1.2.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

34

GILLAM-FEi

3.2.1.3.INH-MSG
3.2.1.3.1Command format:
INH-MSG-<modifier>:[<tid>]:[<aid>]:<ctag>::[<ntfcncde>],[<condtype>][,];

3.2.1.3.2Description:
INHIBIT-MESSAGE instructs the UNISYNC to enter a mode in which certain automatic
messages associated with a specific equipment unit, synchronization input, are prevented
from being transmitted to the OS.
This command only applies to the OS/UNISYNC or user session on which this command is
sent. Parameters are provided to selectively disable messaging.
This command should not have any effect on indicators in the office where the UNISYNC
resides or on the UNISYNC itself.
The condition may be restored to normal with the ALLOW-MESSAGE command.
3.2.1.3.3Possible values of <modifier>:
ALL
EQPT

3.2.1.3.4Description of parameters:
Name
<aid>

Description
Identifies
the
single
equipment
unit,
synchronization interface, that has an alarm
condition.
<ntfcncde> Notification code associated with a single alarm
condition.
<condtype> A single type of alarm condition being reported.

Type
Any suitable AID(s) for
the given view.
CR, MJ, MN, NA, NR

3.2.1.3.5Examples:
INH-MSG-EQPT::SSU:t1234::MJ,LOGBUFROVFL-SECU;

3.2.1.3.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

35

GILLAM-FEi

3.2.1.4.INIT-LOG
3.2.1.4.1Command format:
INIT-LOG:[<tid>]::<ctag>::<lognm>;

3.2.1.4.2Description:
The command instructs the UNISYNC to initialize a specified message log (event log,
security log, event autonomous output log, UNISYNC database change log) at a specified
time. When this command is executed, it does not change the current log attributes, but rather
clears the contents of the existing log. Also, a copy of the command will be placed in the log.
3.2.1.4.3Description of parameters:
Name
<lognm>

Description
Name of the log.

Type
EVT, EVTAO, SECU,
DBCHG

3.2.1.4.4Examples:
INIT-LOG:::t167::EVTAO;
INIT-LOG:::t::EVT;
INIT-LOG:::t::SECU;

3.2.1.4.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

36

GILLAM-FEi

3.2.1.5.INIT-REG
3.2.1.5.1Command format:
INIT-REG-EQPT:[<tid>]:<aid>:<ctag>[::<montype>,,,,,[,]];

3.2.1.5.2Description:
INITIALIZE-REGISTER instructs the UNISYNC to reset one or more storage registers or
event counters associated with the synchronization inputs.
INPUT FORMAT:
All parameters in this command are positional.
3.2.1.5.3Description of parameters:
Sign
<aid>
<montype>

Description
Identifies a synchronization object instance
(input).
Identifies the storage register to be initialized.
When TIE1S is specified, all the <montype>s
are reset.
When no parameter block is entered, all the
<montype>s are reset.

Formal type
INP1 or INP2.
See table.

3.2.1.5.4Examples:
INIT-REG-EQPT::INP1:t1::FFOFF3s&FFOFF10S,,,,,;
INIT-REG-EQPT::INP1:t2::TIE1S,,,,,;
INIT-REG-EQPT::INP2:t3;
INIT-REG-EQPT::INP1&INP2:t4;

3.2.1.5.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
Object instance not provisioned
Object instance set Out Of Service
The PM features are available in the UNISYNC from software V1.4.4. The GPXM module
of the UNISYNC must also be equipped with 64 Mbytes of RAM.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

37

GILLAM-FEi

3.2.1.6.INIT-SYS
3.2.1.6.1Command format:
INIT-SYS:[<tid>]:<aid>:<ctag>::<ph>;

3.2.1.6.2Description:
INITIALIZE-SYSTEM instructs the UNISYNC to restart the UNISYNC.
3.2.1.6.3Description of parameters:
Sign
<aid>
<ph>

Description
Access Identifier identifies the equipment unit that
is to be initialized
Integer value that specifies the degree of
thoroughness of the system initialization: in the
UNISYNC, 0 specifies the cold restart of the
SSU card

Type
SSU
0

3.2.1.6.4Examples:
INIT-SYS::SSU:005::0;

3.2.1.6.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

38

GILLAM-FEi

3.2.1.7.MENU
3.2.1.7.1Command format:
MENU::::;

3.2.1.7.2Description:
MENU instructs the UNISYNC to quit its TL1 CLI and to enter its VT100 menu-driven
diagnostic user interface.
This interface is backdoor password protected.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

39

GILLAM-FEi

3.2.1.8.OPR-ACO
3.2.1.8.1Command format:
OPR-ACO-ALL:[<tid>]::<ctag>;

3.2.1.8.2Description:
OPERATE-ALARM_CUTOFF instructs the UNISYNC to cut off the office audible alarm
indications without changing the local alarm indications. This command has no effect on
future alarms at the UNISYNC, but rather will direct the UNISYNC to provide conditioning
only on those alarms that are currently active. The ACO retires the Central Office (CO) alarm
audible indicators without clearing indicators that the trouble still exits.
3.2.1.8.3Description of parameters:
None
3.2.1.8.4Examples:
OPR-ACO-ALL:::t123;

3.2.1.8.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

40

GILLAM-FEi

3.2.1.9.RTRV-ALM
3.2.1.9.1Command format:
RTRV-ALM-<view name>:[<tid>]:[<aid>]:<ctag>[::,,,,[,]];

3.2.1.9.2Description:
RETRIEVE-ALARM instructs the UNISYNC to retrieve and send the current status of its
alarm conditions associated with one or more equipment units, synchronization inputs,
The command may be used to retrieve UNISYNC information, which in turn may be used to
update an OS database when it is suspected that autonomous alarm messages issued by the
UNISYNC using REPORT ALARM were not received or properly processed. It may also be
used to evaluate the system before or after UNISYNC maintenance operations.
3.2.1.9.3Possible view names:
ALL,
EQPT,

3.2.1.9.4Description of parameters:
None.
3.2.1.9.5Examples:
RTRV-ALM-ALL:::t1::,,,,;
RTRV-ALM-ALL:::t2;
RTRV-ALM-EQPT::INP1:t3;
RTRV-ALM-EQPT::OUT2:t4;

3.2.1.9.6Response format:
The response format depends on whether any alarm conditions exist to report.
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>:<conddescr> <cr>
<lf>

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

41

GILLAM-FEi

The normal response must contain at least one occurrence of <rspblk> if there is at least one
alarm condition to report. It is allowed to contain multiple <rspblk>s.
Name
<aid>

Description
Identifies the single equipment unit, synchronization interface, that has
an alarm condition
<ntfcncde>
2-character notification code associated with a single alarm condition
<condtype> Single type of alarm condition being reported
<srveff>
Effect on service caused by the alarm condition
<ocrdat>
Date when the event occurred
<ocrtm>
Time when the event occurred
<conddescr> Detailed text description of the trouble. This field is limited to 64 characters
enclosed with escaped quotes (\) for a maximum of 68 characters (counting
the escaped quotes).
3.2.1.9.7Example of normal response:
UNISYNCSID 03-01-27 19:22:20
123 COMPLD
"SSU:MN,LOGBUFR90-SECU,NSA,03-01,17-44-04:\"Security
log
buffer
90%
full\""
"SSU:MJ,LOGBUFROVFL-SECU,NSA,03-01,17-44-05:\"Security
log
buffer
overflow\""
;
M

3.2.1.9.8Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

42

GILLAM-FEi

3.2.1.10.RTRV-ATTR
3.2.1.10.1Command format:
RTRV-ATTR-<modifier>:[<tid>]:[<aid>]:<ctag>::,[<condtype>],,[,];

3.2.1.10.2Description:
RETRIEVE-ATTRIBUTE instructs the UNISYNC to send the current attributes associated
with the specified events. This command may be used to review these attributes before
making new settings with the SET-ATTRIBUTE.
3.2.1.10.3Possible values of <modifier>:
ALL
EQPT

3.2.1.10.4Description of parameters:
Name
<aid>

<condtype>

Description
Identifies the equipment unit, synchronization
input depending on the command code
modifier, to which the specified event pertains.
Type of event for which the current attributes
are being retrieved.

Type
Any suitable AID(s) for
the given view.
Any valid condition
type.

3.2.1.10.5Examples:
RTRV-ATTR-EQPT::SSU:TT2::,LOGBUFR90-SECU,,;

3.2.1.10.6Response format:
Response message has the followed format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^<aid>:<ntfcncde>,<condtype>,,,,<srveff>,<logctl>, <almescl>, <escltim>
<cr> <lf>

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

43

GILLAM-FEi

The normal response must contain at least one occurrence of <rspblk> if there is at least one
set of attributes to report. It is allowed to contain multiple <rspblk>s.
Name
<aid>
<ntfcncde>
<condtype>
<srveff>
<logctl>
<almescl>
<escltim>

Description
Identifies the equipment unit, the synchronization input, for the requested
event.
Notification code specifies the type of notification to be generated by the
UNISYNC on the occurrence of the event described in <condtype>.
Identifies the type of event for which a notification attribute (<ntfcncde>) is
being changed.
Effect on service caused by the standing or alarm condition.
Indicates if the generated notification must be logged or not.
Indicates if the alarm condition must be escalated after the time specified in
<escltim>.
Specifies the time expressed in hours after which an alarm will be escalated
to the next higher severity level.

3.2.1.10.7Example of normal response:


UNISYNCSID 05-01-03 21:12:23
M TT2 COMPLD
SSU:MN,LOGBUFR90-SECU,,,,NSA,LOG,NESCL,0
;

3.2.1.10.8Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

44

GILLAM-FEi

3.2.1.11. RTRV-COND
3.2.1.11.1Command format:
RTRV-COND-<modifier>:[<tid>]:[<aid>]:<ctag>[::,,[,]];

3.2.1.11.2Description:
RETRIEVE-CONDITION instructs the UNISYNC to return the current standing condition
and state associated with one or more specified equipment units, interfaces, synchronization
inputs,
3.2.1.11.3Possible values of <modifier>:
ALL
EQPT

3.2.1.11.4Description of parameters:
Name
<aid>

Description
Identifies the equipment unit, synchronization
input, to which the specified event pertains.

3.2.1.11.5Examples:
RTRV-COND-ALL:::T1::,,,;
RTRV-COND-ALL:::T2;
RTRV-COND-EQPT::GPS:T3;

3.2.1.11.6Response format:
Response message has the following format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^<aid>:[<ntfcncde>],<typerep>,<srveff>,<ocrdat>,<ocrtm>,,,,<conddescr>,<
inhn> <cr> <lf>

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

45

GILLAM-FEi

Name
<aid>

Description
Identifies the equipment unit, the synchronization input, to which the
condition given by the <typerep> parameter below pertains.
<ntfcncde>
Two-character notification code. It governs the type of notification
generated by the UNISYNC for this condition when it occurs.
<typerep>
Type of indication or entity state being reported on this line of the message.
Valid values can be any specific <condtype> or <state>. <condtype> can be
of the form T-x for a threshold violation on <montype>x.
<srveff>
Effect on service caused by the alarm or status condition.
<ocrdat>
Date when the triggering event occurred.
<ocrtm>
Time of day when the triggering event occurred.
<conddescr> Detailed text description of the condition or state.
<inhn>
Indicates if an inhibition is in effect or not.
3.2.1.11.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

46

GILLAM-FEi

3.2.1.12. RTRV-HDR
3.2.1.12.1Command format:
RTRV-HDR:[<tid>]::<ctag>;

3.2.1.12.2Description:
RETRIEVE-HEADER requests that the UNISYNC simply replies with a normal response
indicating COMPLD. The information of interest in the reply is the reply itself, along with
information that the UNISYNC has about itself, namely the SID, the <date> and the <time>.
3.2.1.12.3Description of parameters:
None
3.2.1.12.4Examples:
RTRV-HDR:::0123;

3.2.1.12.5Example of normal response:


UNISYNCSID 05-01-03 13:25:09
M 0123 COMPLD
;

3.2.1.12.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

47

GILLAM-FEi

3.2.1.13.RTRV-LOG
3.2.1.13.1Command format:
RTRV-LOG:[<tid>]::<ctag>::<lognm> [,<nbmsg>];

3.2.1.13.2Description:
RETRIEVE-LOG instructs the UNISYNC to retrieve the contents of an existing message log.
The UNISYNC supports four logs:
Event log to save the events and alarms (size: 1100 events)
AO log to save the Autonomous Output TL1 messages (size: 400 events)
DBCHG log to save the REPT^DBCHG TL1 messages (size: 400 events)
Secu log to save the security TL1 messages (size: 100 events).
This information is available up to the next UNISYNC reset.
It is also possible to issue a RTRV-AO TL1 command to selectively retrieve messages from
the AO log or from the DBCHG log based on a range of ATAGSEQ or DBCHGSEQ values.
3.2.1.13.3Description of parameters:
Name
<lognm>
<nbmsg>

Description
Name of the log.
Indicates the number of messages the user wants
to retrieve from the log. If not specified, the
complete log is retrieved.

Type
EVT, EVTAO, SECU,
DBCHG
Decimal number

3.2.1.13.4Examples:
;RTRV-LOG:::tt1::SECU, 5;
;RTRV-LOG:::t::EVT;
;RTRV-LOG:::t::EVTAO,100;
;rtrv-log:::t::dbchg;

3.2.1.13.5Response format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

48

GILLAM-FEi

^^^<lognm> <cr> <lf>


^^^/* <contents of message log> */ <cr> <lf>

The normal response must contain at least one occurrence of <rspblk>. It is allowed to
contain multiple <rspblk>s if applicable.
3.2.1.13.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

49

GILLAM-FEi

3.2.1.14.RTRV-PM
3.2.1.14.1Command format:
RTRV-PMEQPT:[<tid>]:[<aid>]:<ctag>::<montype>,,,,[<tmper>],[<mondat>][,<montm>];

3.2.1.14.2Description:
RETRIEVE-PERFORMANCE_MONITORING instructs the UNISYNC to send its current
set of PM data associated with the synchronization inputs and the oscillator.
It may be used when it is suspected that automatic PM messages issued using REPORT PM
were not received or properly processed. Parameters are provided to retrieve past PM data
(history of PM information).
It is suggested in the GR-1244-CORE that the NE supports a data storage scheme that allows
user-access to PM parameters in the current and previous 15-minute and 1-day periods, as
well as in the 31 next-most-recent 15-minute periods and (possibly) the six next-most-recent
1-day periods.
The UNISYNC stores in its data base :

The 31 next most recent 15 minute periods for each of the PM parameters (average
value in the 15-minute interval for a fast varying PM parameter) (FFOFF, MRTIE,
LMRTIE, TDEV, FREQCORR)
The max values of the following PM parameters in a 1-hour period for two days
(FFOFF, MRTIE, LMRTIE, TDEV)
The min values of the following PM parameters in a 1-hour period for two days
(FFOFF, MRTIE, LMRTIE, TDEV)
The TIE parameter for one day (TIE1S)
The min/average/max values of the oscillator commands in a 1-hour period for six
days (FREQCORR)
The average values of the oscillator commands in a 1-day period for thirty-two days
(FREQCORR)
The max values of the oscillator commands in a 1-day period for thirty-two days
(FREQCORR)
The min values of the oscillator commands in a 1-day period for thirty-two days
(FREQCORR)

The PM features are available in the UNISYNC from software V1.4.4. The GPXM module
of the UNISYNC must also be equipped with 64 Mbytes of RAM.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

50

GILLAM-FEi

3.2.1.14.3Description of parameters:
Sign
<aid>

Description
Identifies a synchronization object instance

<montype>

Specifies the type of monitored parameter for


which a value is requested.
Specifies the accumulation time period for the
PM information.
Date of the beginning of the requested PM
period specified in <tmper>.
Beginning time of day of the requested PM
period specified in <tmper>.

<tmper>
<mondat>
<montm>

Type
INP1 or INP2 for a
synchronization input.
OSC for the oscillator.
See <montype> table.
1S, 15M, 1H, 1D
YY-MM
HH-MM

3.2.1.14.4Examples:
RTRV-PM-EQPT::INP1:WWW::FFOFF3S,,,,15M;
RTRV-PM-EQPT::INP1:t2::TDEV100S,,,,15M;
RTRV-PM-EQPT::INP1:t3::TDEV100S-C,,,,1H;
RTRV-PM-EQPT::INP2:t4::TIE1S,,,,1S,06-09,10-00;
RTRV-PM-EQPT::OSC:t5::FREQCORR,,,,1H;
RTRV-PM-EQPT::OSC:t6::FREQCORR-F,,,,1H;
RTRV-PM-EQPT::OSC:t7::FREQCORR-C,,,,1H;

3.2.1.14.5Response format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^<aid>:<montype>,<monval>,[<vldty>],,,[<tmper>],[<mondat>][,<montm>]
<cr> <lf>

Name
<aid>
<montype>
<monval>
<vldty>
<tmper>
<mondat>
<montm>

Description
Identification of the synchronization object instance (input, oscillator).
Indicates the type of monitored parameter for which a value is being
retrieved.
Measured value of the monitored parameter.
Validity indicator for the reported PM data.
Indicates the accumulation time period for the PM information.
Date of the beginning of the PM period specified in <tmper>.
Beginning time of day of the PM period specified in <tmper>.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

51

GILLAM-FEi

3.2.1.14.6 Example of normal response:

UNISYNC 06-10-09 15:37:18


WWW COMPLD
INP1:FFOFF3S,0.2,COMPL,,,15M,10-09,15-00
INP1:FFOFF3S,0.3,COMPL,,,15M,10-09,15-15
INP1:FFOFF3S,0.2,COMPL,,,15M,10-09,15-30

3.2.1.14.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

52

GILLAM-FEi

3.2.1.15.RTRV-SAT
3.2.1.15.1Command format:
RTRV-SAT:<tid>::<ctag>;

3.2.1.15.2Description:
This command retrieves information about the satellites managed by the GPS receiver.
It gives indication about the satellite visibility and tracking status:
NBSATVISIBLE: number of visible sats
0..32
NBGPSTRACKED: number of satellites tracked
0..32
For each of the GPS receiver channels:
SATID: ID of the satellite
0..37
CNO: carrier to noise density ratio
0..255 dB-Hz
TYPE: type of GPS
GPS or GLONASS
TIMING: used for timing
Y or N
ELV: elevation
0..90 deg
AZM: azimuth
0..359 deg

3.2.1.15.3Description of parameters:
There should be no parameter.

3.2.1.15.4Examples:
RTRV-SAT:::T34;

3.2.1.15.5Response format:
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
/* cr lf
^^^"NBSATVISIBLE=<visiblesat>,NBGPSTRACKED=<sattracked>" cr lf
<rspblk>*
*/ cr lf
;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

53

GILLAM-FEi

where rspblk has the format:


^^^^"SATID=<id>,CNO=<cno>,TYPE=<type>,TIMING=<y/n>,ELV=<elv>,
AZM=<azm>" cr lf

3.2.1.15.6Example of a normal response:


M

UNISYNCSID 05-01-12 18:58:41


T34 COMPLD
/*
"NBSATVISIBLE=5,NBGPSTRACKED=5"
"SATID=11,CNO=46,TYPE=GPS,TIMING=Y,ELV=55,AZM=280"
"SATID=14,CNO=45,TYPE=GPS,TIMING=Y,ELV=38,AZM=93"
"SATID=19,CNO=37,TYPE=GPS,TIMING=Y,ELV=58,AZM=163"
"SATID=28,CNO=44,TYPE=GPS,TIMING=Y,ELV=25,AZM=303"
"SATID=22,CNO=45,TYPE=GPS,TIMING=Y,ELV=29,AZM=54"
*/

3.2.1.15.7Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

54

GILLAM-FEi

3.2.1.16.RTRV-TH
3.2.1.16.1Command format:
RTRV-TH-ALL:[<tid>]:[<aid>]:<ctag>[::<montype>,[,]];
RTRV-TH-EQPT:[<tid>]:[<aid>]:<ctag>[::<montype>,[,]];

3.2.1.16.2Description:
RETRIEVE-THRESHOLD instructs the UNISYNC to send the current threshold level of one
or more monitored parameters for which violation will trigger an automatic message. The
threshold levels may apply to one or more synchronization objects (input or oscillator).
3.2.1.16.3Description of parameters:
Name
<aid>
<montype>

Description
Identifies a synchronization object instance
(input, osc). There can be grouped parameters.
Identifies the particular monitored parameter for
which threshold level is being retrieved.

Type
Any EQPT aid
Any valid montype

3.2.1.16.4Examples:
RTRV-TH-EQPT::INP2:t2::FFOFF30S,;
RTRV-TH-EQPT::OSC:t2::FREQCORR,;

3.2.1.16.5Response format :
NORMAL RESPONSE FORMAT :
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^<aid>:<montype>,,,<thlev>,<tmper> <cr> <lf>

Name
<aid>
<montype>
<thlev>
<tmper>

Description
Identification of the synchronization object instance (input, oscillator).
identifies the particular monitored parameter for which threshold level is
being retrieved.
current threshold level for the monitored parameter.
accumulation time period for the PM information.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

55

GILLAM-FEi

3.2.1.16.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

56

GILLAM-FEi

3.2.1.17.SCHED-PMREPT
3.2.1.17.1Command format:
SCHED-PMREPT-EQPT:[<tid>]:<aid>:<ctag>::,,[<numrept>],
<montype>,,,,[<tmper>][,];

3.2.1.17.2Description:
SCHEDULE-PERFORMANCE MONITORING REPORT instructs the UNISYNC to start or
remove the reporting of performance-monitoring data on a synchronization input, on a
Feedback Monitoring input or on the oscillator.
When this command requests it, the UNISYNC will periodically return data using the
REPORT PERFORMANCE MONITORING message :
every 10 sec for the TIE1S
every 4 sec for the DFF
every PMRFSH sec for the other <montype> as programmed in the parameter
PMRFSH defined in the interface port/channel data dictionary (by default : 900 sec).
3.2.1.17.3Description of parameters:
Name
<aid>

Description
Identifies a synchronization object instance.

<numrept>

At null initiates performance monitoring and at


0 terminates the performance-monitoring
reporting schedule that was introduced by a
previous SCHEDULE-PM REPORT command.
Type of monitored parameter.

<montype>
<tmper>

Accumulation time period for the performance


monitoring information. By default:
- TIE1S : 1S
- DFF: 1S
- Other <montype>: 15M

Type
INP1 or INP2 for a
synchronization input.
OSC for the oscillator.
FBM3, .. FBM12 for a
Feedback Monitoring
input.
Null (no numrept value)
or 0

One of the PM
parameters (see table).
1S, 15M, 1H, 1D

3.2.1.17.4Examples:

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

57

GILLAM-FEi

SCHED-PMREPT-EQPT::INP1:t1::,,,FFOFF100S,,,, 15M;
SCHED-PMREPT-EQPT::INP1:t2::,,0,FFOFF100S,,,, 15M;
SCHED-PMREPT-EQPT::INP2:t3::,,,TIE1S,,,, 1S;
SCHED-PMREPT-EQPT::INP2:t4::,,0,TIE1S,,,, 1S;
SCHED-PMREPT-EQPT::FBM3:t5::,,,DFF,,,, 1S;
SCHED-PMREPT-EQPT::FBM3:t6::,,0,DFF,,,, 1S;
SCHED-PMREPT-EQPT::FBM12:t7::,,,DFF,,,,;
SCHED-PMREPT-EQPT::FBM12:t8::,,0,DFF,,,,;

3.2.1.17.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
Trying to terminate not started schedule-performance monitoring report.
The SCHEDULE-PERFORMANCE MONITORING REPORT is automatically stopped
when the concerned synchronization object instance is set out of service.
The PM features are available in the UNISYNC from software V1.4.4. The GPXM module
of the UNISYNC must also be equipped with 64 Mbytes of RAM.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

58

GILLAM-FEi

3.2.1.18.SET-ATTR
3.2.1.18.1Command format:
SET-ATTR-<modifier>:
[<tid>]:[<aid>]:<ctag>::<ntfcncde>,<condtype>,,[,[,[<srveff>],[<logctl>],[<
almescl>],[<escltim>]]];

3.2.1.18.2Description:
SET-ATTRIBUTE instructs the UNISYNC to set the notification code and various attributes
associated with the specified event.
The notification code attribute governs whether the event is reported automatically by the
UNISYNC on each occurrence of the event.
For events reported automatically, it also specifies whether the event notification is alarmed
(reported via REPORT ALARM) or not alarmed (reported via REPORT EVENT).
In general, an alarmed event causes a standing condition on, and has immediate or potential
impact on, the operation or performance of the entity. Some form of maintenance effort is
required to restore normal operation or performance of the entity after the event occurs. A
non-alarmed event is not classified as an alarmed event.
The OS has the capability to set the notification attribute of events.
For an alarmed event, alarm severity may be classified as critical, major or minor.
RETRIEVE-ATTRIBUTE may be used to review these attributes before making a new
setting.
3.2.1.18.3Possible values of <modifier>:
EQPT

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

59

GILLAM-FEi

3.2.1.18.4 Description of parameters:


Name
<aid>

<ntfcncde>

<condtype>

<srveff>
<logctl>
<almescl>
<escltim>

Description
Identifies
the
equipment
unit,
the
synchronization input, depending on the
command code modifier, to which the given
event pertains.
Notification code specifies the type of
notification to be generated by the UNISYNC
on the occurrence of the event described in
<condtype>.
Identifies the type of event for which a
notification attribute (<ntfcncde>) is being
changed.
Effect on service caused by the standing or
alarm condition.
Indicates if the generated notification must be
logged or not.
Indicates if the alarm condition must be
escalated after the time specified in <escltim>.
Specifies the time expressed in hours after
which an alarm will be escalated to the next
higher severity level (by default, 24 hours as
recommended in GR-1244-CORE).

Type
Any suitable AID(s) for
the given view.

CR, MJ, MN, NA, NR

See <condtype> table


SA, NSA
LOG, NLOG
ESCL, NESCL
Decimal number.

3.2.1.18.5Examples:
SET-ATTR-EQPT::OUT3:t1::CR,UEQ,,,,SA,LOG,NESCL,0;
SET-ATTR-EQPT::INP1:t2::MJ,LOS,,;

3.2.1.18.6Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

60

GILLAM-FEi

3.2.1.19.SET-TH
3.2.1.19.1Command format:
SET-TH-EQPT:[<tid>]:<aid>:<ctag>::<montype>,<thlev>[,,,];

3.2.1.19.2Description:
SET-THRESHOLD instructs the UNISYNC to set the threshold level for a monitored
parameter that, when exceeded, will trigger an automatic message. The threshold level may
apply to one or more synchronization objects (input or oscillator).
Threshold setting for multiple monitored parameters will require multiple commands from the
OS.
The corresponding commands are RTRV-TH to retrieve the threshold values and ED-EQPT
to suppress them.

3.2.1.19.3Description of parameters:
Name
<aid>
<montype>
<thlev>

Description
Identifies a synchronization object instance
(input, oscillator).
Identifies the particular monitored parameter for
which threshold level is being set.
Desired threshold level to be set for <montype>.

Type
Any suitable AID for
the given view.
See <montype> table.
Decimal number

3.2.1.19.4Examples:
SET-TH-EQPT::INP1:t1::FFOFF30S,30000;
ED-EQPT::INP1:t2:::FFOFF30S=DLT;
SET-TH-EQPT::OSC:t3::FREQCORR,10000;
ED-EQPT::OSC:t4:::FREQCORR=DLT;

3.2.1.19.5Note:
A deny response can occur in the following cases:

Illegal syntax or parameter values


Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

61

GILLAM-FEi

3.2.2. Automatic Messages


3.2.2.1.REPT^ALM
3.2.2.1.1Message format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
<almcde>^<atag>^
REPT^ALM^{EQPT}
<cr> <lf> <rspblk> + ;
where <rspblk> has the format:
^^^[<aid>]:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,[<monval>],[<
thlev>] : <conddescr> <cr> <lf>

This automatic message must contain at least one occurrence of <rspblk>. It is allowed to
contain multiple <rspblk>s if applicable.
3.2.2.1.2Description
REPORT ALARM is generated by the UNISYNC to report the occurrence of alarmed events.
Trouble events occurring in the UNISYNC are classified as alarmed or non-alarmed events.
In general, an alarmed event causes a standing condition and has immediate or potential
impact on the operation or performance of the entity. Some form of maintenance effort is
required to restore normal operation or performance of the entity after the event has occurred.
A non-alarmed event is not reported with this message; the REPORT EVENT message is
used. The designation of specific trouble events as alarmed or non-alarmed events shall be
settable by using the SET-ATTRIBUTE input command.
Related messages are RETRIEVE-ALARM, RETRIEVE-CONDITION and REPORT
EVENT.
3.2.2.1.3Description of parameters:
Name
<rsphdr>
<almcde>

<atag>
<aid>

Description
Response header
Alarm code, identifies the nature of the automatic message based on its
priority of action. If multiple alarms are reported, <almcde> is the highest
severity of those reported. If the notification code, <ntfcncde>, is CL,
<almcde>, will be A^
Automatic message tag
Access identifier identifies the single equipment, interface, synchronization
input, oscillator, in the UNISYNC, depending on the message code
modifier, to which the alarm pertains

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

62

GILLAM-FEi

<ntfcncde>
<condtype>
<srveff>
<ocrdat>
<ocrtm>
<monval>

2-character notification code


Type of alarm indication
Effect on service caused by the alarm condition
Date when the event occurred
Time when the event occurred
Measured value of a monitored parameter, which may contain data related
to synchronization performance, if <condtype> is of the form T-x for a
threshold violation on <montype>x. This value is provided if this alarm
report has resulted from a degradation that has exceeded the defined or
specified threshold level
<thlev>
User defined threshold level
<conddescr> Detailed text description of the trouble

3.2.2.1.4Examples:
UNISYNC 04-03-03 14:57:31
** 0003 REPT ALM EQPT
"OUT2:MJ,UEQ,SA,03-03,14-57-31,,,,:\"Unequipped with necessary card\""
;

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

63

GILLAM-FEi

3.2.2.2.REPT^EVT
3.2.2.2.1Message format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
A^^<atag>^
REPT^EVT^{EQPT|T1}
<cr> <lf> <rspblk> + ;

where <rspblk> has the format:


^^^[<aid>]:<condtype>,<condeff>,<ocrdat>,<ocrtm>,,, [<monval>],[<thlev>] :
<conddescr> <cr> <lf>

This automatic message must contain at least one occurrence of <rspblk>. It is allowed to
contain multiple <rspblk>s if applicable.
3.2.2.2.2Description:
REPORT EVENT is generated by the UNISYNC to report the occurrence of non-alarmed
events.
Trouble events occurring in the UNISYNC are classified as alarmed or non-alarmed events.
Designation of specific trouble events as alarmed or non-alarmed events shall be settable by
using the SET-ATTRIBUTE input command.
The event being reported may be the change of the status or the occurrence of an irregularity,
which by itself is not severe enough to warrant an alarm notification.
This message may also be used to report the recovery from off-normal or trouble conditions
that were reported initially via REPT-EVT. This is done by using the <condtype> sent by the
original event report and using the value CL for <condeff>.
Related messages are RETRIEVE-CONDITION and REPORT ALARM (for reporting the
occurrence of an alarmed event).
3.2.2.2.3Description of parameters:
Name
<rsphdr>
<atag>
<aid>

Description
Response header
Automatic message tag
Access identifier identifies the single equipment, interface, synchronization
input, oscillator, in the UNISYNC, depending on the message code
modifier, to which the event pertains.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

64

GILLAM-FEi

<condtype>
<condeff>

Type of event
Indicates the effect of the event on the condition of the UNISYNC. The
event may initiate a standing condition, which can later be retrieved using
the RETRIEVE-CONDITION command or may initiate a transient
condition that does not change the basic condition of the UNISYNC for an
extended time period.
Valid values for <condeff> are as follows:
CL Standing Condition Cleared
SC Standing Condition Raised
TC Transient Condition
A null value for <condeff> defaults to TC.
Parameter grouping shall not be used with this parameter
<ocrdat>
Date when the event occurred
<ocrtm>
Time when the event occurred
<monval>
Measured value of a monitored parameter, which may contain data related
to synchronization performance, if <condtype> is of the form T-x for a
threshold violation on <montype>x. This value is provided if this event
report is the result of a threshold for a monitored parameter exceeding the
defined or specified threshold level
<thlev>
Threshold level for the monitored parameter specified in <condtype> if
<condtype> is of the form T-x for a threshold violation on <montype>x.
This value is provided if this event has resulted from degradation in the
monitored parameter causing it to exceed the specified threshold level.
<conddescr> Detailed text description of the specific event that caused this notification.

3.2.2.2.4Examples:
A

UNISYNC 05-01-12 14:53:15


0802 REPT EVT EQPT
"SSU:DBLOAD,TC,01-12,14-53-15,,,,:\"Start WKG DB loading from PRI DB\""

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

65

GILLAM-FEi

3.2.2.3.REPT^PM
3.2.2.3.1Message format:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^PM^T1
<cr> <lf> <rspblk> + ;
where <rspblk> has the format:
^^^<aid>:<montype>,<monval>,<vldty>, , , <tmper>, <mondat>, <montm> <cr>
<lf>

This automatic message must contain at least one occurrence of <rspblk>. It is allowed to
contain multiple <rspblk>s.
3.2.2.3.2Description
REPORT PERFORMANCE MONITORING is generated to inform the OS or maintenance
personnel of PM information.
REPT PM is an automatic message that is generated by the UNISYNCe as a result of a
previous SCHEDULE-PMREPT command received by the UNISYNCe.
PM data may also be retrieved on demand by a RETRIEVE-PM command, however REPT
PM is not used to respond to a RETRIEVE-PM command.
3.2.2.3.3Description of parameters:
Name
<aid>
<montype>
<monval>
<vldty>
<tmper>
<mondat>
<montm>

Description
Identifies the synchronization object instance (input, oscillator, feedback
monitoring input).
Indicates the type of monitored parameter whose value is being reported
Measured value of the monitored parameter
Validity indicator for the reported PM data
Indicates the accumulation time period for the PM information
Date of the beginning of the PM period specified in <tmper>
Beginning time of day of the PM period specified in <tmper>

3.2.2.3.4Examples:
A

UNISYNCE 05-01-12 10:15:17


4153 REPT PM T1
IOP-1:TDEV100S,0.2,COMPL,,,15M,01-12,10-00-00

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

66

GILLAM-FEi

UNISYNCE 08-06-12 10:15:17


0200 REPT PM T1
FBM3:DFF,\"5.3e-012,1000 sec,40 nsec\",COMPL,,,1S,06-12,10-15-17

UNISYNCE 08-06-16 14:59:02


0077 REPT PM T1
FBM3:DFF,\"0.0e+000,0 sec,0 nsec\",N/A,,,1S,06-16,14-59-02

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

67

GILLAM-FEi

4.

SECURITY ADMINISTRATION (TR-NWT-835)


4.1.

Introduction

The NESSA (Network System Security Administration) messages and NE/NS


responses described here are necessary to satisfy the needs related to NE/NS security
administration (see TR-NWT-835).
The security functionalities of the UNISYNC will be managed from TL1 commands.
4.2.

Data Model of NESSA

The conceptual data model of NESSA is similar to that of memory administration (see
GR-199-CORE and paragraph 1 of this document). The OS, looking into an NE,
sees a set of one or more administrative views of the NE database. Administrative
views are conceptual, representing the various data elements in the form of tables or
matrices. Each row of a table represents an object entity. Each column of a table
represents an attribute of the object entity. For example, security parameters related to
a user constitute an administrative view, where each user is an entity, and attributes are
parameters such as passwords, access privileges, etc. The OS transmits various
NESSA commands to the NE to cause either a query or an update of the security
parameters in the NE database.
The logical model of NESSA specifies the various data items that make up each
administrative view in the conceptual model. The method of representing data at this
logical level is by means of a data dictionary.
4.3.

UNISYNC NESSA functions

NESSA supported in an UNISYNC consists of the following types of messages:


1. Automatic messages indicating alarm/alert conditions:
Session logged off due to timeout
Intrusion suspected
Security log overflow
2. User initiated messages and responses associated with:
Setting up a session (login)
Terminating a session (logoff)
Updating a password
Retrieving, by a user, of certain security attributes associated with
that user or with the channel used by that user
Retrieving all User-Ids of users that are currently logged on
Retrieving all channels that are currently logged on.
3. Messages initiated by a security administrator to inquire/modify the current
status of sessions:
Terminate (log off) a current session associated with a specific user

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

68

GILLAM-FEi

Terminate (log off) a current session associated with a specific port


4. Messages initiated by a security administrator to enter, edit, delete (not
retrieve) any of the following:
Password (PID)
5. Messages initiated by a security administrator to enter, edit, delete or
retrieve any of the following:
User-Ids (UID) and their associated attributes (UAP, list of user
interfaces, )
Channel/Port Identifiers (CIDs) and their associated attributes
(CHAP, TMOUT, )
Commands and the corresponding access privileges required for
executing them (CAP)
4.4.

Message structure

The TL1 messages structure related to the administration of the UNISYNC security
parameters follows the rules described in the documents GR-831-CORE and TRNWT-835.
Different types of format are considered for:
Automatic messages
Input commands with their associated responses.
Depending on the nature of the automatic message, the UNISYNC may transmit it to
all users, a particular user, or only to a security administrator responsible for NE
security. The convention followed is that automatic messages reserved for a security
administrator have SECU as a modifier. Other messages do not have this modifier.
The non-automatic messages are of two categories:
Commands to be used only by a security administrator: they have SECU as a
modifier
Commands to be used by other users
In general, all messages , whether automatic or user-initiated, that are reserved for a
security administrator have the SECU modifier.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

69

GILLAM-FEi

4.5.

Supported messages
4.5.1. Security Commands
4.5.1.1.ACT-USER

4.5.1.1.1Command format:
ACT-USER:[<tid>]:<uid>:<ctag>::<pid>;

4.5.1.1.2Description:
This command starts a user session by logging on to UNISYNC.
4.5.1.1.3Description of parameters:
Name
<uid>
<pid>

Description
User Identifier (i.e. login)
Private Identifier (password)

Type
Symbolic name up to ten symbols.
Symbolic name up to ten characters,
where at least two are non-alphabetic
characters with at least one special
character.

4.5.1.1.4Examples:
ACT-USER::FEI: t3:fei.1;

4.5.1.1.5Example of normal response:


M

UNISYNC 05-01-12 14:43:33


t3 COMPLD
"FEI:2005-01-12 14:18:19,11"

This displayed data gives :


- date and time of the last session established by this UID,
- number of unsuccessful session attempts since last session.
4.5.1.1.6Note:
In human-machine interface mode password symbols are replaced by * when echoing the
command.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

70

GILLAM-FEi

A deny response can occur in the following cases:


Wrong user identity,
Wrong password.
Missing permissions for this channel.
Session is already running on the channel
Related command is CANC-USER.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

71

GILLAM-FEi

4.5.1.2.ALW-USER-SECU
4.5.1.2.1Command format:
ACT-USER:[<tid>]::<ctag>::<uid>;

4.5.1.2.2Description:
This command reinstates a UID that was inhibited by INH-USER-SECU so the user can
establish again a session with the UNISYNC..
4.5.1.2.3Description of parameters:
Name
<uid>

Description
User identifier (i.e. login)

Type
Symbolic name up to
ten symbols

4.5.1.2.4Examples:
ALW-USER-SECU:::t11: :RP;

4.5.1.2.5Note:
A deny response can occur in the following cases:
Missing security permissions for this command.
Illegal syntax or parameter values

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

72

GILLAM-FEi

4.5.1.3. CANC-CID-SECU
4.5.1.3.1Command format:
CANC-CID-SECU:[<tid>]:<cid>:<ctag>;

4.5.1.3.2Description:
This command terminates a session that is ongoing with the UNISYNC over a CID (craft,
telnet, ).

4.5.1.3.3Description of parameters:
Name
<cid>

Description
Channel identifier for which the ongoing
session is being terminated.

Type
CRAFT1, CRAFT2
TELN
TL1MNG1, TL1MNG6

4.5.1.3.4Examples:
CANC-CID-SECU::TL1MNG1&&-6:t1;

4.5.1.3.5Note:
A deny response can occur in the following cases:
Missing security permissions for this command.
Illegal syntax or parameter values
One or more of the target channels was not opened
If the command has the valid syntax but there is no user connection on some of the channels,
a partial response will be sent. The users logged on the channels to be closed will receive
CANC messages.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

73

GILLAM-FEi

4.5.1.4. CANC-USER
4.5.1.4.1Command format:
CANC-USER: [<tid>]:<uid>: <ctag>;

4.5.1.4.2Description:
This command terminates a session with the UNISYNC (i.e., logging off). The user can only
terminate his own session.
4.5.1.4.3Description of parameters:
Name
<uid>

Description
User identifier.

Type
Symbolic name up to
ten symbols

4.5.1.4.4Examples:
CANC-USER::FEI:008;

4.5.1.4.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

74

GILLAM-FEi

4.5.1.5. CANC-USER-SECU
4.5.1.5.1Command format:
CANC-USER-SECU: [<tid>]:<uid>:<ctag>;

4.5.1.5.2Description:
This command is used by a security administrator to terminate the session of a user with the
UNISYNC.
4.5.1.5.3Description of parameters:
Name
<uid>

Description
User identifier(s). It may be a single UID or a
block of UIDs.

Type
Each symbolic name up
to ten symbols

4.5.1.5.4Examples:
CANC-USER-SECU::CA:t1;

4.5.1.5.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
User with the uid is not logged on.
Missing security permissions for this command
The security administrator can cancel any user session, even a session of the other security
administrator. Channel is also closed. The user receives a CANC message.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

75

GILLAM-FEi

4.5.1.6. DLT-SECU
4.5.1.6.1Command format:
DLT-SECU: [<tid>]:COM: <ctag>::;

4.5.1.6.2Description:
This command deletes the security database of the UNISYNC (all user names, passwords,
channels and commands security permissions will be deleted.) and then recreates a default
security database. To be able to execute this command, all the user sessions should
beforehand have been closed.
4.5.1.6.3Description of parameters:
None
4.5.1.6.4Examples:
DLT-SECU::COM:t1::;

4.5.1.6.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
Not all the user sessions have been closed.

A new security database can be entered by the ENT-USER-SECU, ED-CID-SECU and EDCMD-SECU commands.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

76

GILLAM-FEi

4.5.1.7. DLT-USER-SECU
4.5.1.7.1Command format:
DLT-USER-SECU: [<tid>]:<uids>:<ctag>;

4.5.1.7.2Description:
This command deletes user(s)-related information from the UNISYNC security database.
4.5.1.7.3Description of parameters:
Name
<uids>

Description
User identifier(s). It may be a single UID or a
block of UIDs.

Type
Symbolic names up to
ten symbols each other

4.5.1.7.4Examples:
DLT-USER-SECU:UNISYNCSID:FEI:t1;

4.5.1.7.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
A new user can be entered with the ENT-USER-SECU command.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

77

GILLAM-FEi

4.5.1.8. ED-CID-SECU
4.5.1.8.1Command format:
ED-CID-SECU: [<tid>]:<id>:<ctag>::<chaps>:<keyword params>;

4.5.1.8.2Description:
This command edits the security parameters associated with the channel identifiers.
See channel-related security data dictionary.
4.5.1.8.3Description of parameters:
Name
<cid>

<chaps>
<keyword
params>

Description
Channel identifier(s). Here can be a single
CID, grouped and compound value. All the
channel names should be correct.
Channel access privilege. Position-defined
parameter block.
Keyword defined parameter block. Allowed
parameters are:
MXINV the maximum number of invalid
session setup attempts allowed
before the channel closing
TMOUT timeout interval in minutes. If there
is no input from user after the
timeout interval, the connection is
closed. A value of zero means no
inactivity detection.

Type
CRAFT1, CRAFT2
TELN
TL1MNG1, TL1MNG6
NONE, USER, ADMIN,
SECU

IntRange from 1 to 9

IntRange from 0 to 4320

4.5.1.8.4Examples:
ED-CID-SECU::TELN:t1::ADMIN&SECU&USER: MXINV = 3, TMOUT = 10;

4.5.1.8.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The modified channel access permissions will be applied immediately. The modified MXINV
or TMOUT parameters will be applied to the new connections on this channel.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

78

GILLAM-FEi

4.5.1.9. ED-CMD-SECU
4.5.1.9.1Command format:
ED-CMD-SECU: [<tid>]:<command name>:<ctag>::<caps>;

4.5.1.9.2Description:
This command edits the security parameters associated with the TL1 commands.
See the command-related security data dictionary.
4.5.1.9.3Description of parameters:
Name
<command
name>
<caps>

Description
Command verb and modifiers separated by
dashes. It may be a single command or a block
of commands.
Command access privilege. It can be a grouped
parameter value.

Type
Enum+: all allowed
UNISYNC commands
NONE,
USER,
ADMIN, SECU

4.5.1.9.4Examples:
ED-CMD-SECU::ED-CMD-SECU&ED-CID-SECU:1::ADMIN&SECU;

4.5.1.9.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The command access permissions changes will be applied immediately.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

79

GILLAM-FEi

4.5.1.10. ED-PID
4.5.1.10.1Command format:
ED-PID: [<tid>]:<uid>:<ctag>::<old pid>,<new pid>;

4.5.1.10.2Description:
This command edits users password. User can only change his password.
4.5.1.10.3Description of parameters:
Name
<uid>
<old pid>
<new pid>

Description
User's own UID, such as User's Login Name.
This old PID is being replaced by a new one.
This new PID replaces the old one.

4.5.1.10.4Examples:
ED-PID::FEI:t2::FEI.23,fei.23;

4.5.1.10.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
In the human-machine interface mode the passwords are replaced with *.
The password is up to 10 characters where at least two are non alphabetic characters with at
least one special character.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

80

GILLAM-FEi

4.5.1.11. ED-USER-SECU
4.5.1.11.1Command format:
ED-USER-SECU:[<tid>]:<uid>:<ctag>::<new uid>,<new pid>,<cid>,<uap>;

4.5.1.11.2Description:
This command edits the security parameters associated with a user (UID, PID, CID, UAP).
See the user-related security data dictionary.
4.5.1.11.3Description of parameters:
Name
<uid>
<new uid>

Description
User identifier such as User's Login Name,
as it currently exists.
New Login Name to replace the old one.

<new pid>

New user password

<cid>

Channel identifier(s). It can be a single CID


or a grouped parameter value.

<uap>

User access privilege. It can be a grouped


parameter value.

Type
Symbolic name up to ten
symbols
Symbolic name up to ten
symbols
Symbolic name up to ten
characters where at least
two are non-alphabetic
characters with at least one
special character
CRAFT1, CRAFT2
TL1MNG1, TL1MNG6
TELN
NONE, USER, ADMIN,
SECU

4.5.1.11.4Examples:
ED-USER-SECU::FEI:118::UNISYNC,Newpass,TELN&TL1MNG1&TL1MNG4,USER&NONE;

4.5.1.11.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The user is currently connected.
New user identity duplicates existing one
An administrator tries to attempt self-demotion to a lower authorization level.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

81

GILLAM-FEi

4.5.1.12. ENT-USER-SECU
4.5.1.12.1Command format:
ENT-USER-SECU:[<tid>]:<uid>:<ctag>::<pid>,<cid>,<uap>;

4.5.1.12.2Description:
This command enters the security parameters associated with a new user (UID, PID, CID,
UAP). See the user-related security data dictionary.
4.5.1.12.3Description of parameters:
Name
<uid>

Description
User identifier, such as User's Login Name.

Type
Symbolic name up to
ten symbols
Symbolic name up to
ten characters where at
least two are nonalphabetic
characters
with at least one special
character

<pid>

User password

<cid>

Channel identifier(s). It can be a single CID or a


grouped parameter value.

CRAFT1CRAFT2
TL1MNG1, TL1MNG6
TELN

<uap>

User access privilege. It can be a grouped


parameter value.

NONE, USER,
ADMIN, SECU

4.5.1.12.4Examples:
ENT-USER-SECU::chr:t1::chr.1,ALL,ADMIN&SECU;

4.5.1.12.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
New user identity duplicates existing one

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

82

GILLAM-FEi

4.5.1.13. INH-USER-SECU
4.5.1.13.1Command format:
INH-USER-SECU:[<tid>]::<ctag>::<uid>;

4.5.1.13.2Description:
This command inhibits (disables) an existing user (without deleting the user account), so the
user can be denied a session with the UNISYNC (the user cannot log on). A disabled UID can
be reinstated by using the ALW-USER-SECU command.
4.5.1.13.3Description of parameters:
Name
<uid>

Description
Position-defined parameter block. List of UIDs
that are being inhibited. Parameter grouping is
allowed.

4.5.1.13.4Examples:
INH-USER-SECU:::t1::RP&FEI;

4.5.1.13.5Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The changes apply to the next logging on of the users. If the user is connected the session will
not be canceled.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

83

GILLAM-FEi

4.5.1.14. RTRV-ALM-SECU
4.5.1.14.1Command format:
RTRV-ALM-SECU:[<tid>]:COM:<ctag>::,,,,;

4.5.1.14.2Description:
The command retrieves the list of security alarms.
The UNISYNC security alarms are :
Security log buffer 90% full
Security log buffer overflow
4.5.1.14.3Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

84

GILLAM-FEi

4.5.1.15. RTRV-CID-SECU
4.5.1.15.1Command format:
RTRV-CID-SECU:[<tid>]:<cid>:<ctag>[:];

4.5.1.15.2Description:
This command retrieves the security parameters associated with the channel identifiers.
4.5.1.15.3Description of parameters:
Name
<cid>

Description
Channel identifier(s). It may be a single CID
or a block of CIDs.

Type
CRAFT1, CRAFT2
TL1MNG1, TL1MNG6
TELN

4.5.1.15.4Examples:
rtrv-cid-secu:: tl1mng1&&-4&craft1&&craft2&TELN:009;

4.5.1.15.5Example of normal response:


M

UNISYNCSID 04-12-02 19:22:10


009 RTRV
TL1MNG1:ADMIN&SECU&USER:TMOUT=12,MXINV=8
TL1MNG2:ADMIN&SECU&USER:TMOUT=12,MXINV=8
TL1MNG3:ADMIN&SECU&USER:TMOUT=12,MXINV=8
TL1MNG4:ADMIN&SECU&USER:TMOUT=12,MXINV=8
CRAFT1:ADMIN&USER&SECU:TMOUT=15,MXINV=4
CRAFT2:ADMIN&SECU&USER:TMOUT=12,MXINV=8
TELN:NONE&USER&ADMIN&SECU:TMOUT=15,MXINV=3

4.5.1.15.6Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
Security parameters can be changed by ED-CID-SECU.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

85

GILLAM-FEi

4.5.1.16. RTRV-CMD-SECU
4.5.1.16.1Command format:
RTRV-CMD-SECU:[<tid>]:<command name>:<ctag>;

4.5.1.16.2Description:
This command retrieves the security parameters associated with TL1 commands.
4.5.1.16.3Description of parameters:
Name
<command
name>

Description
Command verb with modifiers separated by
dashes. It may be a single command or a block
of commands. We can use ALL to retrieve the
security parameters of all the commands.

4.5.1.16.4Examples:
rtrv-cmd-secu: UNISYNCSID:all:1;
rtrv-CMd-secu::Help&act-user:55:;

4.5.1.16.5Example of normal response:


M

UNISYNCSID 04-12-02 20:00:07


55 RTRV
HELP:ADMIN&SECU&NONE&USER
ACT-USER:ADMIN&USER&SECU&NONE

4.5.1.16.6Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
For parameter changing use ED-CMD-SECU.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

86

GILLAM-FEi

4.5.1.17. RTRV-STATUS
4.5.1.17.1Command format:
RTRV-STATUS:::<ctag>;

4.5.1.17.2Description:
This command retrieves the system status (regarding the number of UIDs and CIDs logged on
to the UNISYNC).
4.5.1.17.3Description of parameters:
None.
4.5.1.17.4Examples:
RTRV-STATUS:::006;

4.5.1.17.5Example of normal response:


M

UNISYNCSID 04-12-02 18:20:44


006 RTRV
:CRAFT1&TELN,RP&YS

4.5.1.17.6Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The retrieved data are :
List of CIDs logged on
List of corresponding UIDs logged on

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

87

GILLAM-FEi

4.5.1.18. RTRV-USER
4.5.1.18.1Command format:
RTRV-USER:<tid>:<uid>:<ctag>;

4.5.1.18.2Description:
This command retrieves the security parameters associated with the said user (except
password which cannot be retrieved).
See the security data dictionaries.
4.5.1.18.3Description of parameters:
Name
<uid>

Description
UID of the user who is retrieving the securityrelated parameters related to that UID.

4.5.1.18.4Examples:
rtrv-user::rp:007;

4.5.1.18.5Example of normal response:


M

UNISYNCSID 04-12-02 20:18:02


007 RTRV
RP:TL1MNG1&TL1MNG2&TL1MNG3&TL1MNG4&CRAFT1&CRAFT2&TELN,ADMIN&SECU

4.5.1.18.6Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
Only a security administrator can change this data by using the ED-USER-SECU. The user
can change his password by ED-PID.
The retrieved data are :
CID
UAP

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

88

GILLAM-FEi

4.5.1.19. RTRV-USER-SECU
4.5.1.19.1Command format:
RTRV-USER-SECU:<tid>:<uid>:<ctag>;

4.5.1.19.2Description:
This command retrieves the security parameters associated with a user (except password
which cannot be retrieved).
See the security data dictionaries.
4.5.1.19.3Description of parameters:
Name
<uid>

Description
User identifier(s). It may be a single UID or a
block of UIDs. Use ALL to retrieve the
security parameters of all the users.

Type
Symbolic names up to
ten symbols

4.5.1.19.4Examples:
RTRV-USER-SECU::RP&FEI:114;

4.5.1.19.5Example of normal response:


M

UNISYNCSID 09-12-02 20:39:31


114 RTRV
RP:TL1MNG1&TL1MNG2&TL1MNG3&TL1MNG4&CRAFT1&CRAFT2&TELN,ADMIN&SECU
FEI:ALL,USER&ADMIN&SECU

4.5.1.19.6Note:
A deny response can occur in the following cases:
Illegal syntax or parameter values
Missing security permissions for this command
The security administrator can change this data by using the ED-USER-SECU.
The retrieved data are :
UID
CID
UAP

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

89

GILLAM-FEi

4.5.2. Security Automatic Messages


4.5.2.1.REPT^ALM^SECU
4.5.2.1.1Message format:
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
<almcde>^<atag>^REPT^ALM^SECU <cr> <lf>
^^^<aid>:<ntfcncde>,<condtype>,,<ocrdat>,<ocrtm>,,:<conddescr><cr> <lf>;

4.5.2.1.2Description
This REPT ALM SECU message is generated to report the following conditions:
SECU Log buffer 90% full
SECU Log buffer overflow
4.5.2.1.3Description of parameters:
Name
<SID>

Description
System Identifier.

<DATE>

<TIME>

<almcde>

<atag>
<aid>

4396CHbf Rev. 1.12


02/24/2009

Date in a format YY-MM-DD, where YY is the


last two digits of the year ranging from 00 to 99,
MM is the month of the year ranging from 1 to
12, and DD is the day of the month ranging
from 1 to 31.
Time in a format of HH:MM:SS, where HH is
the hour in a 24 hour format ranging from 00 to
23, MM is the minute ranging from 00 to 59,
and SS is the second ranging from 00 to 59.
Alarm Code.
*C critical alarm,
** - major alarm,
*^ - minor alarm,
A^ - automatic message;
Automatic message tag.
Access Identifier. Identifies the entity to which
the alarm pertains

UNISYNCe
TL1 REFERENCE GUIDE

90

GILLAM-FEi

<ntfcncde>

<condtype>
<ocrdat>
<ocrtm>
<conddescr>

4396CHbf Rev. 1.12


02/24/2009

Notification code.
CR critical alarm,
MJ major alarm,
MN minor alarm,
CL clear alarm;
Type of alarm indication.
Date when the alarm occurred.
Time when the alarm occurred.
Detailed text description of the trouble.

UNISYNCe
TL1 REFERENCE GUIDE

91

GILLAM-FEi

4.5.2.2.CANC
4.5.2.2.1Message format :
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
A<atag>^CANC <cr> <lf>
<UID> <cr> <lf>;

Where <SID> is the source UNISYNC identifier, and <UID< refers to the User-ID of the user
whose session is terminated due to timeout.
4.5.2.2.2Description
This is an automatic message transmitted by the UNISYNC to a user when a session
established by the said user is terminated because of timeout.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

92

GILLAM-FEi

4.6.

Data dictionaries

The following data dictionaries are provided in the appendices:


User-Related Security data dictionary
Channel-Related Security data dictionary
Command-Related Security data dictionary

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

93

GILLAM-FEi

5.

APPENDICES
5.1.

Procedure to upgrade UNISYNC software


5.1.1. Introduction

This procedure can be used to install a new revision of software into the
UNISYNC.
5.1.2. Procedure
o Download the UNISYNC software to the UNISYNC with a TFTP client
(i.e., PumpKIN):
 Run PumpKIN and be sure that the PumpKIN options are
correctly set up:
Options -> Network
o Send outgoing request to port 69
o Default block size of 512 bytes
o Default connection timeout: 30 seconds
 Select Put File and then enter:
Local file (file name that you want to download: i.e.,
unisyncV1_1.dwn, )
Remote file (same than local file)
Remote host (IP address of the UNISYNC unit)
 Click OK.
o Wait until the download is completed.
o Reset the UNISYNC:
 Open a telnet connection to the UNISYNC
 Log into the UNISYNC:
Act-user::fei:t::fei.1;
 Enter the TL1 command: ed-eqpt::ssu:t:::reset=y;
 Confirm this command: ed-eqpt::ssu:t:::reset=y,conf=y;
o Wait until the reset of the UNISYNC is completed.
o Open a telnet connection to the UNISYNC.
o Log into the UNISYNC:
 Act-user::fei:t::fei.1;
o Verify that the new software running on the UNISYNC corresponds to
the new software release number:
 Use the TL1 command: rtrv-eqpt::gpxm:t;
 Check the SWVERSION parameter.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

94

GILLAM-FEi

5.2.

Data dictionaries
5.2.1. Equipment data dictionaries
5.2.1.1.SSU data dictionary

KEYWORD

TYPE

DOMAIN

CLEI

A/N

Up to 32 ASCII
characters

CONF

Y/N

DBACT

Y/N

Y or N

DBID

A/N

Up to 50 ASCII
characters

DHCP

Y/N

Y=use a DHCP
server ;
Default=N.

E1MFALM

ENUM

One of the

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Indicates the CLEI (Common
Language Equipment Identifier)
of the SSU card.
Confirms Service Affecting
TL1 command.
Y: Indicates that the UNISYNC
has still some writing activity
pending in order to update the
PRI DB (flash disk) on the SSU
card from the WKG DB
(RAM).
N: Indicates that the WKG DB
and the PRI DB have been
synchronized (same DB
content).
Indicates the Identifier of the
PRI DB:
SID.
Version of SSU card
software that has
created that DB.
Transaction Number.
Date.
Time.
Uses a DHCP server to get the
UNISYNC IP address.
If no DHCP server is used, then
the IP address of the NIC is
programmed by the IPADDR
parameter.
After a modification of the NIC
IP parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET), a restart of the
TCP/IP stack is necessary (see
ETHRST keyword).
Specifies the behaviour of the

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
RTRV-EQPT
Valid Commands :
ED-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:

95

GILLAM-FEi

following:
NONE
AIS
SSM
Default: SSM

E1SFALM

ENUM

One of the
following:
NONE
AIS
Default: NONE

E1TYPE

ENUM

One of the
following:

4396CHbf Rev. 1.12


02/24/2009

UNISYNC regarding its E1MF


outputs when the output signals
become unsuitable for
synchronization use.
For the concerned E1MF
outputs:
NONE: the output
signal is still supplied
AIS: the output signal
is changed to AIS.
SSM: the output signal
continuously generates
synchronization status
messages. In normal
operation, the
UNISYNC generates
the "G811"
synchronization
message. When it
enters the bridging
mode, the
synchronization status
messages indicate
"Synchronized
Traceability
Unknown".
The parameter ALMDE must
have been programmed to
E1ALM on the E1 OUT ports
for this behaviour to become
active.
Specifies the behaviour of the
UNISYNC regarding its E1SF
outputs when the output signals
become unsuitable for
synchronization use.
For the concerned E1SF
outputs:
NONE: the output
signal is still supplied
AIS: the output signal
is changed to AIS.
The parameter ALMDE must
have been programmed to
E1ALM on the E1 OUT ports
for this behaviour to become
active.
Programs the type of E1 output
supplied on OUT1, OUT12:

UNISYNCe
TL1 REFERENCE GUIDE

ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT

96

GILLAM-FEi

E1SF
E1MF
Default: E1MF.

ETHRST

Y/N

FASTRESET

Y/N

GATEW

INT-INT- Each integer can


INT-INT take the value from
0 to 255.
Default=192-1-2254.

HIST

A/N

Up to 100 ASCII
characters

HWVERSION

A/N

ID

A/N

Up to 10 ASCII
characters
Up to 64 ASCII

4396CHbf Rev. 1.12


02/24/2009

E1SF: G704 frame with


no multiframe structure
E1MF: G704 frame
with multiframe
structure (CAS and
CRC4).

Forces a restart of the TCP/IP


protocol stack.
In general, this operation is
needed after a modification of
the network parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET). This operation
should be confirmed by the user
(use of the CONF parameter).
Restarting the TCP/IP stack
causes a clear of all the current
TL1 TCP/IP sessions.
Forces a hardware reset of the
UNISYNC (should be
confirmed by the user: use of
the CONF parameter) . Unlike
the "RESET=Y" action, the
UNISYNC doesn't wait for the
warm-up of the oscillator. That
procedure reduces the time of
unavailability of the output
signals. A FASTRESET
should be used with the greatest
care.
Gateway address of the
Ethernet NIC.
The 32 bits IP address is coded
as 4 integers separated by a
dash: i.e., 192-1-2-51.
After a modification of the NIC
IP parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET), a restart of the
TCP/IP stack is necessary (see
ETHRST keyword).
Indicates the history
information of the card
(repairing, guarantee period,
)
Indicates the hardware version
of the installed card.
Could indicate the physical

UNISYNCe
TL1 REFERENCE GUIDE

RTRV-EQPT

Valid Commands:
ED-EQPT

Valid Commands:
ED-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands:

97

GILLAM-FEi

characters
INPCUR

ENUM

One of the
following:
GPS
INP1
INP2
-

INPFRCD

ENUM

One of the
following:
 GPS
 INP1
 INP2

INPMODQTY

INT

02

INPOVR

INT

One of the
following:
 GPS
 INP1
 INP2

INPSEL

ENUM

One of the
following:
GPS
INP1
INP2

4396CHbf Rev. 1.12


02/24/2009

location of the card (User


comment).
Returns the selected reference
synchronization input:
GPS
INP1
INP2
- :means that no
synchronization input is
currently selected.
Specifies the reference input to
select when the UNISYNC is
working in FRCD
synchronization mode (see
SYNMDE parameter).
The selected input will be
tracked if qualified otherwise
the oscillator will go to
HOLDOVER.
Gives the number of input
modules installed on the
UNISYNC card.
Specifies the reference input to
select when the UNISYNC is
working in AUTO
synchronization mode (see
SYNMDE parameter).
INPOVR overrides the current
selection algorithm of the
UNISYNC based on the
QLCUR and PRTY parameters
management.
That command will be denied if
it causes a switch to a failed
reference or to a low quality
reference (see input QLCUR
parameter). However, it will be
accepted if it causes a switch to
a low priority reference (see
input PRTY parameter).
Specifies the reference input to
select when the UNISYNC is
working in AUTO
synchronization mode (see
SYNMDE parameter).
That command will be denied if
it causes a switch to a failed
reference, to a low priority
reference (see input PRTY

UNISYNCe
TL1 REFERENCE GUIDE

ED-EQPT
RTRV-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands:
ED-EQPT

Valid Commands:
ED-EQPT

98

GILLAM-FEi

IPADDR

INT-INT- Each integer can


INT-INT take the value from
0 to 255.
Default=192-1-2-34.

LEDACO

ENUM

One of the
following:
O
Y

LEDCR

ENUM

One of the
following:
O
R
Default: O

LEDMJ

ENUM

One of the
following:
O
R
Default: O

LEDMN

ENUM

One of the
following:
O
Y

4396CHbf Rev. 1.12


02/24/2009

parameter) or to a low quality


reference (see input QLCUR
parameter).
IP address of the Ethernet NIC.
The 32 bits IP address is coded
as 4 integers separated by a
dash: i.e., 192-1-2-50.
After a modification of the NIC
IP parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET), a restart of the
TCP/IP stack is necessary (see
ETHRST keyword).
Indicates the state of the Alarm
Cut Off LED:
O: Off (all the audible
relays are inactive)
Y: Yellow (the audible
relays have been
activated).
The Alarm Cut Off condition is
automatically raised
(LEDACO=Y) when an alarm
is set.
The Alarm Cut Off condition is
automatically cleared
(LEDACO=O) when all the
alarms have been cleared. That
condition can also be cleared
manually with the OPR-ACO
TL1 command.
Indicates the state of the CR
LED:
O: Off
R: Red.
This led is turned red in case of
any CR alarms affecting the
UNISYNCe.
Indicates the state of the MJ
LED:
O: Off
R: Red.
This led is turned red in case of
any MJ alarms affecting the
UNISYNCe.
Indicates the state of the MN
LED:
O: Off
Y: Yellow.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

99

GILLAM-FEi

Default: O

MTU

INT

68 .. 1500
Default: 1500

NTPACT

Y/N

Y or N
Default: Y

PST

ENUM

One of the
following:
IS

RESET

Y/N

SIGNIN

A/N

Up to 128
characters.

SN

A/N

SSMGEN

ENUM

Up to 20 ASCII
characters
One of the
following :
GEN1
GEN2
Default: GEN2.

4396CHbf Rev. 1.12


02/24/2009

This led is turned yellow in


case of any MN alarms
affecting the UNISYNCe.
Specifies the Maximum
Transmission Unit (MTU) for
the Ethernet network interface.
The MTU is the maximum
packet size in bytes that the
transport will transmit over the
underlying network. The size
includes the transport header.
After a modification of the NIC
IP parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET), a restart of the
TCP/IP stack is necessary (see
ETHRST keyword).
Controls the administrative
status of the NTP Server (NTP
V3, SNTP V4).
Y = enable the NTP Server
N = disable the NTP Server
This keyword indicates the
primary state information of the
entity as defined in GR-1093CORE:
IS: In Service
Forces a hardware reset of the
UNISYNC (should be
confirmed by the user: use of
the CONF parameter). If the
oscillator has been warmed up,
the "FASTRESET=Y" action
can be used instead.
Indicates the message sent to
the user when a TL1 session is
opened (the parameter HMI
must be set at Y in the
communication channel:
TELN, CRAFT or TL1MNG).
Default: Welcome to
UNISYNCe TL1Agent!.
Indicates the serial number of
the installed card.
Program the SSM management
model as defined in the
document ANSI T1.101-1999
(Synchronization Interface
Standard):

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
ED-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

100

GILLAM-FEi

SUBNET

INT-INT- Each integer can


INT-INT take the value from
0 to 255.
Default=255-255255-0.

SYNMDE

ENUM

4396CHbf Rev. 1.12


02/24/2009

One of the
following:
AUTO
FRCD
Default: AUTO.

GEN1: FirstGeneration
Synchronization Status
Messages
GEN2: SecondGeneration
Synchronization Status
Messages.
Subnetmask of the Ethernet
LAN.
The 32 bits subnetmask is
coded as 4 integers separated
by a dash:i.e., 255-255-255-64.
After a modification of the NIC
IP parameters (DHCP,
IPADDR, GATEW, MTU and
SUBNET), a restart of the
TCP/IP stack is necessary (see
ETHRST keyword).
Specifies the synchronization
mode:
 AUTO
Auto synchronization mode:
normal state of working
(default). The UNISYNC
automatically manages the
switching to alternate timing
references. The selection of a
particular reference takes into
account the state of the inputs,
their priority (PRTY parameter)
and their current quality level
(QLCUR parameter). That
mode also allows the OS to
issue a Manual Reference
Switch command to a reference
specified with the INPSEL
parameter. This command will
be denied if it causes a switch
to a failed reference, to a low
priority reference (see input
PRTY parameter) or to a low
quality reference (see input
QLCUR parameter). It is
possible to override these
checks and to switch to a low
priority reference if the OS uses
the INPOVR parameter instead
of the INPSEL parameter to

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

101

GILLAM-FEi

TL1PORT

INT

19000
Default : 71

TMRRSW

A/N

Up to 19 ASCII
characters

TODACT

Y/N

Y or N
Default: N

TYPE

ENUM

One of the
following:
UNISYNCE

4396CHbf Rev. 1.12


02/24/2009

specify the reference to switch


to.
 FRCD
Forced synchronization mode.
Allows the OS to issue a Forced
Reference Switch command.
The reference input specified
by the OS with the INPFRCD
parameter will be tracked if
qualified otherwise the
oscillator will go to
HOLDOVER. An alarm
indicates to the OS that the
"Forced Reference Switch
Mode" has been entered.
Specifies the TCP port of the
Valid Commands:
UNISYNC TL1 agent.
ED-EQPT
RTRV-EQPT
Indicates the Time of Most Valid Commands:
Recent Reference Switch.
RTRV-EQPT
Format: YYYY-MM-DD
HH:MM:SS
Controls the administrative
Valid Commands:
status of the TOD Server on the ED-EQPT
TOD serial interface (NTP
RTRV-EQPT
clock driver type 4).
Y = enable the TOD Server
N = disable the TOD Server.
Refer to the "TOD Time Of
Day on serial interface"
paragraph in the appendices for
a description of the TOD
physical interface and TOD
message format.
Indicates the type of SSU:
Valid Commands:
RTRV-EQPT
UNISYNCe

UNISYNCe
TL1 REFERENCE GUIDE

102

GILLAM-FEi

5.2.1.2.GPXM data dictionary


KEYWORD

TYPE

DOMAIN

CLEI

A/N

Up to 32 ASCII
characters

CONF

Y/N

DST

Y/N

Y=use Daylight
Saving Time
N=do not use
Daylight Saving Time
Default=Y.

FACTORYRESET Y/N

HIST

A/N

Up to 100 ASCII
characters

HWVERSION

A/N

Up to 10 ASCII
characters

SN

A/N

Up to 20 ASCII
characters

SWVERSION

A/N

TZ

A/N

Up to 10 ASCII
characters
Up to 30 ASCII
characters
Default:
"WEUROPEST"

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Indicates the CLEI
(Common Language
Equipment Identifier) of
the installed GPXM
module (General Purpose
Xscale Module)
Confirms Service
Affecting TL1 command.
Programs the Daylight
Saving Time. DST is a
widely used system of
adjusting the official local
time forward, usually one
hour, from its official
winter standard time for
the duration of the spring
and summer months.
Forces a factory reset of
the UNISYNC. That
command must be
confirmed by the user
(use of the CONF
parameter).
The UNISYNC is
reconfigured with its
configuration by default.
Indicates the history
information of the GPXM
module (repairing,
guarantee period, )
Indicates the hardware
version of the GPXM
module.
Indicates the serial
number of the GPXM
module.
Indicates the version of
the UNISYNC software.
Specifies the Time Zone
in which the UNISYNC is
installed. The local time
is computed from the
UTC (Coordinated
Universal Time) received

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
RTRV-EQPT

Valid Commands:
ED-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands:
RTRV-EQPT
Valid Commands:
RTRV-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

103

GILLAM-FEi

from the GPS and the


value of the parameters
DST and TZ.
Examples of format used:
"WEUROPEST"
"WESTPACIFICST"
"GREENWICHST"

Refer to the list of Time


Zones given in the
appendices.
Be careful, a modification
of the TZ parameter can
lead to all the current TL1
sessions being closed.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

104

GILLAM-FEi

5.2.1.3.SNMP v1/v2c data dictionary


KEYWORD

TYPE

DOMAIN

DESCRIPTION
When the parameter
ACCESSCTL=Y, an
SNMP access control is
performed by checking
the IP addresses of the
SNMP managers.
Only the programmed
NMS addresses will be
authorized by the
UNISYNCe to issue
SNMP operations (GET,
SET, GETNEXT, ...).
Up to four NMS
addresses can be
provisioned (refer to the
NMSADDR parameters
in this SNMP data
dictionary).
A report of an
authentication failure trap
can be generated by the
UNISYNCe when an
SNMP manager attempts
to access a MIB variable
using incorrect
community strings.
That parameter can also
be programmed from
SNMP (refer to the snmp
group of the UNISYNCe
MIB).
Specifies the 32 bits IP
address of an NMS.
When this address is set
to 0-0-0-0 (default value),
this address is not taken
into account by the
SNMP access control
logic of the UNISYNCe.
Specifies the 32 bits IP
address of an NMS.
When this address is set
to 0-0-0-0 (default value),
this address is not taken

ACCESSCTL

Y/N

Y=enable the SNMP


access control
N=disable the SNMP
access control.
Default: N

ENBAUTHTRAP

Y/N

Y=enable the report


of the authentication
failure traps
N=disable the report
of the authentication
failure traps.
Default: Y

NMS1ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

NMS2ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

105

GILLAM-FEi

NMS3ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

NMS4ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

ROCOMMUNITY

A/N

RWCOMMUNITY

A/N

SYSCONTACT

A/N

Up to 30 ASCII
characters.
Default: public
Up to 30 ASCII
characters.
Default: private
Up to 255 ASCII
characters.
Default:

SYSLOCATION

A/N

Up to 255 ASCII
characters.
Default:

SYSNAME

A/N

Up to 255 ASCII
characters.
Default:

TRAP1ADDR

INT-

Each integer can take

4396CHbf Rev. 1.12


02/24/2009

into account by the


SNMP access control
logic of the UNISYNCe.
Specifies the 32 bits IP
address of an NMS.
When this address is set
to 0-0-0-0 (default value),
this address is not taken
into account by the
SNMP access control
logic of the UNISYNCe.
Specifies the 32 bits IP
address of an NMS.
When this address is set
to 0-0-0-0 (default value),
this address is not taken
into account by the
SNMP access control
logic of the UNISYNCe.
Specifies the read-only
access community string.
Specifies the read-write
access community string.
Identifies the primary
contact for the
equipment.
That parameter can also
be set and read from
SNMP (refer to the
system group of the
UNISYNCe MIB).
Indicates where the
equipment is located.
That parameter can also
be set and read from
SNMP (refer to the
system group of the
UNISYNCe MIB).
Indicates the equipments
fully-qualified domain
name.
That parameter can also
be set and read from
SNMP (refer to the
system group of the
UNISYNCe MIB).
Specifies the 32 bits IP

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:

106

GILLAM-FEi

INTINTINT

the value from 0 to


255.
Default=0-0-0-0

TRAP2ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

TRAP3ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

TRAP4ADDR

INTINTINTINT

Each integer can take


the value from 0 to
255.
Default=0-0-0-0

TRAPCOMMUNITY A/N

Up to 30 ASCII
characters.
Default: public
One of the following:
V1
V2
Default: V2

TRAPVERSION

4396CHbf Rev. 1.12


02/24/2009

ENUM

address of an NMS where


the traps must be sent.
The SNMP agent does
not take into account an
address set to 0-0-0-0
(default value).
Specifies the 32 bits IP
address of an NMS where
the traps must be sent.
The SNMP agent does
not take into account an
address set to 0-0-0-0
(default value).
Specifies the 32 bits IP
address of an NMS where
the traps must be sent.
The SNMP agent does
not take into account an
address set to 0-0-0-0
(default value).
Specifies the 32 bits IP
address of an NMS where
the traps must be sent.
The SNMP agent does
not take into account an
address set to 0-0-0-0
(default value).
Specifies the community
name that is inserted in
the reported traps.
Specifies the version of
the reported SNMP traps.

UNISYNCe
TL1 REFERENCE GUIDE

ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

107

GILLAM-FEi

5.2.1.4.OUTMODULE data dictionary


KEYWORD

TYPE

DOMAIN

CLEI

A/N

Up to 32 ASCII
characters

HIST

A/N

Up to 100 ASCII
characters

HWVERSION

A/N

Up to 10 ASCII
characters

SN

A/N

TYPE

ENUM

Up to 20 ASCII
characters
One of the following:
 E1
 E1FBM

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Indicates the CLEI
(Common Language
Equipment Identifier) of
the installed output module.
Indicates the history
information of the output
module (repairing,
guarantee period, )
Indicates the hardware
version of the output
module.
Indicates the serial number
of the output module.
Identifies the installed
plug-in card:
 E1: 10 E1 / 2048
Khz output ports
 E1FBM: 10 E1 /
2048 Khz output
ports and 10 E1 /
2048 Khz
Feedback
Monitoring input
ports

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands:
RTRV-EQPT
Valid Commands:
RTRV-EQPT

108

GILLAM-FEi

5.2.1.5.GPS data dictionary


KEYWORD

TYPE

DOMAIN

ANTCABLELGTH INT

0 500

ANTOCM

Y/N

Y or N
Default: Y

CONF

Y/N

FACTORYRESET

Y/N

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Specifies the length of
the antenna cable.
That length is expressed
in meters and includes
two sections of cable:
between the
antenna and the
lightning arrester
between the
lightning arrester
and the Up
Down Converter.
In general, an RG213
cable is used.
The default value is 0.
Programs the detection
of antenna open circuit
conditions.
Y = antenna open circuit
monitoring
N = no antenna open
circuit monitoring.
Confirms Service
Affecting TL1 command.
Forces a factory reset of
the GPS. That command
must be confirmed by the
user (use of the CONF
parameter).
The GPS deletes its
position knowledge and
forces at zero the
parameters HEIGHT,
LATITUDE and
LONGITUDE. It then
automatically starts a site
survey.
The parameters
HEIGHT, LATITUDE
and LONGITUDE will
be automatically updated
when available from the
GPS.
To facilitate the GPS site

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands :
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT
ED-EQPT

Valid Commands:
ED-EQPT
Valid Commands:
ED-EQPT

109

GILLAM-FEi

HEIGHT

A/N

Up to 10 ASCII
characters

ID

A/N

Up to 64 ASCII
characters

LATITUDE

A/N

Up to 20 ASCII
characters

LEDSEL

ENUM

One of the following:


O
G

LEDST

ENUM

One of the following:


O
G

4396CHbf Rev. 1.12


02/24/2009

survey, it is
recommended to
correctly program the
date/time fields of the
UNISYNC before
initiating the factory
reset. Use the TL1 EDDAT command for this
purpose.
Indicates the height with
respect to the GPS
reference ellipsoid
(WGS84). The units are
in meters.
Format used:
"144.32m"
Be sure before modifying
the HEIGHT that there is
no communication
problem with the GPS
receiver.
Could indicate the
physical location of GPS
receiver (User comment).
Specifies the latitude.
Latitude is measured in
degrees north or degrees
south of the earth's
equator.
Format used:
"15D 33M 45.987S N"
"32D 12M 25.231S S"
Be sure before modifying
the LATITUDE that
there is no
communication problem
with the GPS receiver.
Indicates the state of the
SEL LED:
O: Off
G: Green (this
GPS reference
has been selected
to provide the
timing reference
to the oscillator)
Indicates the state of the
STATUS LED:
O: Off

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
RTRV-EQPT
ED-EQPT

Valid Commands :
ED-EQPT
RTRV-EQPT
Valid Commands :
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

110

GILLAM-FEi

Y
R

LONGITUDE

A/N

Up to 20 ASCII
characters

MASKANGLE

INT

0 80
Default value: 15

NBTRACKEDSAT INT

0 12

PRTY

INT

1 11

PST

ENUM

One of the following:

4396CHbf Rev. 1.12


02/24/2009

G: Green
(provisioned
GPS and valid
signal)
Y: Yellow (only
MN alarms
affect the GPS)
R: Red (if any
CR or MJ alarms
affect the GPS)
Specifies the longitude.
Longitude is measured in
degrees east or degrees
west of the Greenwich
Meridian.
Format used:
"24D 53M 21.765S E"
"120D 45M 34.876S W"
Be sure before modifying
the LONGITUDE that
there is no
communication problem
with the GPS receiver.
Specifies the satellite
mask angle.
The GPS receiver will
attempt to track satellites
for which the elevation
angle is greater than the
satellite mask angle.
Indicates the number of
tracked satellites.
Specifies the priority of
the GPS.
The programmed priority
is used to select a
qualified REF input.
The priority 1 is higher
than the priority 11.
Default value: 1
This keyword indicates
the primary state and
qualifier information of
the entity as defined in
GR-1093-CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs,
the value of PST

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands :
ED-EQPT
RTRV-EQPT

Valid Commands :
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands :
ED-EQPT
RTRV-EQPT

Valid Commands :
ED-EQPT
RTRV-EQPT

111

GILLAM-FEi

4396CHbf Rev. 1.12


02/24/2009

IS
OOS

IS-{NR RST}
OOS- {AU
MA AUMA}

indicates the desired state


of the object.
When used in the
ENTER commands, a
null value for PST
defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST.
Valid values for PST
when used in the ENTER
and EDIT commands
are:
IS: In-Service
OOS: Out-OfService; OOSMA implied.
Out-Of-Service
for Management.
The PST parameter can
also be present in the
input and NORMAL
RESPONSE to a
command that uses the
RTRV (RETRIEVE)
verb. Mutually exclusive
qualifier values are
shown by the { }
construct.
Valid values for PST
when used in the
RETRIEVE commands
are:
IS: In-Service
with qualifier
NR(normal),
ANR
(abnormal), RST
(restricted) or
ANRST
(abnormal and
restricted).
OOS: Out-OfService with
qualifier AU
(autonomous),
AURST
(autonomous and

UNISYNCe
TL1 REFERENCE GUIDE

112

GILLAM-FEi

QLCUR

ENUM

QLSUBST

ENUM

REF

Y/N

4396CHbf Rev. 1.12


02/24/2009

One of the following:


G811
G812T
G812L
G813
DNU
PRS
STU
ST2
TNC
ST3E
ST3
SMC
ST4
DUS
RES
INVSSM
NOSSM
One of the following:
G811
G812T
G812L
G813
DNU
PRS
STU
ST2
TNC
ST3E
ST3
SMC
ST4
DUS
RES
DEA
Default: DEA
Y = REF
synchronization input.

restricted), MA
(management),
MAANR
(management
and abnormal) or
AUMA
(autonomous and
management).
Indicates the current
Quality Level of the
GPS:
G811
G812T
G813
DNU
PRS
STU

-: indicates that
the QL is not
available

Valid Commands:
RTRV-EQPT

Forces the Quality Level


of the GPS. This QL
value will be considered
by the automata to select
a REF input.
Valid values are:
G811
PRS
ST2

DEA:
deactivation of
the Quality Level
substitution
logic.
By default, the QL
substitution logic is
disabled.

Valid Commands :
ED-EQPT
RTRV-EQPT

Indicates that the GPS is


handled as a REF input.

Valid Commands :
RTRV-EQPT

UNISYNCe
TL1 REFERENCE GUIDE

113

GILLAM-FEi

SITESURVEY

Y/N

Y or N

SSUCABLELGTH

INT

0 500

4396CHbf Rev. 1.12


02/24/2009

When entered by the


user:
Y: requests the
GPS to perform
its automatic
position
determination
algorithm
N: requests the
GPS to abort its
current site
survey.
When retrieved:
Y: indicates that
the GPS is
currently
calculating its
position
N: indicates that
the survey is
completed.
Be sure before starting a
site survey that there is
no communication alarm
with the GPS receiver.
Do not modify manually
the height, longitude and
latitude parameters when
a site survey is in
progress.
These parameters will be
automatically updated.
Before initiating a GPS
site survey, it is
recommended to
correctly program the
date/time fields of the
UNISYNC. Use the TL1
ED-DAT command for
this purpose.
Specifies the length of
the cable between the
UNISYNC unit and the
Up Down Converter.
That length is expressed
in meters.
In general, an RG59
cable is used.
The default value is 0.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

114

GILLAM-FEi

STATE

ENUM

One of the following:


SITESURVEY
CLDSTRT
SATACQ
SATTRK
POSHOLD
-

WTRTIM

INT

20 .. 10000
Default: 20

4396CHbf Rev. 1.12


02/24/2009

When retrieved, indicates


the state of the GPS:
SITESURVEY:
the GPS is
automatically
determining its
position. The
site survey
process is user
initiated (see the
SITESURVEY
parameter)
CLDSTRT: the
GPS is in Cold
Start
SATACQ: the
GPS is acquiring
satellites
SATTRK: the
GPS is in narrow
track mode
POSHOLD: the
GPS is in
Position Hold
mode
- : means that the
GPS state is
unknown.
Specifies/indicates the
value of the "Wait To
Return" timer. This
timer is used to validate
the signal at the end of
the alarms affecting the
GPS.
Expressed in seconds.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

115

GILLAM-FEi

5.2.1.6.INP input data dictionary


KEYWORD

TYPE

DOMAIN

BRIDGED

Y/N

Y or [N]

CLEI

A/N

Up to 32 ASCII
characters

HIST

A/N

Up to 100 ASCII
characters

HWVERSION

A/N

Up to 10 ASCII
characters

ID

A/N

Up to 64 ASCII
characters

LEDSEL

ENUM

One of the following:


O
G

LEDST

ENUM

One of the following:


O
G
Y
R

LEVEL

A/N

Up to 10 ASCII
characters

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Y means that the input is
bridged and that the signal
input level should be raised
of 20 db.
The default value is N.
Indicates the CLEI
(Common Language
Equipment Identifier) of
the input module
Indicates the history
information of the input
module (repairing,
guarantee period, )
Indicates the hardware
version of the input
module.
Could indicate the physical
location of the
synchronization input (User
comment).
Indicates the state of the
SEL LED:
O: Off
G: Green (this
reference has been
selected to provide
the timing
reference to the
oscillator)
Indicates the state of the
STATUS LED:
O: Off
G: Green
(provisioned input
and valid signal)
Y: Yellow (only
MN alarms affect
the input)
R: Red (if any CR
or MJ alarms affect
the input)
Indicates the approximate
voltage level of the input
expressed in V peak peak.

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

116

GILLAM-FEi

PRTY

INT

1 11

PST

ENUM

One of the following:

4396CHbf Rev. 1.12


02/24/2009

IS
OOS

IS-{NR RST}
OOS- {AU MA
AUMA}

Specifies the priority of the


synchronization input.
The programmed priority is
used to select a qualified
REF input.
The priority 1 is higher
than the priority 11.
Default value: 1
This keyword indicates the
primary state and qualifier
information of the entity as
defined in GR-1093CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs, the
value of PST indicates the
desired state of the object.
When used in the ENTER
commands, a null value for
PST defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST.
Valid values for PST when
used in the ENTER and
EDIT commands are:
IS: In-Service
OOS: Out-OfService; OOS-MA
implied. Out-OfService for
Management.
The PST parameter can
also be present in the input
and NORMAL
RESPONSE to a command
that uses the RTRV
(RETRIEVE) verb.
Mutually exclusive
qualifier values are shown
by the { } construct.
Valid values for PST when
used in the RETRIEVE
commands are:
IS: In-Service with
qualifier
NR(normal), ANR

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

117

GILLAM-FEi

QLCUR

ENUM

QLSUBST

ENUM

4396CHbf Rev. 1.12


02/24/2009

One of the following:


G811
G812T
G812L
G813
DNU
PRS
STU
ST2
TNC
ST3E
ST3
SMC
ST4
DUS
RES
INVSSM
NOSSM
One of the following:
G811
G812T
G812L
G813
DNU
PRS
STU
ST2
TNC
ST3E

(abnormal), RST
(restricted) or
ANRST (abnormal
and restricted).
OOS: Out-OfService with
qualifier AU
(autonomous),
AURST
(autonomous and
restricted), MA
(management),
MAANR
(management and
abnormal) or
AUMA
(autonomous and
management).
Indicates the current
Quality Level of the input
G811
G812T
G812L
G813
DNU
PRS
STU

-: indicates that the
QL is not available
because of the
installed interface
type

Forces the Quality Level


of the input. This QL value
will be considered by the
automata to select a REF
input.
Valid values are:
G811
G812T
G812L
G813
DNU

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

118

GILLAM-FEi

ST3
SMC
ST4
DUS
RES
DEA
Default: DEA

REF

Y/N

RSTSSM

Y/N

SN

A/N

SSM

ENUM

TYPE

ENUM

4396CHbf Rev. 1.12


02/24/2009

PRS
ST2

DEA: deactivation
of the Quality
Level substitution
logic.
By default, the QL
substitution logic is
disabled.
Y=REF synchronization Specifies if the input is
input.
handled as a REF input or
N=measurement input.
as a measurement input.
Default: Y.
Y
In auto SSM mode
(SSM=AUTO), force a
restart of the SSM code
detection logic.
This command is only valid
if applied to DS1 ESF
inputs.
Up to 20 ASCII
Indicates the serial number
characters
of the installed input
module.
One of the following:
Indicates the SSM mode:
AUTO
AUTO: the
UNISYNC will
ON
automatically
OFF
activate the SSM
Default: AUTO
logic if a valid
SSM code is
detected at the
input
ON: the UNISYNC
activates the SSM
logic
OFF: the
UNISYNC doesnt
manage the SSM
codes
The SSM logic can always
be restarted in the AUTO
mode with the RSTSSM
keyword.
One of the following:
Identifies the input being
provisioned:
DS1SF
DS1SF: T1 signal
DS1ESF
in Super Frame
E1SF
format (usually
E1MF

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT
Valid Commands:
ED-EQPT

Valid Commands:
RTRV-EQPT
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT
Other :

119

GILLAM-FEi

CC
S2048KHZ
S1510MHZ
DCF77

WTRTIM

INT

4396CHbf Rev. 1.12


02/24/2009

20 .. 10000
Default: 20

framed all-ones
signal)
DS1ESF : T1
signal in Extended
Super Frame
format
E1SF: E1 signal in
a Single Frame
format
E1MF: E1 signals
in a Multi Frame
format with CAS
and CRC4
CC : CC signal
S2048KHZ : 2.048
MHz signal
S1510MHZ: 1
MHz signal, 5
MHz signal or 10
MHz signal
DCF77: DCF77
signal (requires the
installation of a
DCF77 input
module)

Specifies/indicates the
value of the "Wait To
Return" timer. This timer
is used to validate the
signal at the end of the
alarms affecting the input.
Expressed in seconds.

UNISYNCe
TL1 REFERENCE GUIDE

The type of the


input can only be
modified if the
input is set Out Of
Service.

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

120

GILLAM-FEi

5.2.1.7.AUX output data dictionary


KEYWORD

TYPE

DOMAIN

DESCRIPTION
Specifies the behaviour of the
UNISYNC when the output
signal becomes unsuitable for
synchronization use:
NONE: the output
signal is still supplied
SQUELCH: the
output signal is
squelched (default
mode)
It should be noted that all the
outputs of the UNISYNC are
always squelched during the
warm up of the oscillator.
Could indicate the physical
location of the output (User
comment).

ALMDE

ENUM

One of the following:


NONE
SQUELCH
Default: NONE

ID

A/N

Up to 64 ASCII
characters

PST

ENUM

One of the following:

4396CHbf Rev. 1.12


02/24/2009

IS
OOS

This keyword indicates the


primary state and qualifier
information of the entity as
defined in GR-1093-CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs, the
value of PST indicates the
desired state of the object.
When used in the ENTER
commands, a null value for
PST defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST. Valid
values for PST when used in
the ENTER and EDIT
commands are:
IS: In-Service
OOS: Out-OfService; OOS-MA
implied. Out-OfService for
Management.
The PST parameter can also

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

121

GILLAM-FEi

TYPE

ENUM

4396CHbf Rev. 1.12


02/24/2009

IS-{NR RST}
OOS- {AU
MA AUMA}

One of the following:


S1MHZ
S5MHZ
S10MHZ

be present in the input and


NORMAL RESPONSE to a
command that uses the RTRV
(RETRIEVE) verb. Mutually
exclusive qualifier values are
shown by the { }
construct.
Valid values for PST when
used in the RETRIEVE
commands are:
IS: In-Service with
qualifier NR(normal),
ANR (abnormal),
RST (restricted) or
ANRST (abnormal
and restricted).
OOS: Out-Of-Service
with qualifier AU
(autonomous),
AURST (autonomous
and restricted), MA
(management),
MAANR
(management and
abnormal) or AUMA
(autonomous and
management).
Identifies the output being
provisioned:
S1MHZ: signal at 1
Mhz
S5MHZ: signal at 5
Mhz
S10MHZ: signal at 10
Mhz

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

122

GILLAM-FEi

5.2.1.8. OUT output data dictionary


KEYWORD

DOMAIN

DESCRIPTION

ALMDE

ENUM

TYPE

One of the following:


NONE
SQUELCH
E1ALM
The default value
depends on the TYPE
of the output.

ID

A/N

Up to 64 ASCII
characters

Specifies the behaviour of the


UNISYNC when the output
signal becomes unsuitable for
synchronization use.
The supported mode depends
on the output TYPE:
For a S2048KHZ output:
NONE: the output
signal is still supplied
SQUELCH: the
output signal is
squelched.
NONE is the default mode for
the S2048KHZ output.
For an E1 output:
SQUELCH: the
output signal is
squelched
E1ALM: the alarming
mode is defined in
the E1SFALM
parameter for an
E1SF output. It is
defined in the
E1MFALM
parameter for an
E1MF output.
E1ALM is the default mode
for the E1 output.
The type of E1 signal supplied
by the UNISYNC depends on
the E1TYPE parameter of the
SSU object entity.
Refer also to the SSU data
dictionary for definition of the
parameters E1MFALM and
E1SFALM.
It should be noted that all the
outputs of the UNISYNC are
always squelched during the
warm up of the oscillator.
Could indicate the physical
location of the output (User
comment).

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

123

GILLAM-FEi

PST

ENUM

4396CHbf Rev. 1.12


02/24/2009

One of the following:

IS
OOS

IS-{NR RST}
OOS- {AU
MA AUMA}

This keyword indicates the


primary state and qualifier
information of the entity as
defined in GR-1093-CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs, the
value of PST indicates the
desired state of the object.
When used in the ENTER
commands, a null value for
PST defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST. Valid
values for PST when used in
the ENTER and EDIT
commands are:
IS: In-Service
OOS: Out-OfService; OOS-MA
implied. Out-OfService for
Management.
The PST parameter can also
be present in the input and
NORMAL RESPONSE to a
command that uses the RTRV
(RETRIEVE) verb. Mutually
exclusive qualifier values are
shown by the { }
construct.
Valid values for PST when
used in the RETRIEVE
commands are:
IS: In-Service with
qualifier NR(normal),
ANR (abnormal),
RST (restricted) or
ANRST (abnormal
and restricted).
OOS: Out-Of-Service
with qualifier AU
(autonomous),
AURST (autonomous
and restricted), MA
(management),
MAANR

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

124

GILLAM-FEi

QLCUR

ENUM

TYPE

ENUM

4396CHbf Rev. 1.12


02/24/2009

One of the following:


G811
STU
G812T
G812L
G813
DNU
One of the following:
S2048KHZ
E1

(management and
abnormal) or AUMA
(autonomous and
management).
Indicates the current quality
level of the output port:
G811
G812T

- : indicates that the
QL is not available.
Identifies the output being
provisioned:
S2048KHZ: signal at
2048 Khz
E1: signal at 2048
Kbps
The generated E1 signal
depends on the E1TYPE
parameter of the SSU object
entity.
It can be:
E1SF: G704 frame
with no multiframe
structure
E1MF: G704 frame
with multiframe
structure (CAS and
CRC4).

UNISYNCe
TL1 REFERENCE GUIDE

Valid commands :
RTRV-EQPT

Valid Commands :
ENT-EQPT
ED-EQPT
RTRV-EQPT

125

GILLAM-FEi

5.2.1.9. OSC data dictionary


KEYWORD

TYPE

DOMAIN

CONF

Y/N

FFOFFTH

INT

100 .. 1000000
0
Default: 60000

FREQCMD

INT

-5000000 .. 5000000

ID

A/N

Up to 64 ASCII
characters

LEDACQ

ENUM

One of the following:


O
G

LEDHO

ENUM

One of the following:


O
R

LEDLK

ENUM

One of the following:


O
G

LEDST

ENUM

One of the following:


O
G
Y
R

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Confirms Service Affecting
TL1 command.
Specifies the threshold used
for frequency offset alarm
detection.
Expressed in 10exp-12.
The value 0 can be used to
deactivate the management
of the FFOFF alarm.
Controls the frequency of
the oscillator: expressed in
f/f (10exp-12). The
oscillator must be first set in
the CMD state (refer to the
STATE parameter definition
in this dictionary).
Could indicate the physical
location of the oscillator
(User comment).
Indicates the state of the
ACQUIRE LED:
O: Off
G: Green (oscillator
in acquire)
Indicates the state of the
HOLDOVER LED:
O: Off
R: Red (oscillator in
holdover)
Indicates the state of the
LOCKED LED:
O: Off
G: Green (oscillator
in locked state)
Indicates the state of the
STATUS LED:
O: Off
G: Green (normal
operating condition)
Y: Yellow (MN
alarms affecting the
oscillator or
oscillator in warmup)
R: Red (hardware

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
ED-EQPT
Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

126

GILLAM-FEi

PST

ENUM

4396CHbf Rev. 1.12


02/24/2009

One of the following:

IS
OOS

IS-NR
IS-ANR
OOS- {AU MA
AUMA}

failure affecting the


oscillator)
This keyword indicates the
primary state and qualifier
information of the entity as
defined in GR-1093-CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs, the
value of PST indicates the
desired state of the object.
When used in the ENTER
commands, a null value for
PST defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST. Valid
values for PST when used in
the ENTER and EDIT
commands are:
IS: In-Service
OOS: Out-OfService; OOS-MA
implied. Out-OfService for
Management.
The PST parameter can also
be present in the input and
NORMAL RESPONSE to a
command that uses the
RTRV (RETRIEVE) verb.
Mutually exclusive qualifier
values are shown by the {
} construct.
Valid values for PST when
used in the RETRIEVE
commands are:
IS: In-Service with
qualifier
NR(normal), ANR
(abnormal).
OOS: Out-OfService with
qualifier AU
(autonomous), MA
(management),
MAANR
(management and

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

127

GILLAM-FEi

STATE

ENUM

One of the following:


NORMAL
LOCKED
BRIDGING
HOLDOVER
WMUP
FREERUN
ACQUIRE
CMD
-

TDPLLDCF77

INT

10 .. 100000

4396CHbf Rev. 1.12


02/24/2009

abnormal) or
AUMA
(autonomous and
management).
When retrieved, indicates
the state of the oscillator:
LOCKED: DPLL in
locked mode.
BRIDGING: in
bridging mode
HOLDOVER:
DPLL in confirmed
holdover mode
WMUP: warm-up
FREERUN:
oscillator in free-run
ACQUIRE:
oscillator in faststart
CMD: oscillator in
command state
-: unknown
When edited, the state of
the oscillator can be directed
to:
FREERUN
HOLDOVER
CMD: in this state,
it is possible to
control the
frequency of the
oscillator (see the
parameter
FREQCMD in this
dictionary).
NORMAL:
depending on the
conditions affecting
the UNISYNC, the
oscillator can go to
WMUP,
HOLDOVER,
BRIDGING,
ACQUIRE,
FREERUN or
LOCKED.
Time constant of the DCF77
DPLL expressed in seconds.
Default values automatically

UNISYNCe
TL1 REFERENCE GUIDE

Valid Cmds :
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

128

GILLAM-FEi

TDPLLGPS

INT

10 .. 100000

TDPLLINP

INT

10 .. 100000

TYPE

ENUM

One of the following:


STR2
STR3E
STR3

WARMUP

INT

60100000;
Default: 1800.

4396CHbf Rev. 1.12


02/24/2009

programmed in function of
the type of oscillator.
Time constant of the GPS
DPLL expressed in seconds.
Default values automatically
programmed in function of
the type of oscillator.
Time constant of the inputs
DPLL expressed in seconds.
Default values automatically
programmed in function of
the type of oscillator.
Indicates the type of
installed oscillator:
STR2: Stratum 2
oscillator
STR3E: Stratum 3E
oscillator
STR3: Stratum 3
oscillator
The oscillator type implies
the respect of the standards
and its associated values for
free-run accuracy, holdover
stability, pull-in/hold-in
range, transient, filtering, .
Warm-up time for the
oscillator expressed in
seconds.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
ED-EQPT
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands :
ED-EQPT
RTRV-EQPT

129

GILLAM-FEi

5.2.1.10.FBM data dictionary


KEYWORD

TYPE

DOMAIN

DFF

A/N

Up to 10 ASCII
characters

GT10M8

ENUM

One of the following:


CR
MJ
MN
NA
NR
Default: MJ

GT10M9

ENUM

One of the following:


CR
MJ
MN
NA
NR
Default: MJ

GT10M10

ENUM

One of the following:


CR
MJ
MN
NA
NR
Default: MN

4396CHbf Rev. 1.12


02/24/2009

DESCRIPTION
Indicates the frequency
offset of the feedback
monitoring input interface.
Scientific notation format:
i.e., "5.3e-012".
Specifies the notification
code associated with the
alarm "Frequency error
greater than 10exp-8":
CR: Critical alarm
MJ: Major alarm
MN: Minor alarm
NA: Not Alarmed
NR: Not Reported
(when the event
occurs the condition
is retained in the
Unisync).
Specifies the notification
code associated with the
alarm "Frequency error
greater than 10exp-9":
CR: Critical alarm
MJ: Major alarm
MN: Minor alarm
NA: Not Alarmed
NR: Not Reported
(when the event
occurs the condition
is retained in the
Unisync).
Specifies the notification
code associated with the
alarm "Frequency error
greater than 10exp-10":
CR: Critical alarm
MJ: Major alarm
MN: Minor alarm
NA: Not Alarmed
NR: Not Reported
(when the event
occurs the condition
is retained in the

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

130

GILLAM-FEi

GT10M11

ENUM

One of the following:


CR
MJ
MN
NA
NR
Default: MN

ID

A/N

Up to 64 ASCII
characters

LEVEL

A/N

Up to 10 ASCII
characters

PHASE

A/N

Up to 20 ASCII
characters

PST

ENUM

One of the following:

4396CHbf Rev. 1.12


02/24/2009

IS

Unisync).
Specifies the notification
code associated with the
alarm "Frequency error
greater than 10exp-11":
CR: Critical alarm
MJ: Major alarm
MN: Minor alarm
NA: Not Alarmed
NR: Not Reported
(when the event
occurs the condition
is retained in the
Unisync).
Could identify the feedback
monitoring input (User
comment).
Indicates the approximate
voltage level of the feedback
monitoring input expressed
in V peak peak.
Format: i.e., "5.5 Vpp".
Indicates the phase offset
since the beginning of the
feedback monitoring input
measurement process.
Expressed in nsec.
Format: i.e., "-4 nsec".
This keyword indicates the
primary state and qualifier
information of the entity as
defined in GR-1093-CORE.
When PST is used in
commands that use the
ENTER or EDIT verbs, the
value of PST indicates the
desired state of the object.
When used in the ENTER
commands, a null value for
PST defaults to IS.
When used in the EDIT
commands, a null value
means no change to the
current value of PST. Valid
values for PST when used in
the ENTER and EDIT
commands are:
IS: In-Service

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

131

GILLAM-FEi

OOS

IS-NR
IS-ANR
OOS- {AU
MA}

RSTALM

Y/N

TIME

A/N

Up to 25 ASCII
characters

TYPE

ENUM

One of the following:


E1
S2048KHZ

4396CHbf Rev. 1.12


02/24/2009

OOS: Out-OfService; OOS-MA


implied. Out-OfService for
Management.
The PST parameter can also
be present in the input and
NORMAL RESPONSE to a
command that uses the
RTRV (RETRIEVE) verb.
Mutually exclusive qualifier
values are shown by the {
} construct.
Valid values for PST when
used in the RETRIEVE
commands are:
IS: In-Service with
qualifier
NR(normal), ANR
(abnormal).
OOS: Out-OfService with
qualifier AU
(autonomous), MA
(management).
Restarts the feedback
monitoring input
measurement process.
Indicates the phase
measurement time.
Expressed in days and
seconds.
Format used:
1000 sec
1 day 300 sec
2 days 45213 sec.
Specifies the type of the
feedback monitoring input:
E1: E1 signal in
Single Frame format
or in Extended
Super Frame format
S2048KHZ: 2.048
MHz signal

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-EQPT
Valid Commands:
RTRV-EQPT

Valid Commands:
ENT-EQPT
ED-EQPT
RTRV-EQPT

132

GILLAM-FEi

5.2.2. Users interface port/channel data dictionary


5.2.2.1.Craft port data dictionary
For each of the commands related to this View, the AID is the Channel Identifier
(CID). It may be a single CID or a block of CIDs, where the block may include all
CIDs.
KEYWORD

TYPE

AO

Y/N

ATSTR

A/N

CNB

A/N

DATA

ENUM

ECHO

Y/N

FLOW

ENUM

4396CHbf Rev. 1.12


02/24/2009

DOMAIN

DESCRIPTION

Y=Enable the
Autonomous
Outputs.
N=Disable the
Autonomous
Outputs.
Default : Y.
NULL or any
combination of
alphanumeric
characters from 1 to
20 characters in
length.
Default: NULL.
NULL or any
combination of
alphanumeric
characters from 1 to
20 characters in
length.
Default: NULL.
7
8
Default: 8.

Controls the transmission of the


automatic messages.

Valid Commands:
ED-CID
RTRV-CID

Specifies the initial AT


command that must be sent to
the modem.

Valid Commands:
ED-CID
RTRV-CID
Applicable only if:
LOCAL=N

Specifies the called PSTN


number.

Valid Commands:
ED-CID
RTRV-CID
Applicable only if:
LOCAL=N

Specifies the number of data


bits per character:
7: 7 data bits per
character
8: 8 data bits per
character
Determines if local echo is
needed.

Valid Commands:
ED-CID
RTRV-CID

Y=local echo
N=no local echo
Default: Y.
HW
SW
NONE
Default: NONE.

Specifies the type of flow


control to apply on the craft
port:
HW: hardware flow
control
SW: XON/XOFF flow
control
NONE: no flow control

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS

Valid Commands:
ED-CID
RTRV-CID
Valid Commands:
ED-CID
RTRV-CID

133

GILLAM-FEi

HMI

Y/N

LOCAL

Y/N

PMRFSH

INT

PRTY

ENUM

NONE
ODD
EVEN
Default: NONE.

PST

ENUM

SPEED

ENUM

STOP

ENUM

One of the
following:
IS
110
300
600
1200
2400
4800
9600
14400
19200
38400
56000
57600
115200
Default: 9600
1
2
Default: 1.

SVREPORT

ENUM

4396CHbf Rev. 1.12


02/24/2009

Y=Human Machine
Interface.
N=Machine
Machine Interface.
Default : Y.
Y=local craft
terminal
N=remote OS
Default=Y.
13600
Default: 900.

One of the
following:
CR
MJ
MN
NONE
Default: MJ

Programs the behaviour of the


TL1 for a Human Machine
Interface or a Machine Machine
Interface.

Valid Commands:
ED-CID
RTRV-CID

Specifies if the craft port is


connected to a local craft
terminal or to a remote OS.

Valid Commands:
ED-CID
RTRV-CID

Specifies the automatic refresh


period of the requested PM
parameters.
Values expressed in seconds.
Specifies the parity used on the
port:
NONE: no parity
ODD: odd parity
EVEN: even parity
Indicates the state of the port:
IS: In-Service

Valid Commands:
ED-CID
RTRV-CID

Specifies the speed of the craft


port.
Values expressed in bits per
second.

Valid Commands:
ED-CID
RTRV-CID

Specifies the number of stop


bits used on the craft port:
1: 1 stop bit
2: 2 stop bit
Specifies the required severity
of a report to force the opening
of a remote PSTN connection:
CR: critical
MJ: major
MN: minor
The following conditions must
also be met:
AO=Y

Valid Commands:
ED-CID
RTRV-CID

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-CID
RTRV-CID

Valid Commands:
RTRV-CID

Valid Commands:
ED-CID
RTRV-CID

134

GILLAM-FEi

4396CHbf Rev. 1.12


02/24/2009

PST=IS
LOCAL=N
Valid CNB

UNISYNCe
TL1 REFERENCE GUIDE

135

GILLAM-FEi

5.2.2.2.TL1 remote manager data dictionary


For each of the commands related to this View, the AID is the Channel Identifier
(CID). It may be a single CID or a block of CIDs, where the block may include all
CIDs.
AO

Y/N

ECHO

Y/N

HMI

Y/N

IPADDR

INT-INTINT-INT

4396CHbf Rev. 1.12


02/24/2009

Y=Enable the
Autonomous
Outputs.
N=Disable the
Autonomous
Outputs.
Default : Y.
Y=local echo
N=no local echo
Default: N.
Y=Human Machine
Interface.
N=Machine
Machine Interface.
Default : N.
Each integer can
take the value from
0 to 255.
Default: 0-0-0-0

Controls the transmission of the


automatic messages.

Valid Commands:
ED-CID
RTRV-CID

Determines if local echo is


needed.

Valid Commands:
ED-CID
RTRV-CID
Valid Commands:
ED-CID
RTRV-CID

Programs the behaviour of the


TL1 for a Human Machine
Interface or a Machine Machine
Interface.
IP address of a remote manager
(OS). The 32 bits IP address is
coded as 4 integers separated by
a dash: i.e., 192-6-2-65.
The IPADDR parameter value
determines the behaviour of the
UNISYNC:
- 0-0-0-0:
This resource can be used to
manage incoming TCP/IP calls
if the IP address of the calling
system is not programmed in
any of the six TL1MNG
communication resources.
The UNISYNC is never going
to use this resource to generate
an outgoing TCP/IP call in
case of alarm appearance (see
parameter SVREPORT).
- An IP address different
from 0-0-0-0:
This resource can be used to
manage incoming TCP/IP calls
whose calling IP address
corresponds to the value
programmed here.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-CID
RTRV-CID

136

GILLAM-FEi

TL1PORT

INT

165535
Default : 71

PMRFSH

INT

13600
Default: 900.

PST

ENUM

SVREPORT

ENUM

One of the
following:
IS
One of the
following:
CR
MJ
MN
NONE
Default: MJ

4396CHbf Rev. 1.12


02/24/2009

The UNISYNC can use this


resource to generate an
outgoing TCP/IP call in case
of alarm appearance (see
parameter SVREPORT).
Specifies the TCP port of the
remote OS manager.
Returns the automatic refresh
period of the requested PM
parameters.
Values expressed in seconds.
Indicates the state of the port:
IS: In-Service
Specifies the required severity
of a report to force the opening
of a TCP/IP connection to a
remote manager addressed by
the socket formed by the couple
IPADDR and TL1PORT:
CR: critical
MJ: major
MN: minor
NONE: no open of a
remote TCP/IP
connection.
The following conditions must
also be met:
AO=Y
PST=IS
Valid IPADDR (not 00-0-0)

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-CID
RTRV-CID
Valid Commands:
ED-CID
RTRV-CID
Valid Commands:
RTRV-CID
Valid Commands:
ED-CID
RTRV-CID

137

GILLAM-FEi

5.2.2.3.Telnet channels data dictionary


For each of the commands related to this View, the AID is the Channel Identifier
(CID).
KEYWORD

TYPE

AO

Y/N

ECHO

Y/N

HMI

Y/N

PMRFSH

INT

PST

ENUM

TELNCUR

INT

TELNB

INT

4396CHbf Rev. 1.12


02/24/2009

DOMAIN

DESCRIPTION

Y=Enable the
Autonomous
Outputs.
N=Disable the
Autonomous
Outputs.
Default : Y.
Y=local echo
N=no local echo
Default: Y.
Y=Human Machine
Interface.
N=Machine
Machine Interface.
Default : Y.
13600
Default: 900.

Controls the transmission of the


automatic messages.

Valid Commands:
ED-CID
RTRV-CID

Determines if local echo is


needed.

Valid Commands:
ED-CID
RTRV-CID
Valid Commands:
ED-CID
RTRV-CID

One of the
following:
IS
04
14.
Default: 4.

Programs the behaviour of the


TL1 for a Human Machine
Interface or a Machine Machine
Interface.

RESTRICTIONS

Returns the automatic refresh


period of the requested PM
parameters.
Values expressed in seconds.
Indicates the state of the telnet
channels:
IS: In-Service
Gives the number of current
active telnet sessions.

Valid Commands:
ED-CID
RTRV-CID

Specifies the number of


simultaneous active telnet
sessions authorized.

Valid Commands:
ED-CID
RTRV-CID

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
RTRV-CID
Valid Commands:
RTRV-CID

138

GILLAM-FEi

5.2.3. Security data dictionary


5.2.3.1.User-Related Security data dictionary
For each of the commands related to this View, the AID is the User Identifier (UID,
i.e., users login name).
KEYWORD

TYPE

DOMAIN

DESCRIPTION

RESTRICTIONS

CID

(ENUM)+ A list of user


interface
ports/channels:
CRAFT1
CRAFT2
TL1MNG1
TL1MNG2
TL1MNG3
TL1MNG4
TL1MNG5
TL1MNG6
TELN
ALL
Default: ALL.

Valid Commands:
ENT-USER-SECU
ED-USER-SECU
RTRV-USERSECU

PID

A/N

Valid Commands:
ENT-USER-SECU
ED-USER-SECU
RTRV-USERSECU

UAP

A/N

4396CHbf Rev. 1.12


02/24/2009

Users interface port/channel.


When a session initiation
request (i.e., log-in) is received,
the NE checks the CID against
the CID as stored in the NE
database.
Valid values are:
CRAFT1: access from
craft port #1
CRAFT2: access from
craft port #2
TL1MNG1: access
from remote OS #1
TL1MNG2: access
from remote OS #2
TL1MNG3: access
from remote OS #3
TL1MNG4: access
from remote OS #4
TL1MNG5: access
from remote OS #5
TL1MNG6: access
from remote OS #6
TELN: Telnet access
ALL: access from all
ports.
Up to 10 characters, The Password. It must be
where at least two
stored in a one-way encrypted
are non-alphabetic
form so the user-related security
characters with at
view does not reveal it.
least one special
character.
A compound
User Access Privilege. A user
parameter of up to
is allowed to have up to 4
4 access privileges
access privileges:
connected by the
NONE
symbol &.
USER

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ENT-USER-SECU
ED-USER-SECU
RTRV-USERSECU

139

GILLAM-FEi

Default: NONE.
UID*

A/N

4396CHbf Rev. 1.12


02/24/2009

Up to 10
alphanumeric
characters.

ADMIN
SECU

The User Identifier. It is a


nonconfidential identifier that
uniquely determines a user
(login name). This parameter is
the key for each record in this
view. Each user must have a
unique UID.

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ENT-USER-SECU
ED-USER-SECU
RTRV-USERSECU

140

GILLAM-FEi

5.2.3.2.Channel-Related Security data dictionary


For each of the commands related to this View, the AID is the Channel Identifier
(CID). It may be a single CID or a block of CIDs, where the block may include all
CIDs.
KEYWORD
TYPE
DOMAIN
DESCRIPTION
RESTRICTIONS
CHAP

A/N

A compound
parameter of up to
4 access privileges
connected by the
symbol &.

CID*

(ENUM)

A user interface
port/channel :
CRAFT1
CRAFT2
TL1MNG1
TL1MNG2
TL1MNG3
TL1MNG4
TL1MNG5
TL1MNG6
TELN
.

MXINV

INT

19
Default: 9.

TMOUT

INT

0 4320
Default: 40.

4396CHbf Rev. 1.12


02/24/2009

Channel Access Privilege. A


channel may be assigned up to
4 access privileges:
NONE
USER
ADMIN
SECU
Channel Identifier. It addresses
a user interface port/channel.
This parameter is the key for
each record in this view.
Valid values are:
CRAFT1 : craft port #1
CRAFT2 : craft port #2
TL1MNG1: remote OS
#1
TL1MNG2: remote OS
#2
TL1MNG3: remote OS
#3
TL1MNG4: remote OS
#4
TL1MNG5: remote OS
#5
TL1MNG6: remote OS
#6
TELN: Telnet access
Specifies the maximum number
of invalid session setup
attempts allowed (illegal UID,
PID, CID, ) before it is
suspected as an intrusion
attempt and appropriate action
taken such as generating alert
messages.
Time Out Interval expressed in
minutes. If there are no
exchanged messages on the
port/channel over the TMOUT
interval, the session is logged

UNISYNCe
TL1 REFERENCE GUIDE

Valid Commands:
ED-CID-SECU
RTRV-CID-SECU

Valid Commands:
ED-CID-SECU
RTRV-CID-SECU

Valid Commands:
ED-CID-SECU
RTRV-CID-SECU

Valid Commands:
ED-CID-SECU
RTRV-CID-SECU

141

GILLAM-FEi

off.
Value 0 means no activity time
out detection.

5.2.3.3.Command-Related Security data dictionary


For each of the commands related to this View, the AID is the command verb along
with verb modifier(s). It may be a single command or a block of commands, where
the block may include all commands.
KEYWORD
COMMAND*

CAP

TYPE

DOMAIN

DESCRIPTION

A/N

Any combination of Command Verb together with


up to 20 characters. verb modifiers.
For example, ENT-CMD-SECU
is a command where ENT is the
verb that has two modifiers:
CMD and SECU.
This parameter is the key for
each record in this view.
(ENUM)+ A list of up to 4
Command Access Privilege. A
access privileges:
command is allowed up to 4
access privileges.
NONE
Before executing a command,
USER
the UNISYNC checks if at least
ADMIN
one of these access privileges is
SECU
contained within the
intersection of UAP and CHAP.
If not, the NE refuses to execute
the command.
See the CAP list for default
values.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

RESTRICTIONS
Valid Commands:
ED-CMD-SECU
RTRV-CMD-SECU

Valid Commands:
ED-CMD-SECU
RTRV-CMD-SECU

142

GILLAM-FEi

5.3.

List of Time Zones

TZ
AFGHANISTANST
ALASKANST
ARABST
ARABIANST
ARABICST
ATLANTICST
AUSCENTRALST
AUSEASTERNST
AZERBAIJANST
AZORESST
CANADACENTRALST
CAPEVERDEST
CAUCASUSST
CENAUSTRALIAST
CENTRALAMERICAST
CENTRALASIAST
CENTRALBRAZILIANST
CENTRALEUROPEST
CENTRALEUROPEANST
CENTRALPACIFICST
CENTRALST
CENTRALSTMEXICO
CHINAST
DATELINEST
EAFRICAST
EAUSTRALIAST
EEUROPEST
ESOUTHAMERICAST
EASTERNST
EGYPTST
EKATERINBURGST
FIJIST
FLEST
GEORGIANST
GMTST
GREENLANDST
GREENWICHST
GTBST

4396CHbf Rev. 1.12


02/24/2009

Description of the Time Zone


(UTC+04:30) Afghanistan Standard Time
(UTC-09:00) Alaskan Standard Time
(UTC+03:00) Arab Standard Time
(UTC+04:00) Arabian Standard Time
(UTC+03:00) Arabic Standard Time
(UTC-04:00) Atlantic Standard Time
(UTC+09:30) AUS Central Standard Time
(UTC+10:00) AUS Eastern Standard Time
(UTC+04:00) Azerbaijan Standard Time
(UTC-01:00) Azores Standard Time
(UTC-06:00) Canada Central Standard Time
(UTC-01:00) Cape Verde Standard Time
(UTC+04:00) Caucasus Standard Time
(UTC+09:30) Cen. Australia Standard Time
(UTC-06:00) Central America Standard Time
(UTC+06:00) Central Asia Standard Time
(UTC-04:00) Central Brazilian Standard Time
(UTC+01:00) Central Europe Standard Time
(UTC+01:00) Central European Standard Time
(UTC+11:00) Central Pacific Standard Time
(UTC-06:00) Central Standard Time
(UTC-06:00) Central Standard Time (Mexico)
(UTC+08:00) China Standard Time
(UTC-12:00) Dateline Standard Time
(UTC+03:00) E. Africa Standard Time
(UTC+10:00) E. Australia Standard Time
(UTC+02:00) E. Europe Standard Time
(UTC-03:00) E. South America Standard Time
(UTC-05:00) Eastern Standard Time
(UTC+02:00) Egypt Standard Time
(UTC+05:00) Ekaterinburg Standard Time
(UTC+12:00) Fiji Standard Time
(UTC+02:00) FLE Standard Time
(UTC+03:00) Georgian Standard Time
(UTC) GMT Standard Time
(UTC-03:00) Greenland Standard Time
(UTC) Greenwich Standard Time
(UTC+02:00) GTB Standard Time

UNISYNCe
TL1 REFERENCE GUIDE

143

GILLAM-FEi

HAWAIIANST
INDIAST
IRANST
JERUSALEMST
JORDANST
KOREAST
MALAYPENINSULAST
MIDATLANTICST
MIDDLEEASTST
MONTEVIDEOST
MOUNTAINST
MOUNTAINSTMEXICO
MYANMARST
NAMIBIAST
NCENTRALASIAST
NEPALST
NEWZEALANDST
NEWFOUNDLANDST
NORTHASIAEASTST
NORTHASIAST
PACIFICSAST
PACIFICST
PACIFICSTMEXICO
ROMANCEST
RUSSIANST
SAEASTERNST
SAPACIFICST
SAWESTERNST
SAMOAST
SEASIAST
SOUTHAFRICAST
SRILANKAST
TAIPEIST
TASMANIAST
TOKYOST
TONGAST
USEASTERNST
USMOUNTAINST
VLADIVOSTOKST
WAUSTRALIAST
WCENTRALAFRICAST
WEUROPEST
WESTASIAST
WESTPACIFICST

4396CHbf Rev. 1.12


02/24/2009

(UTC-10:00) Hawaiian Standard Time


(UTC+05:30) India Standard Time
(UTC+03:30) Iran Standard Time
(UTC+02:00) Jerusalem Standard Time
(UTC+02:00) Jordan Standard Time
(UTC+09:00) Korea Standard Time
(UTC+08:00) Malay Peninsula Standard Time
(UTC-02:00) Mid-Atlantic Standard Time
(UTC+02:00) Middle East Standard Time
(UTC-03:00) Montevideo Standard Time
(UTC-07:00) Mountain Standard Time
(UTC-07:00) Mountain Standard Time (Mexico)
(UTC+06:30) Myanmar Standard Time
(UTC+02:00) Namibia Standard Time
(UTC+06:00) N. Central Asia Standard Time
(UTC+05:45) Nepal Standard Time
(UTC+12:00) New Zealand Standard Time
(UTC-03:30) Newfoundland Standard Time
(UTC+08:00) North Asia East Standard Time
(UTC+07:00) North Asia Standard Time
(UTC-04:00) Pacific SA Standard Time
(UTC-08:00) Pacific Standard Time
(UTC-08:00) Pacific Standard Time (Mexico)
(UTC+01:00) Romance Standard Time
(UTC+03:00) Russian Standard Time
(UTC-03:00) SA Eastern Standard Time
(UTC-05:00) SA Pacific Standard Time
(UTC-04:00) SA Western Standard Time
(UTC-11:00) Samoa Standard Time
(UTC+07:00) SE Asia Standard Time
(UTC+02:00) South Africa Standard Time
(UTC+06:00) Sri Lanka Standard Time
(UTC+08:00) Taipei Standard Time
(UTC+10:00) Tasmania Standard Time
(UTC+09:00) Tokyo Standard Time
(UTC+13:00) Tonga Standard Time
(UTC-05:00) US Eastern Standard Time
(UTC-07:00) US Mountain Standard Time
(UTC+10:00) Vladivostok Standard Time
(UTC+08:00) W. Australia Standard Time
(UTC+01:00) W. Central Africa Standard Time
(UTC+01:00) W. Europe Standard Time
(UTC+05:00) West Asia Standard Time
(UTC+10:00) West Pacific Standard Time

UNISYNCe
TL1 REFERENCE GUIDE

144

GILLAM-FEi

YAKUTSKST

4396CHbf Rev. 1.12


02/24/2009

(UTC+09:00) Yakutsk Standard Time

UNISYNCe
TL1 REFERENCE GUIDE

145

GILLAM-FEi

5.4.

<aid> - Access Identifier

<aid> represents the AID that identifies an entity (or group thereof) in the UNISYNC
to which the command pertains. Addressing rules are discussed in section 2.6.4.1.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

146

GILLAM-FEi

5.5.

<almcde> - Alarm Code

<almcde> identifies the nature of the automatic message based on its priority of action.
The valid values of <almcde> in decreasing order of severity are as follows:
<almcde>
*C
**
*^
A^

ALARM DESCRIPTION
Critical Alarm
Major Alarm
Minor Alarm
Automatic Message

If the notification code, <ntfcncde>, is CL, <almcde>, will be A^.


If multiple alarms are reported, <almcde> is the highest severity of those reported.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

147

GILLAM-FEi

5.6.

<almescl> - Alarm Escalation

<almescl> indicates if the alarm condition must be escalated after the time specified in
<escltim>
Value
ESCL
NESCL

4396CHbf Rev. 1.12


02/24/2009

Value usage
Escalation of alarm requested
No escalation of alarm requested

UNISYNCe
TL1 REFERENCE GUIDE

148

GILLAM-FEi

5.7.

Command Access Privilege (CAP) List

COMMAND
ACT-USER
ALW-MSG
ALW-USER-SECU
CANC-CID-SECU
CANC-USER
CANC-USERSECU
DLT-EQPT
DLT-SECU
DLT-USER-SECU
ED-CID
ED-CID-SECU
ED-CMD-SECU
ED-DAT
ED-EQPT
ED-PID
ED-USER-SECU
ENT-EQPT
ENT-USER-SECU
HELP
INH-MSG
INH-USER-SECU
INIT-LOG
INIT-REG
INIT-SYS
MENU
OPR-ACO
RTRV-ALM
RTRV-ALM-SECU
RTRV-AO
RTRV-ATTR
RTRV-CID
RTRV-CID-SECU
RTRV-CMD-SECU
RTRV-COND
RTRV-EQPT
RTRV-HDR
RTRV-LOG
RTRV-NETYPE

4396CHbf Rev. 1.12


02/24/2009

COMMAND ACCESS PRIVILEGE (default)


NONE
USER
ADMIN
SECU
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x

x
x
x

x
x

x
x

x
x

x
x
x

x
x
x

x
x
x
x
x
x

x
x
x

x
x
x

x
x

x
x
x
x
x

UNISYNCe
TL1 REFERENCE GUIDE

x
x
x
x
x

149

GILLAM-FEi

RTRV-NETYPEALL
RTRV-PM

RTRV-SAT

x
x

x
x

x
x
x

RTRV-STATUS
RTRV-USER
RTRV-USERSECU
SCHED-PMREPT
SET-ATTR
SET-SID

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

x
x
x

150

GILLAM-FEi

5.8.

<conddescr> - Condition Description

<conddescr> is a detailed text description of the condition, state, trouble (ALM


commands) or specific event. <conddescr> contains a text string of no more than 64
characters enclosed within a pair of escaped quotes.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

151

GILLAM-FEi

5.9.

<condtype> - Condition Types

The UNISYNC reports the most specific condition type that describes the condition.
The construct T-x allows for <condtype>s that identify threshold violations. For
example, T-TDEV-100S pertains to a threshold violation for the monitored parameter
TDEV-100S.
In the following tables :
- NR* means Not Reported transient condition
- NA* means Not Alarmed transient condition

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

152

GILLAM-FEi

5.9.1. <condtype> affecting SSU card


<condtype>

<conddescr>

<ntfcncde>

<srveff>

<logctl>

LOGBUFRINIT-EVT
LOGBUFR90-EVT
LOGBUFROVFL-EVT
LOGBUFRINIT-SECU
LOGBUFR90-SECU
LOGBUFROVFL-SECU
LOGBUFRINIT-DBCHG
LOGBUFR90-DBCHG
LOGBUFROVFL-DBCHG
BOOT
SFT

EVT Log buffer initialized


EVT Log buffer 90% full
EVT Log buffer overflow
SECU Log buffer initialized
SECU Log buffer 90% full
SECU Log buffer overflow
DBCHG Log buffer initialized
DBCHG Log buffer 90% full
DBCHG Log buffer overflow
System started
Internal Software Event
generated
Intrusion attempt suspected
Date and time modification
AO Log buffer initialized
AO Log buffer 90% full
AO Log buffer overflow
Start WKG DB loading from
PRI DB
WKG DB loading completed
No Compatibility File Found
Bad Compatibility File Format
Bad Compatibility File Version
Hardware Compatibility
Mismatch
DB Compatibility Mismatch
No External 48VA detected
No External 48VB detected
Forced Reference Switch
Mode
Loss of all timing references
Low quality output signals
(ALMDE)
Output signals squelched
(Warm-up)
FPGA hardware failure
Oscillator module missing
Change of LED state
Date and time modification

NR*
NR
NR
NR*
NR
NR
NR*
NR
NR
NA*
NA

N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

NA*
NR
NR*
NR
NR
NA*

N
N
N
N
N
N

Y
Y
Y
Y
Y
Y

NA*
CR
CR
CR
CR

N
Y
Y
Y
Y

Y
Y
Y
Y
Y

CR
MJ
MJ
MN

Y
Y
Y
Y

Y
Y
Y
Y

MJ
MJ

Y
Y

Y
Y

MN

MJ
MJ
NA*
NR*

Y
Y
N
N

Y
Y
N
Y

INTRU
EDDAT
LOGBUFRINIT-AO
LOGBUFR90-AO
LOGBUFROVFL-AO
DBLOAD
ENDDBLOAD
NOCOMPATFF
BADCOMPATFF
BADCOMPATFV
HWCM
DBCM
E48VA
E48VB
FRCDSYNMDE
SYNCOOS
LOWQLOUT
OUTSQ
FPGAERR
OSCMISSING
LEDCHG
GPSDATE

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

153

GILLAM-FEi

5.9.2. <condtype> affecting GPS


<condtype>
CNFERR
HWERR
SIS
SOOS
REFSEL
UEQ
SITESURVEY
CLDSTRT
SATACQ
SATTRKNG
POSHOLD
UDCCOMERR
NOPPS
UDCOC
UDCSC
ANTOC
ANTSC
NOSAT
TOOFEWSAT
LOWQL
PNF
INPVAL
LEDCHG

4396CHbf Rev. 1.12


02/24/2009

<conddescr>
Configuration error
Hardware failure
Set In Service
Set Out Of Service
Reference input selected
Unequipped with necessary card
Site survey in progress
GPS in coldstart
Satellites acquisition
Satellites tracking
Position HOLD
No omm.. with receiver
No 1 PPS signal
Up Down Converter open circuit
Up Down Converter short circuit
Antenna open circuit
Antenna short circuit
No satellite detected
Too few satellites detected
SSM Quality Level below active clock
Position Not Fixed
Input signal validation
Change of LED state

UNISYNCe
TL1 REFERENCE GUIDE

<ntfcncde>

<srveff>

<logctl>

MJ
MJ
NR*
NR*
NA*
MJ
NA
NA
NA
NA
NA
MN
MN
MN
MN
MN
MN
MN
MN
MN
MJ
NA
NA*

Y
Y
N
N
N
Y
N
N
N
N
N
Y
Y
Y
Y
Y
Y
Y
Y
N
Y
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
N

154

GILLAM-FEi

5.9.3. <condtype> affecting AUX output ports


<condtype>
OEENT
OEDLT
SIS
SOOS
HWERR
SCDET

4396CHbf Rev. 1.12


02/24/2009

<conddescr>
Object Entity creation
Object Entity deletion
Set In Service
Set Out Of Service
Hardware failure
Short Circuit detected

UNISYNCe
TL1 REFERENCE GUIDE

<ntfcncde>

<srveff>

<logctl>

NR*
NR*
NR*
NR*
MJ
MN

N
N
N
N
Y
Y

Y
Y
Y
Y
Y
Y

155

GILLAM-FEi

5.9.4. <condtype> affecting OUT output ports


<condtype>
OEENT
OEDLT
SIS
SOOS
HWERR
SCDET
UEQ
MEA

4396CHbf Rev. 1.12


02/24/2009

<conddescr>
Object Entity creation
Object Entity deletion
Set In Service
Set Out Of Service
Hardware failure
Short Circuit detected
Unequipped with necessary card
TYPE incompat. with output module

UNISYNCe
TL1 REFERENCE GUIDE

<ntfcncde>

<srveff>

<logctl>

NR*
NR*
NR*
NR*
MJ
MN
MJ
MJ

N
N
N
N
Y
Y
Y
Y

Y
Y
Y
Y
Y
Y
Y
Y

156

GILLAM-FEi

5.9.5. <condtype> affecting INP input ports


<condtype>
CNFERR
LOS
CCLOS
OOF
AIS
BPV
INVSSM
VCXOSI
HWERR
PHCOMPERR
LOWQL
SIS
SOOS
REFSEL
OEENT
OEDLT
UEQ
FFOFF
OVERVOLTAGE
BADFREQ
PPBLDOUT
NPBLDOUT
T-FFOFF3S
T-FFOFF10S
T-FFOFF30S
T-FFOFF100S
T-FFOFF300S
T-FFOFF1000S
T-FFOFF3000S
T-FFOFF10000S
T-FFOFF30000S
T-FFOFF100000S
T-TIE1S
T-TLMRTIE1S
T-TLMRTIE1M
T-TLMRTIE15M
T-TLMRTIE30M
T-TLMRTIE1H
T-TLMRTIE2H
T-TLMRTIE8H
T-TLMRTIE24H
T-TDEV1S
T-TDEV3S
T-TDEV10S
T-TDEV30S

4396CHbf Rev. 1.12


02/24/2009

<conddescr>

<ntfcncde>

<srveff>

<logctl>

Configuration error
Loss of signal
Loss of a CC reference
Out Of Frame
Alarm Indication Signal
BPV errors dectected
Invalid SSM Code detected
Signal impairment
Hardware failure
Phase comparator not running
SSM Quality Level below active
clock
Set In Service
Set Out Of Service
Reference input selected
Object Entity creation
Object Entity deletion
Unequipped with necessary card
Frequency Offset detected
Overvoltage detected
Bad Frequency detected
Positive Phase Build OUT detected
Negative Phase Build OUT detected
FF0FF3S Threshold
FF0FF10S Threshold
FF0FF30S Threshold
FF0FF100S Threshold
FF0FF300S Threshold
FF0FF1000S Threshold
FF0FF3000S Threshold
FF0FF10000S Threshold
FF0FF30000S Threshold
FF0FF100000S Threshold
TIE1S Threshold
LMRTIE1S Threshold
LMRTIE1M Threshold
LMRTIE15M Threshold
LMRTIE30M Threshold
LMRTIE1H Threshold
LMRTIE2H Threshold
LMRTIE8H Threshold
LMRTIE24H Threshold
TDEV1S Threshold
TDEV3S Threshold
TDEV10S Threshold
TDEV30S Threshold

MJ
MN
MJ
MN
MN
MN
MN
MJ
MJ
MN

Y
N
N
N
N
N
N
N
Y
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

MN
NR*
NR*
NA*
NR*
NR*
MJ
MN
MN
MN
NA*
NA*
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN

N
N
N
N
N
N
Y
N
N
Y
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

UNISYNCe
TL1 REFERENCE GUIDE

157

GILLAM-FEi

T-TDEV100S
T-TDEV300S
T-TDEV1000S
T-TDEV3000S
T-DEV10000S
T-MRTIE1S
T-MRTIE1M
T-MRTIE15M
T-MRTIE30M
T-MRTIE1H
T-MRTIE2H
T-MRTIE8H
T-MRTIE24H
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

4396CHbf Rev. 1.12


02/24/2009

TDEV100S Threshold
TDEV300S Threshold
TDEV1000S Threshold
TDEV3000S Threshold
TDEV10000S Threshold
MRTIE1S Threshold
MRTIE1M Threshold
MRTIE15M Threshold
MRTIE30M Threshold
MRTIE1H Threshold
MRTIE2H Threshold
MRTIE8H Threshold
MRTIE24H Threshold
SSM changed from PRS to ST2
SSM changed from PRS to STU
SSM changed from PRS to TNC
SSM changed from PRS to ST3E
SSM changed from PRS to ST3
SSM changed from PRS to SMC
SSM changed from PRS to ST4
SSM changed from PRS to DUS
SSM changed from No SSM to PRS
SSM changed from ST2 to PRS
SSM changed from ST2 to STU
SSM changed from ST2 to TNC
SSM changed from ST2 to ST3E
SSM changed from ST2 to ST3
SSM changed from ST2 to SMC
SSM changed from ST2 to ST4
SSM changed from ST2 to DUS
SSM changed from No SSM to ST2
SSM changed from ST3E to PRS
SSM changed from ST3E to STU
SSM changed from ST3E to TNC
SSM changed from ST3E to ST2
SSM changed from ST3E to ST3
SSM changed from ST3E to SMC
SSM changed from ST3E to ST4
SSM changed from ST3E to DUS
SSM changed from No SSM to
ST3E
SSM changed from ST3 to PRS
SSM changed from ST3 to STU
SSM changed from ST3 to TNC
SSM changed from ST3 to ST2
SSM changed from ST3 to ST3E
SSM changed from ST3 to SMC
SSM changed from ST3 to ST4
SSM changed from ST3 to DUS
SSM changed from No SSM to ST3
SSM changed from STU to PRS
SSM changed from STU to ST2

UNISYNCe
TL1 REFERENCE GUIDE

MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
MN
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

158

GILLAM-FEi

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

4396CHbf Rev. 1.12


02/24/2009

SSM changed from STU to TNC


SSM changed from STU to ST3E
SSM changed from STU to ST3
SSM changed from STU to SMC
SSM changed from STU to ST4
SSM changed from STU to DUS
SSM changed from No SSM to STU
SSM changed from TNC to PRS
SSM changed from TNC to ST2
SSM changed from TNC to STU
SSM changed from TNC to ST3E
SSM changed from TNC to ST3
SSM changed from TNC to SMC
SSM changed from TNC to ST4
SSM changed from TNC to DUS
SSM changed from No SSM to TNC
SSM changed from SMC to PRS
SSM changed from SMC to ST2
SSM changed from SMC to STU
SSM changed from SMC to ST3E
SSM changed from SMC to ST3
SSM changed from SMC to TNC
SSM changed from SMC to ST4
SSM changed from SMC to DUS
SSM changed from No SSM to SMC
SSM changed from ST4 to PRS
SSM changed from ST4 to ST2
SSM changed from ST4 to STU
SSM changed from ST4 to ST3E
SSM changed from ST4 to ST3
SSM changed from ST4 to SMC
SSM changed from ST4 to TNC
SSM changed from ST4 to DUS
SSM changed from No SSM to ST4
SSM changed from DUS to PRS
SSM changed from DUS to ST2
SSM changed from DUS to STU
SSM changed from DUS to ST3E
SSM changed from DUS to ST3
SSM changed from DUS to SMC
SSM changed from DUS to ST4
SSM changed from DUS to TNC
SSM changed from No SSM to DUS
SSM changed from PRS to No SSM
SSM changed from STU to No SSM
SSM changed from ST2 to No SSM
SSM changed from TNC to No SSM
SSM changed from ST3E to No
SSM
SSM changed from ST3 to No SSM
SSM changed from SMC to No SSM
SSM changed from ST4 to No SSM

UNISYNCe
TL1 REFERENCE GUIDE

NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

NA*
NA*
NA*
NA*

N
N
N
N

Y
Y
Y
Y

159

GILLAM-FEi

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

4396CHbf Rev. 1.12


02/24/2009

SSM changed from G811 to No


SSM
SSM changed from G812T to No
SSM
SSM changed from G812L to No
SSM
SSM changed from G813 to No
SSM
SSM changed from DNU to No SSM
SSM changed from DUS to No SSM
SSM changed from INVALID to PRS
SSM changed from INVALID to STU
SSM changed from INVALID to TNC
SSM changed from INVALID to ST2
SSM changed from INVALID to
ST3E
SSM changed from INVALID to ST3
SSM changed from INVALID to
SMC
SSM changed from INVALID to ST4
SSM changed from INVALID to DUS
SSM changed from INVALID to No
SSM
SSM changed from INVALID to
G811
SSM changed from INVALID to
G812T
SSM changed from INVALID to
G812L
SSM changed from INVALID to
G813
SSM changed from INVALID to DNU
SSM changed from G811 to STU
SSM changed from G811 to G812T
SSM changed from G811 to G812L
SSM changed from G811 to G813
SSM changed from G811 to DNU
SSM changed from G812T to G811
SSM changed from G812T to STU
SSM changed from G812T to G812L
SSM changed from G812T to G813
SSM changed from G812T to DNU
SSM changed from G812L to G811
SSM changed from G812L to STU
SSM changed from G812L to G812T
SSM changed from G812L to G813
SSM changed from G812L to DNU
SSM changed from G813 to G811
SSM changed from G813 to G812T
SSM changed from G813 to G812L
SSM changed from G813 to STU
SSM changed from G813 to DNU
SSM changed from DNU to G811

UNISYNCe
TL1 REFERENCE GUIDE

NA*

NA*

NA*

NA*
NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y

NA*
NA*

N
N

Y
Y

NA*
NA*
NA*

N
N
N

Y
Y
Y

NA*

NA*

NA*

NA*

NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

160

GILLAM-FEi

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

SSM changed from DNU to STU


SSM changed from DNU to G812T
SSM changed from DNU to G812L
SSM changed from DNU to G813
SSM changed from PRS to INVALID
SSM changed from ST2 to INVALID
SSM changed from ST3E to
INVALID
SSM changed from ST3 to INVALID
SSM changed from STU to INVALID
SSM changed from TNC to INVALID
SSM changed from SMC to
INVALID
SSM changed from ST4 to INVALID
SSM changed from DUS to INVALID
SSM changed from No SSM to
INVALID
SSM changed from G811 to
INVALID
SSM changed from G812T to
INVALID
SSM changed from G812L to
INVALID
SSM changed from G813 to
INVALID
SSM changed from DNU to INVALID
SSM changed from RES to PRS
SSM changed from RES to STU
SSM changed from RES to TNC

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
INPVAL
LEDCHG
CFGERR

SSM changed from RES to ST2


SSM changed from RES to ST3E
SSM changed from RES to ST3
SSM changed from RES to SMC
SSM changed from RES to ST4
SSM changed from RES to DUS
SSM changed from RES to No SSM
SSM changed from RES to INVALID
SSM changed from ST1 to RES
SSM changed from ST2 to RES
SSM changed from ST3E to RES
SSM changed from ST3 to RES
SSM changed from STU to RES
SSM changed from TNC to RES
SSM changed from SMC to RES
SSM changed from ST4 to RES
SSM changed from DUS to RES
SSM changed from No SSM to RES
SSM changed from INVALID to RES
Input signal validation
Change of LED state
TYPE incompat. with input module

SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG
SSMCHG

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

NA*
NA*
NA*
NA*
NA*
NA*

N
N
N
N
N
N

Y
Y
Y
Y
Y
Y

NA*
NA*
NA*
NA*

N
N
N
N

Y
Y
Y
Y

NA*
NA*
NA*

N
N
N

Y
Y
Y

NA*

NA*

NA*

NA*

NA*
NA*
NA*
NA*
NA*

N
N
N
N
N

Y
Y
Y
Y
Y

NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA*
NA
NA*
MJ

N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
N
Y

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
N
Y

161

GILLAM-FEi

5.9.6. <condtype> affecting oscillator


<condtype>
HWERR
OSCINS
OSCEOR
OSCNEOR
CTLVLTG
WMUPST
ACQST
FRNGAL1
FRNGAL2
HLDOVRAL1
HLDOVRAL2
LOCKEDST
CMDST
CALIBST
SIS
SOOS
LEDCHG

4396CHbf Rev. 1.12


02/24/2009

<conddescr>
Hardware failure
Oscillator instability
Oscillator at end of range
Oscillator at near end of range
No frequency adjustment
Warm up oscillator state
Acquire oscillator state
Free running oscillator state
Free-Run for excessive time
Holdover oscillator state
Holdover for excessive time
Locked oscillator state
Command oscillator state
Calibration oscillator state
Set In Service
Set Out Of Service
Change of LED state

UNISYNCe
TL1 REFERENCE GUIDE

<ntfcncde>

<srveff>

<logctl>

MJ
MN
MN
MN
MN
MN
NA
MN
MJ
MN
MJ
NA
NA
NA
NR*
NR*
NA*

Y
Y
Y
N
Y
N
N
Y
Y
Y
Y
N
N
N
N
N
N

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
N

162

GILLAM-FEi

5.9.7. <condtype> affecting FBM input ports


<condtype>
SIS
SOOS
OEENT
OEDLT
MEA
UEQ
GT10M8
GT10M9
GT10M10
GT10M11
CFGERR
LOS

4396CHbf Rev. 1.12


02/24/2009

<conddescr>

<ntfcncde>

<srveff>

<logctl>

Set In Service
Set Out Of Service
Object Entity creation
Object Entity deletion
TYPE incompat. with output module
Unequipped with necessary card
Freq. error greater than 10exp-8
Freq. error greater than 10exp-9
Freq. error greater than 10exp-10
Freq. error greater than 10exp-11
Configuration error
Loss of signal

NR*
NR*
NR*
NR*
MJ
MJ
MJ
MJ
MN
MN
MN
MN

N
N
N
N
Y
Y
Y
Y
Y
Y
Y
Y

Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y

UNISYNCe
TL1 REFERENCE GUIDE

163

GILLAM-FEi

5.10. <ctag> - Correlation Tag


<ctag> is the Correlation Tag (CTAG) used to correlate input and response messages.

The value of <ctag> is an identifier or a decimal numeral, and is limited to a


maximum of 6 ASCII characters.
It is assigned by the OS and must be included in UNISYNC input and response
messages where specified.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

164

GILLAM-FEi

5.11. <errcde> - Error Codes


<errcde>
IBEX
IBMS
ICNV
ICNV
ICNV
ICNV
ICNV
IDNV
IDNV
IDRG
IEAE
IENE
IIAC
IIAC
IIAC
IIAC
IIAC
IICM
IICM
IICM
IICT
IIFM
IIPG
IISP
IITA
IITA
INUP
IPEX
IPMS
IPMS
IPNC
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV

4396CHbf Rev. 1.12


02/24/2009

Valid Values for Error Codes


Description
Input, Block Extra
Input, Block MiSsing
Entity can not be deleted
Object entity can not be set Out Of Service
Entity can not be created
Entity can not be modified
Input, Command Not Valid
Data not valid
Input, Data Not Valid
Input, Data RanGe
Entity to be created already exists
Object entity does not exist
Invalid Access identifier
Only one AID allowed
Invalid AID (not a REF input)
Invalid AID (a REF input)
Input, Invalid Access identifier
Command not yet supported
Command not supported
Command not valid
Input, Invalid Correlation Tag
Input, Invalid data ForMat
Input, Invalid Parameter Grouping
Input, Invalid Syntax or Punctuation
Input, Invalid Target identifier
Invalid Target Identifier
Input, Non-null Unimplemented Parameter
Input, Parameter Extra
Parameter missing
Input, Parameter MiSsing
Too many parameters
Parameter not valid
INPSEL only valid in FRCD or MAN mode
Parameters not allowed
Cannot control OSC command
Cannot control OSC calibration
Cannot program OSC state
Invalid STATE parameter
FREQCMD when not in CMD state

UNISYNCe
TL1 REFERENCE GUIDE

165

GILLAM-FEi

IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
IPNV
ISNE

4396CHbf Rev. 1.12


02/24/2009

Cannot modify TYPE parameter


Invalid REF parameter
Cannot modify REF parameter
Only one parameter allowed
Parameter value too long
Invalid date
Invalid <montype> parameter
Invalid CONDTYPE
CONDTYPE not modifiable for this OE
CAUTION: Possible Service Affecting Condition
Invalid REF input selected
Not in AUTO SSM Mode
RSTSSM can only be applied on a REF input
Possible Service Affecting Condition. Please confirm
Confirmation Time Expired, Re-start
Reference Input In Alarm
Revertive mode in use
Reference Input Out Of Service
Can not switch to a lower priority input
Can not switch to a lower quality input
Reference Input Not Validated
Command Disallowed Time Interval Requirement 4 sec
Site survey already in progress
GPS Out Of Service (OOS-MA)
No site survey active
Bad LATITUDE parameter format
Bad LONGITUDE parameter format
Bad HEIGHT parameter format
Input not provisioned
TYPE incompatible with hardware
No output module
TYPE not supported
Output module not supported
Object entity not yet supported
Cannot be set Out Of Service
Cannot modify ALMDE parameter
ALMDE incompatible with output type
ALMDE incompatible with configured outputs
Specify INPFRCD with FRCD SYNMDE
Still in AUTO synchronization mode
Still in FRCD synchronization mode
Bad TZ parameter format
GPS Not ready
Supporting Entity does not exist

UNISYNCe
TL1 REFERENCE GUIDE

166

GILLAM-FEi

PICC
PIUC
PIUI
PLNA
SADL
SAIN
SAIS
SAMS
SAOS
SDAT
SDAT
SDNR
SHCM
SNVS
SRCI
SROF
SROF
SSIS
SSRD
SWFA
SAIS
SAAL
SCSN
SDBE

4396CHbf Rev. 1.12


02/24/2009

Privilege, Invalid Command Code


Privilege, Illegal User Code
Privilege, Illegal User Identity
Privilege, Login Not Active
Object entity already deleted
Status, Already Inhibited
Object entity already In Service
Status, Already in Maintenance State
Object entity already Out Of Service
Date programming problem
GPS In Service
Status, Data Not Ready
Hardware Compatibility Mismatch, cannot be downloaded
Status, Not in Valid State
Requested command inhibited
OSC calibration refused
Requested Operation Failed
Object entity still In Service, cannot be deleted
Status, Switch Request Denied
Status, Working unit Failed
Status, Already In Service
Status, Already ALlowed
Status, Invalid command sequence
Internal Error

UNISYNCe
TL1 REFERENCE GUIDE

167

GILLAM-FEi

5.12. <inhn> - Inhibition


<inhn> indicates if an alarm inhibition condition is in effect or not.
Value
INH
NINH

4396CHbf Rev. 1.12


02/24/2009

Value usage
Inhibition of alarm requested
No inhibition of alarm requested

UNISYNCe
TL1 REFERENCE GUIDE

168

GILLAM-FEi

5.13. <logctl> - Logging Control


<logctl> specifies if the event occurrence must be saved in the LOG or not.
Value
LOG
NLOG

4396CHbf Rev. 1.12


02/24/2009

Value usage
Logging of the event requested
No logging of the event requested

UNISYNCe
TL1 REFERENCE GUIDE

169

GILLAM-FEi

5.14. <lognm> - Log Name


<lognm> allows the user to manually specify the name of a log which can be used for
specific message categories.
Valid values for <lognm> :

EVT
EVTAO :
SECU :
DBCHG :

4396CHbf Rev. 1.12


02/24/2009

:
:
:
:

events log
Autonomous Output messages log
security log
DBCHG messages log.

UNISYNCe
TL1 REFERENCE GUIDE

170

GILLAM-FEi

5.15. <mondat> - Monitor Date


Is the beginning date of the PM period specified in <tmper>. The format for <mondat>
is MOY-DOM, where MOY (month of year) ranges from 1 to 12 and DOM (day of
month) ranges from 1 to 31.
A null value for <mondat> defaults to the current date.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

171

GILLAM-FEi

5.16. <montm> - Monitor Time


<montm> is the beginning time of day of the PM period specified in <tmper>. The
format for <montm> is HOD-MOH, where HOD (hour of day) ranges from 0 to 23
and MOH (minute of hour) ranges from 0 to 59.
A null value for <montm> defaults to the current HOD-MOH.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

172

GILLAM-FEi

5.17. <montype> - Monitored Parameter Types

DFF

<montype>

<monval>
A/N

FFOFF3S

Decimal-1

FFOFF10S

Decimal-1

FFOFF30S

Decimal-1

FFOFF100S

Decimal-1

FFOFF300S

Decimal-1

FFOFF1000S

Decimal-1

FFOFF3000S

Decimal-1

4396CHbf Rev. 1.12


02/24/2009

Description
Feedback
Monitoring
<monval>
contained in a text string of no more
than 50 characters enclosed within a
pair of escaped quotes (\").
This
<monval> is automatically reported
every 4 seconds in REPT^PM messages
after a SCHED-PMREPT command has
been started on a Feedback Monitoring
input.
Reports the following items:
- frequency offset of the feedback
monitoring input (in scientific
notation format)
- phase measurement time expressed
in days and seconds
- phase offset expressed in nsec.
Format used:
"5.3e-011,1000 sec,40 nsec",
"5.3e-012,1 day 100 sec,40 nsec",
"5.3e-012,3 days 37100 sec,-85 nsec".
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 3 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 10 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 30 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 100 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 300 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 1000 seconds
Fractional Frequency Offset expressed

UNISYNCe
TL1 REFERENCE GUIDE

173

GILLAM-FEi

FFOFF10000S

Decimal-1

FFOFF30000S

Decimal-1

FFOFF100000S

Decimal-1

FREQCORR

Decimal-1

LMRTIE1S

Decimal-1

LMRTIE1M

Decimal-1

LMRTIE15M

Decimal-1

LMRTIE30M

Decimal-1

LMRTIE1H

Decimal-1

LMRTIE2H

Decimal-1

LMRTIE8H

Decimal-1

LMRTIE24H

Decimal-1

MRTIE1S

Decimal-1

MRTIE1M

Decimal-1

MRTIE15M

Decimal-1

4396CHbf Rev. 1.12


02/24/2009

in 10exp-12 for a measurement period


of 3000 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 10000 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 30000 seconds
Fractional Frequency Offset expressed
in 10exp-12 for a measurement period
of 100000 seconds
Oscillator Command expressed in f/f
(10exp-12)
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 1 second
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 1 minute
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 15 minutes
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 30 minutes
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 1 hour
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 2 hours
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 8 hours
Latest Maximum Relative Time
Interval Error expressed in nsec for an
observation time of 24 hours
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 1 second
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 1 minute
Maximum Relative Time Interval Error
expressed in nsec for an observation

UNISYNCe
TL1 REFERENCE GUIDE

174

GILLAM-FEi

MRTIE30M

Decimal-1

MRTIE1H

Decimal-1

MRTIE2H

Decimal-1

MRTIE8H

Decimal-1

MRTIE24H

Decimal-1

TDEV1S

Decimal-1

TDEV3S

Decimal-1

TDEV10S

Decimal-1

TDEV30S

Decimal-1

TDEV100S

Decimal-1

TDEV300S

Decimal-1

TDEV1000S

Decimal-1

TDEV3000S

Decimal-1

TDEV10000S

Decimal-1

TIE1S

Decimal-1

time of 15 minutes
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 30 minutes
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 1 hour
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 2 hours
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 8 hours
Maximum Relative Time Interval Error
expressed in nsec for an observation
time of 24 hours
Time Deviation expressed in nsec at an
integration time of 1 second
Time Deviation expressed in nsec at an
integration time of 3 seconds
Time Deviation expressed in nsec at an
integration time of 10 seconds
Time Deviation expressed in nsec at an
integration time of 30 seconds
Time Deviation expressed in nsec at an
integration time of 100 seconds
Time Deviation expressed in nsec at an
integration time of 300 seconds
Time Deviation expressed in nsec at an
integration time of 1000 seconds
Time Deviation expressed in nsec at an
integration time of 3000 seconds
Time Deviation expressed in nsec at an
integration time of 10000 seconds
Time Interval Error expressed in nsec
for a measurement period of 1 second

Decimal-1 is a decimal numeral restricted to integer values and not greater than 10
digits.
The constructs that allow for <montype>x to identify the maximum and minimum
values are x-C and x-F respectively.
Not all constructs necessarily apply to every <montype>.
<monval> is the measured value of the monitored parameter. If <monval> is out of
range, the parameter value should be one of the following:
OOR
Out-Of-Range

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

175

GILLAM-FEi

OORH
OORL

4396CHbf Rev. 1.12


02/24/2009

Out-Of-Range High
Out-Of-Range Low.

UNISYNCe
TL1 REFERENCE GUIDE

176

GILLAM-FEi

5.18. <ntfcncde> - Notification Code


<ntfcncde> is the notification code associated with alarm conditions.
Valid values for <ntfcncde> are as follows:
<ntfcncde>
CR
MJ
MN
NA
NR
CL

VALUE DESCRIPTION
Critical Alarm
Major Alarm
Minor Alarm
Not Alarmed
Not Reported (when the event occurs,
information is retained in the NE)
Cleared Alarm

Values CR, MJ and MN are reported via the REPT^ALM message.


NA is reported via the REPT^EVT message.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

177

GILLAM-FEi

5.19. <ocrdat> - Occurrence Date


<ocrdat> is the date when the specific event or violation occurred.
The format for <ocrdat> is MOY-DOM.
MOY stands for month of year and has a range of 1 to 12.
DOM stands for day of month and has a range of 1 to 31.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

178

GILLAM-FEi

5.20. <ocrtm> - Occurrence Time of Day


<ocrtm> is the time of day when the specific event or violation occurred.
The format for <ocrtm> is HOD-MOH-SOM.
HOD stands for hour of day and has a range of 0 to 23.
MOH stands for minute of hour and has a range of 0 to 59.
SOM stands for second of minute and has a range of 0 to 59.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

179

GILLAM-FEi

5.21. <srveff> - Service Effecting


<srveff> is the effect on service caused by the standing or alarm condition.
Parameter grouping shall not be used with this parameter.
Value
SA
NSA

4396CHbf Rev. 1.12


02/24/2009

Value usage
Service-effecting condition, immediate action required
Nonservice-effecting condition, action required

UNISYNCe
TL1 REFERENCE GUIDE

180

GILLAM-FEi

5.22. <state> - Entity State


<state> indicates the state information of an entity. It is represented by the following
parameters :
Primary State (PST) :
This parameter indicates the current overall service condition of an entity.
IS (In-Service)
The entity is available for providing its provisional functions. That is,
the entity is operationally capable and at the same time administratively
allowed to provide its provisioned functions.
OOS (Out-Of-Service)
The entity is not available for providing any of its provisioned
functions.
Primary State Qualifier (PSTQ)
This parameter qualifies PST.
The following values of PSTQ qualify the PST value IS :
NR (Normal)
The entity is capable and allowed to provide all of its provisioned
functions.
ANR (Abnormal)
The entity is allowed to perform all of its provisioned functions, but it is
capable of performing only part of (but not none) these functions.
The following values of PSTQ qualify the PST value OOS :
AU (Autonomous)
The entity is incapable of performing any of its provisioned functions,
and there is no external administrative restriction inhibiting the entity
from performing these functions.
MA (Management)
The entity is intentionally suspended by the external management
command from performing all of its provisioned functions.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

181

GILLAM-FEi

5.23. <tid> - Target Identifier


<tid> is the Target Identifier (TID) that identifies the target UNISYNC to which a
command is directed.
The value of <tid> is comprised of a maximum of 20 ASCII characters limited to
letters, digits, and hyphens.
The value of <tid> may be null when the OS directly interfaces with the target
UNISYNC.

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

182

GILLAM-FEi

5.24. TOD Time Of Day on serial interface


5.24.1. TOD Physical interface

Connector type: RJ-45


Connector label: TOD
Electrical interface: RS485
Serial port: 9600 bits/sec, 8 bits of data, no parity, 1 stop bit
Pin out of the TOD connector:
Pin
1
2
3
4
5
6
7
8

Signal
TODPPS (+)
TODPPS (-)
TOD12V
TODRXD (-)
TODRXD (+)
TODGND
TODTXD (+)
TODTXD (-)

Notes
One Pulse Per Second (+) output
One Pulse Per Second (-) output
12 V Runs through a 100mA fuse
TOD Receive (-)
TOD Receive (+)
TOD Ground
TOD Transmit (+) See below for time format
TOD Transmit (-) See below for time format

5.24.2. TOD Frame format


The date/time UNISYNCe TOD is always given in UTC time (never expressed
in local time with DST correction).
In order for the TOD frame to be sent by the UNISYNCe, the GPS receiver
must be active and a correct time stamp must have been received from the
GPS.
Format of the TOD message:
<cr><lf>i<sp>yy<sp>ddd<sp>hh:mm:ss.fff<sp>ld<lf>
where
<cr>: carriage return ASCII (0Dh)
<lf>: line feed ASCII (0Ah)
<sp>: space ASCII (20h)
on-time = <cr>
i = synchronization flag (<sp> = in synch, '?' = out synch)
yy = year (08, 09, 10, )
ddd = day of year (001, 002, )
hh:mm:ss.fff = hours, minutes, seconds, milliseconds

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

183

GILLAM-FEi

l = leap second indicator (<sp> = normal, 'L' = leap sec)


d = day light saving indicator (always 'S' to indicate standard UTC time).
The alarm condition is indicated by '?' at i, which occurs during initial
synchronization.
The l is normally <sp>. It will be 'L' to indicate leap second adjustment, due at
the end of the current month. Leap seconds are occasionally inserted in UTC.
That generally occurs on midnight UTC June 30 or midnight UTC December
31.
The start bit of the 'on-time' (<cr>) is synchronized to the indicated time. The
'on-time' mark character latency is lower than 100 sec.
Example:
<cr><lf><sp><sp>08<sp>218 <sp>12:48:44.000<sp><sp>S<lf>

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

184

GILLAM-FEi

6.

REFERENCES

GR-474-CORE: Network Maintenance: Alarm and Control for Network Elements,


Issue 1, December 1997

GR-472-CORE: Network Element Configuration Management, Issue 2, November 1996


with revision 2, February 1999

GR-199-CORE : Memory Administration Messages, Issue 3, February 1999

GR-833-CORE: NE and Transport Surveillance Messages, Issue 4, June 2000

GR-1093-CORE: Generic State Requirements for Network Elements (NEs), Issue 2,


June 2000

GR-831-CORE: Language for Operations Application Messages, Issue 1, November


1996

GR-815-CORE: Generic Requirements for Network Element/Network System (NE/NS)


Security, Issue 1, November 1997

TR-NWT-835: Network Element and Network System Security Administration


Messages, Issue 3, January 1993

GR-378-CORE: Generic Requirements for Timing Signal Generators, Issue 2, February


1999

GR-1244-CORE : Clocks for the Synchronized Network : Common Generic Criteria,


Issue 2, December 2000

GR-2830-CORE: Primary Reference Sources: Generic Criteria, Issue 2, December 1995

4396CHbf Rev. 1.12


02/24/2009

UNISYNCe
TL1 REFERENCE GUIDE

185

Anda mungkin juga menyukai