Symmetricom SSU-2000e, SDU-2000e Technical Reference

Download

SSU-2000e Synchronization Supply Unit

and the

SDU-2000e Synchronization Distribution Unit

Technical Reference

Revision E.01 – January 2007

Part Number 12713140-003-2

Symmetricom, Inc.

2300 Orchard Parkway

San Jose, CA 95131-1017

U.S.A.

http://www.symmetricom.com

All product names, service marks, trademarks, and registered trademarks

used in this document are the property of their respective owners.

Table of Contents

Contents

How to Use This Guide

Purpose of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Who Should Read This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Structure of This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Conventions Used in This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Warnings, Cautions, Recommendations, and Notes . . . . . . . . . . . . . . . . . . . . . . . 15

Related Documents and Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Where to Find Answers to Product and Document Questions . . . . . . . . . . . . . . . . 17

What’s New in This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 1 Overview

SSU-2000e Control Languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 2 TL1 Reference

TL1 Command Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

TL1 Command and Response Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . 25

System Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

TL1 Retrieve Commands and Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Retrieve 2048 kHz Clock Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Retrieve Alarm Cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Retrieve Alarm Elevation Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Retrieve Module Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Retrieve Alarm Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Retrieve Alarm Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Retrieve All Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Retrieve CC Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Retrieve CC Output Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Retrieve Clock Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Retrieve Clock Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Retrieve Communication Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Retrieve Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Retrieve Configuration Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Retrieve DS1/E1 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Retrieve DS1/E1 Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Retrieve E1/2048 kHz Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Retrieve Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Retrieve Frequency Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Retrieve Frequency Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Retrieve GPS Available Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Retrieve GPS Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Retrieve GPS Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Retrieve GPS Position. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Retrieve Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 3

Table of Contents

Retrieve Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Retrieve Input Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Retrieve Input Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Retrieve Inventory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Retrieve IP Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Retrieve Keep-alive Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Retrieve LED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Retrieve Local Time Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Retrieve Login Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Retrieve MTIE Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Retrieve MTIE History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Retrieve MTIE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Retrieve Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Retrieve Network Element Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Retrieve NTP Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Retrieve NTP Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Retrieve Operating Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Retrieve Output PQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Retrieve Output Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Retrieve Password Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Retrieve Phase Build-Out Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Retrieve Phase Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Retrieve Ping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Retrieve Reference Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Retrieve Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Retrieve RS-422 Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Retrieve Security Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Retrieve Security Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Retrieve Setup Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Retrieve Signal Fault Alarm Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Retrieve SNMP Engine ID Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Retrieve SNMP Mode Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Retrieve SNMPv2 Manager List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Retrieve SNMPv2 User List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Retrieve SNMPv3 Manager List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Retrieve SNMPv3 Notification Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Retrieve SNMPv3 User List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Retrieve TDEV Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Retrieve TDEV History Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Retrieve TL1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Retrieve User List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

TL1 Set Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Set 2048 kHz Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Set Active Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Set Alarm Cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Set Alarm Elevation Time Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Set Alarm Level Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Set CC Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Set CC Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

4 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Table of Contents

Set Clock Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Set Clock AutoReturn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Set Clock Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Set Communication Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Set Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Set DS1/E1 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Set DS1/E1 Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Set E1/2048 kHz Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Set Frequency Alarm Threshold Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 131

Set GPS Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Set GPS Position. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Set Input Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Set IP Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Set Keep-alive Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Set Login Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Set MTIE Mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Set MTIE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Set Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Set NTP Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Set Operating Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Set Output PQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Set Phase Zero . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Set RS-422 Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Set Password Confirm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Set Phase Build-Out Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Set Security Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Set Setup Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Set Signal Fault Alarm Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Set SNMP Mode Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Set SNMPv2 Manager Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Set SNMPv2 User Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Set SNMPv3 Manager Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Set SNMPv3 Notification Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Set SNMPv3 User Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Set TL1 Format Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Set User Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Other TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Backing Up and Restoring the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 160

Chapter 3 ICS Command Reference

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

General Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

ICS Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Line Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Logon Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

ICS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 5

Table of Contents

ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

BYE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

CLK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

CLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

COMM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

DATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

DOY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

ELEVTIME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

ENGINE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

EVENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

FREQUENCY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

INPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

IONAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

KEEPALIVE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

MTIE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

NTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

OPERMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

OUTPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

PBO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

PHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

PING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

PQLTABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

REF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

RESET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

RESTART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

SECURITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

SETUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

SYSTIME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

TDEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

TL1FORMAT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

USERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

VER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

WHO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

6 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Table of Contents

Chapter 4 NTP and SNMP

NTP Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Server Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Client Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Broadcast Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

SNMP Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

SNPMP v2 Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

SNMP v3 Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Management Information Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Enabling SNMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Adding a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Adding a Manager IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

User and Manager Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Keep-Alive Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Shelf Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Software Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Communications Module Software Version . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Chapter 5 Antennas

Antenna Kits and Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Selecting the Proper Gain Antenna. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Transient Eliminators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

GPS L1 Inline Amplifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

GPS L1 Inline Amplifier Assembly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Antenna Coaxial Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Installing Antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Antenna Connection Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Planning the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Antenna Installation Tools and Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Cutting Antenna Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Installing the Antenna . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Connecting the Cable to the Antenna. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Installing the Transient Eliminator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Installing the Antenna Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Connecting the GPS Antenna. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Antenna Installation Completeness Checklist. . . . . . . . . . . . . . . . . . . . . . . . . 258

Optional Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Ordering Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Chapter 6 Alarms and Events

Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

TL1 Autonomous Message Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

SNMP Trap Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Clock Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 7

Table of Contents

Communication Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Basic and Basic + NTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Basic + SNMPv2 and Basic + NTP + SNMPv2. . . . . . . . . . . . . . . . . . . . . . . . 271

Basic + SNMPv3 and Basic + NTP + SNMPv3. . . . . . . . . . . . . . . . . . . . . . . . 274

CC Input Module Alarms and Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

DS1/E1 Input Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

GPS Input Module Alarms and Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

2048 kHz Output Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

CC Output Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

DS1 Output Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

E1/2048 kHz Output Module Alarms and Events. . . . . . . . . . . . . . . . . . . . . . . . . . . 292

RS-422 Output Module Alarms and Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Buffer Module Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Chapter 7 Connector Pinouts

Signal Names and Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Power and Ground . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Communication Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Local OSC and Antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Alarm Contact Closures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

SDU-2000 Expansion Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Shelf Module Slot Addressing and Size Assignments . . . . . . . . . . . . . . . . . . . . . . . 304

I/O Connector Grounding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Chapter 8 Default Settings

Communications Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Clock Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

DS1 and E1 Input Module Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

MTIE Limits for the DS1 Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

MTIE Limits for the E1 Input Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

GPS Input Module Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

DS1 and E1 Line Re-timing Module Default Settings . . . . . . . . . . . . . . . . . . . . . . . 313

DS1 and E1 Output Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

2048 kHz Output Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

E1/2048 kHz Output Module Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Composite Clock Output Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . 317

RS-422 Output Module Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Priority Quality Level (PQL) Table Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . 318

User Changes to Factory Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

8 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Table of Contents

Chapter 9 Specifications

SSU-2000e Shelf Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

General Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Operating Conditions Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

Power Input and Grounding Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Input Signal Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Output Signal Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

SDU-2000 Shelf Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Chapter 10 Reference Materials

American National Standards Institute (ANSI) Documents . . . . . . . . . . . . . . . . . . 334

Generic Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Technical Advisories and Framework Technical Advisories . . . . . . . . . . . . . . . . . . 335

Technical References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

EIA/TIA Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

Other Reference Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .341

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 9

Table of Contents

10 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Table of Contents

Tables

1-1 Module and Software Revision Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1-2 Communications Module Software Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2-1 Denied Response Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2-2 User Access Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

3-1 Shelf Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

4-1 Communications Module Software Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5-1 GPS Antennas with Internal LNA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

5-2 Specifications for GPS Antennas with Internal LNA . . . . . . . . . . . . . . . . . . . . . . 245

5-3 26 dB L1 GPS Antenna Accessory Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

5-4 40 dB L1 GPS Antenna Accessory Kit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

5-5 48 dB and 68 dB L1 GPS Antenna Accessory Kit . . . . . . . . . . . . . . . . . . . . . . .247

5-6 FCC-250B-90-1.5NFNF Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247

5-7 GPS L1 Inline Amplifier Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

5-8 Optional Antenna Coaxial Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5-9 Optional Antenna Coaxial Cable Crimper Kits. . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5-10 Antenna Cable Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5-11 Antenna Signal Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251

5-12 Optional Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

6-1 SNMP Event Message Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

6-2 Clock Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

6-3 Clock Module Alarm Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267

6-4 Basic and Basic +NTP Communications Module Alarm and Event Messages . . 268

6-5 Communications Module Alarm Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

6-6 Basic +SNMPv2 and Basic +NTP + SNMPv2 Communications Module Alarm and

Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

6-7 Basic +SNMPv3 and Basic +NTP + SNMPv3 Communications Module Alarm and

Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

6-8 Composite Clock Input Module Alarm and Event Messages . . . . . . . . . . . . . . . .278

6-9 Composite Clock Input Module Alarm Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . 279

6-10 DS1/E1 Input Module Alarm and Event Messages . . . . . . . . . . . . . . . . . . . . . . . 280

6-11 DS1/E1 Input Module Alarm Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

6-12 GPS Input Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . .283

6-13 GPS Input Module Alarm Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

6-14 2048 kHz Output Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . 286

6-15 2048 kHz Output Module Alarm Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .287

6-16 CC Output Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . 288

6-17 CC Output Module Alarm Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289

6-18 DS1 Output Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . 290

6-19 DS1 Output Module Alarm Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

6-20 E1/2048 kHz Output Module Alarm and Event Messages. . . . . . . . . . . . . . . . . . 292

6-21 E1/2048 kHz Output Module Alarm Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 11

Table of Contents

6-22 RS-422 Output Module Alarm and Event Messages . . . . . . . . . . . . . . . . . . . . . . 294

6-23 RS-422 Output Module Alarm Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295

6-24 Buffer Module Alarm and Event Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

7-1 Pinouts of Communications Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299

7-2 Signal Names and Locations of Local OSC and Antennas . . . . . . . . . . . . . . . . . 300

7-3 Signal Names and Locations of Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301

7-4 Signal Names and Locations for SDU-2000 Interface . . . . . . . . . . . . . . . . . . . .303

7-5 Shelf Module Slot Addressing and Size Assignments . . . . . . . . . . . . . . . . . . . . . 304

7-6 I/O Connector Grounding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

8-1 Communications Module Factory Default Settings. . . . . . . . . . . . . . . . . . . . . . . .308

8-2 Stratum 2E and 3E Clock Module Default Settings . . . . . . . . . . . . . . . . . . . . . . .308

8-3 DS1 and E1 Input Module Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 309

8-4 DS1 Input Module – MTIE Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

8-5 E1 Input Module – MTIE Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

8-6 GPS Input Module Default Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . 312

8-7 DS1 Line Re-timing Module Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .313

8-8 DS1 and E1 Output Module Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . .314

8-9 2048 kHz Output Module Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

8-10 E1/2048 kHz Output Module Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

8-11 Composite Clock Output Module Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . 317

8-12 RS-422 Output Module Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

8-13 Default PQL Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

8-14 User Changes to Factory Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319

9-1 General Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

9-2 Normal Operating Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327

9-3 Exceptional Operating Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

9-4 Power Input Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

9-5 Input Signal Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

9-6 Output Signal Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329

9-7 SDU-2000 System Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

12 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

How to Use This Guide

This section describes the format, layout, and purpose of this guide.

In This Preface

 Purpose of This Guide

 Who Should Read This Guide

 Structure of This Guide

 Conventions Used in This Guide

 Warnings, Cautions, Recommendations, and Notes

 Related Documents and Information

 Where to Find Answers to Product and Document Questions

 What’s New in This Document

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 13

How to Use This Guide

Purpose of This Guide

The SSU-2000 Technical Reference describes the programming languages that you

can use with the Symmetricom SSU-2000 Synchronization Supply Unit, and

contains the alarms and events you can use to troubleshoot the SSU-2000.

Who Should Read This Guide

This Technical Reference guide contains detailed information and instructions which

are intended to be performed by qualified personnel only.

Structure of This Guide

This guide contains the following chapters and appendixes:

Chapter, Title Description

Chapter 1, Overview Provides an overview of the SSU-2000 Technical Reference. Chapter 2, TL1 Reference Describes the TL1 command set available for use in the

SSU-2000.

Chapter 3, ICS Command Reference

Chapter 4, NTP and SNMP Provides an overview of the NTP and SNMP functions

Chapter 6, Alarms and Events Lists the alarms and events that appear on the console and

Chapter 7, Connector Pinouts Lists the pinout of the connectors in the rear panel of the

Chapter 8, Default Settings Includes a list of the factory default values for hardware and

Chapter 9, Specifications Lists the specifications for the SSU-2000. Chapter 10, Reference Materials Contains a listing of standards related to synchronizing

Index

Describes the ICS command set available for use in the SSU-2000.

available in the SSU-2000.

provides basic indications of the source of the alarm.

SSU-2000.

software parameters.

telecommunications networks. Provides references to individual topics within this guide.

14 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

How to Use This Guide

Conventions Used in This Guide

This guide uses the following conventions:

 Acronyms and Abbreviations – Terms are spelled out the first time they appear

in text. Thereafter, only the acronym or abbreviation is used.

 Revision Control – The title page lists the printing date and versions of the

product this guide describes.

 Typographical Conventions – This guide uses the typographical conventions

described in the table below.

When text appears

this way...

SSU-2000 User’s Guide The title of a document. SSU

CRITICAL Select File, Open... Click the Open option on the File menu.

Enter

Press Press ;

SSU Username:

PING STATUS

A re-timing application A word or term being emphasized. Symmetricom does not

recommend...

An operating mode, alarm state, status, or chassis label.

A named keyboard key. The key name is shown as it appears on the keyboard. An explanation of the key’s acronym or function immediately follows the first reference to the key, if required.

Text in a source file or a system prompt or other text that appears on a screen.

A command you enter at a system prompt or text you enter in response to a program prompt. You must enter commands for case-sensitiv e operating systems exactly as shown.

A word or term given special emphasis.

... it means:

Warnings, Cautions, Recommendations, and Notes

Warnings, Cautions, Recommendations, and Notes attract attention to essential or

critical information in this guide. The types of information included in each are

explained in the following examples.

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 15

How to Use This Guide

Warning: To avoid serious personal injury or death, do not disregard warnings. All warnings use this symbol. Warnings are installation, operation, or maintenance procedures, practices, or statements, that if not strictly observed, may result in serious personal injury or even death.

Caution: To avoid personal injury, do not disregard cautions. All cautions use this symbol. Cautions are installation, operation, or maintenance procedures, practices, conditions, or statements, that if not strictly observed, may result in damage to, or destruction of, the equipment. Cautions are also used to indi cat e a lon g- te rm health hazard.

ESD Caution: To avoid personal injury and electrostatic discharge (ESD) damage to equipment, do not disregard ESD cautions. All ESD cautions use this symbol. ESD cautions are installation, operation, or maintenance procedures, practices, conditions, or statements that if not strictly observed, may result in possible personal injury , electrostatic discharge damage to, or destruction of, static sensitive components of the equipment.

Electrical Shock Caution: To avoid electrical shock and possible personal injury, do not disregard electrical shock cautions. All electrical shock cautions use this symbol. Electrical shock cautions are practices, procedures, or statements, that if not strictly observed, may result in possible personal injury, electr ical shock damage to, or destruction of components of the equipment.

Recommendation: All recommendations use this symbol. Recommendations indicate manufacturer-tested methods or known functionality. Recommendations contain installation, operation, or maintenance procedures, practices, conditions, or statements, that provide important information for optimum performance results.

Note: All notes use this symbol. Notes contain installation, operation, or maintenance procedures, practices, conditions, or statements, that alert you to importa nt information, which may make your task easier or increase your understanding.

16 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

How to Use This Guide

Chapter 1 Overview

This chapter provides an overview of this guide.

In This Chapter

 SSU-2000e Control Languages

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 19

Chapter 1 Overview SSU-2000e Control Languages

SSU-2000e Control Languages

Software embedded in the SSU-2000e hardware allows operators to query and

manage an SSU-2000e from a local or remote management terminal using one of

three control interfaces. These management agents allow operators to change

factory default settings, set or restore stored configuration settings, configure and

provision the SSU-2000e to meet the requirements of a unique environment, and

perform maintenance and troubleshooting.

The SSU-2000e supports three control interfaces. Each grant s access to command

functions according to the security levels assigned to users. The control interfaces

are:

 TL1 – The Transaction Language One (TL1) control language, perhaps the

dominant telecommunications industry ASCII command line interface, provides a standard man-machine language. The TL1 language is defined in Bellcore document TR-NWT-000831, Issue 3, Revision 1, December 1993.

 ICS – The Interactive Command Set (ICS) control language also called the ASCII

command set, can be used to control the SSU-2000e from a terminal connected to one of the SSU-2000e EIA-232 serial ports.

 SNMP – The Simple Network Management Protocol (SNMP) protocol is based

on a client server query-response mode and is supported by Ethernet only.

There are six main executables (software versions) availab le for the SSU-2 000e as

shown in Table 1-2. This section provides information about the TL1 and ICS control

languages for all versions of software.

 Chapter 2, TL1 Reference, contains the TL1 commands and responses

 Chapter 3, ICS Command Reference, contains the ICS commands and

responses

 Chapter 4, NTP and SNMP, describes NTP support functionality and identifies

SNMP command functions, as well as features supported in this software version.

Recommendation: To ensure optimal system performance using the Communications module main executable software shown in Table 1-2, Symmetricom recommends that the module hardware and software used be at the minimum revision levels as shown in Table 1-1.

20 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Table 1-1. Module and Software Revision Levels

SSU-2000e Control Languages

Chapter 1 Overview

Module Part Number Module Name

Software Revision

Level

23413013-001-0 DS1 1-Port Input Module B B 23413013-002-0 DS1 3-Port Input Module B B 23413014-001-0 E1 1-Port Input Module B B 23413014-002-0 E1 3-Port Input Module B B 23413019-000-0 GPS Input Module A A 23413279-000-0 CC Input Module A A 23413016-000-0 Clock Module (STR 2E) B A 23413015-000-0 Clock Module (STR 3E) B A 23413015-001-0 Clock Module (Type 1) A A 23413017-000-0 DS1 Output Module A C 23413018-000-0 E1 Output Module A C 23413159-000-0 2048 kHz Output Module A A 23413158-000-0 CC Output Module A A

Hardware

Revision level

23413287-000-0 RS-422 Output Module A A 23413292-000-0 E1/2048 kHz Output Module A A 23413012-000-0 Communications Module A E 23413012-001-0 Communications Module A E

Table 1-2. Communications Module Software Versions

Version TL1 ICS NTP SNMP v2 SNMP v3

Basic System Load X X Basic w/NTP Support X X X Basic w/SNMP v2 Support X X X Basic w/SNMP v2 and NTP SupportXXXX Basic w/SNMP v3 Support X X X X Basic w/SNMP v3 and NTP SupportXXXX X

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 21

Chapter 1 Overview SSU-2000e Control Languages

22 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

This chapter provides detailed information about the Transaction Language One

(TL1) that is used to communicate with the SSU-2000e.

In This Chapter

 TL1 Command Interface

 TL1 Retrieve Commands and Responses

 TL1 Set Commands

 Other TL1 Commands

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 23

Chapter 2 TL1 Reference

TL1 Command Interface

Telcordia Technologies (formerly Bellcore) specifies the TL1 command interface for

use as a standard man-machine language for controlling telecommunications

network elements. TL1 provides command sets to support all operation,

administration, maintenance, and provisioning tasks required to maintain and

control an SSU-2000e. These tasks include configuring and provisioning security,

monitoring system performance, configuring hardware, locating and handling faults,

and performing equipment diagnosis and testing.

Note:

To communicate with the SSU-2000e, you must first connect a terminal to one of the three EIA-232-C serial communication ports and then provision the Ethernet port. Then you can communicate with the SSU-2000e using an Ethernet telnet session.

To set up an SSU-2000e port for TL1 communications:

1. Log on to one of the SSU-2000e EIA-232 serial ports usin g a Supervisor-level (or higher) user name and password.

2. Set port A, B, or L to TL1 mode. For example, to set the local port (COML) to TL1 mode, at the system prompt, type:

COMM L MODE TL1 then press Enter

The communications mode settings for the COMM A and COMM B port s (located on the connection panel) are stored in non-volatile RAM, and remain in effect even after restarting the SSU-2000e.

The communications mode settings for the COMM L (local) port (located on the Communications module) always default to ASCII (ICS) mode on startup.

3. To close the serial port for TL1 communications, type

EXIT::::0; or send three

ESCape characters from the management terminal. This logs you out and returns the port to the default communications mode.

When you connect to the SSU-2000e via Ethernet port 2000 (decimal) using a Telnet-type application, the session opens in TL1 mode. Up to four sessions (users) can be connected to port 2000 at one time. Once you are connected, you must log in using the ACT-USER command with a user name and password (if security is active on the unit).

To log off the user and exit from an Ethernet session, type

CANC-USER:::0;.

Another user can then open a new session by using the ACT-USER command. To log off the user, exit from an Ethernet session, and close the Ethernet connection

to port 2000, type

EXIT:::0;. The next user must first connect to port 2000 and

then log in using the ACT-USER command.

24 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

TL1 Command and Response Conventions

Chapter 2 TL1 Reference

Note: The automatic time-out is disabled for the port when you are communicating in TL1 mode using one of the serial communications ports or the Ethernet port.

TL1 Command and Response Conventions

This section describes general and specific conventions for expressing TL1 command and response parameters for the four types of operations application messages:

 Input Command Message – This message determines the action that the

SSU-2000e will take. For a detailed descriptio n of input command messages and conventions, see Input Command Message Conventions, on page 26.

 In-Process Acknowledgment – The in-process acknowledgment (IP) response

message is sent in response to a command that the SSU-2000e is unable to respond to within two seconds. For a detailed description of in-process acknowledgment response messages and conventions, see In-Process

Acknowledgment Response Message Conventions, on page 27.

 Output response message – The output response message indicates whether

the command was complied with (COMPLD) or denied (DENY). For a detailed description of output response messages and conventions, see Output

Response Message Conventions, on page 28.

 Autonomous response or report message – The autonomous response or

report message is an output generated by the SSU-200 due to an event, such as an alarm, or a change in status in the system. For a detailed description of autonomous response or report messages and conventions, see Autonomous

Report Conventions, on page 30.

TL1 General Conventions

TL1 uses English-like acronyms and shorthand or abbreviations in a format that can be read and composed by humans.

Follow these general conventions for entering all TL1 parameters:

 Enter all command characters in upper-case. In the command syntax, lower-case

characters indicate parameters that you must supply.

 All commands must contain the cmd, tid, and ctag fields.  You may omit trailing commas in the parameters field.  Terminate command lines with a terminating semicolon (;) and an end-of-line

designator (

<cr><lf> or <cr lf>). The SSU-2000e executes the command

when it receives the terminating semicolon in the command entry.

 ^ is a blank that must appear in a command or response  : is a block separator character  :: indicates a null field for a block

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 25

Chapter 2 TL1 Reference TL1 Command and Response Conventions

 ; indicates the end of the message  <cr> and <lf> or <cr lf> indicate the ASCII carriage return (CR) and line feed

(LF) codes used as a line terminator and may be used separately or combined

 The ASCII cancel code character (hex 18) can be used to cancel a partially sent

command and clear the input buffer.

Input Command Message Conventions

Command messages entered and sent by the user determine the action that the SSU-2000e will take. Command messages are input messages, and are always followed by an acknowledgment or output response message.

The format for the input command message is:

cmd:tid:[aid]:ctag[:[gb]:<other>;<cr lf>

where:

 cmd (Command) is a descriptive string of letters that represents the input

command. The command string consists of a standard TL1 command verb, followed by one or two command modifiers. The modifiers identify the subject of the command verb and each may be as many as five characters. If two modifiers are used, they must be separated by dashes:

verb- mod1- mod2.

 tid

(Target Identifier) represents the name assigned to the SSU-2000e. The assigned name must be either null or match the name assigned to the SSU-2000e. If the tid is not null, it may must begin with a letter and may contain up to 20 alphanumeric characters see

Note: The SSU-2000e does not generate a resp on se for entr ies without a valid tid.

 aid (Access Identifier) is an optional field that represents the shelf, module, and

Set Name, on page 140.

port within the SSU-2000e to which the command is addressed or to which the response applies. The aid must be null (::, indicating ALL or not used), ALL (indicating all modules and ports related to the command type), or the aid assigned to an entity in the SSU-2000e.

Follow these conventions for entering the aid field:

SxAy-z

or ALL

where:

S placeholder to indicate Shelf number x SSU-2000e main (1) or expansion shelf (2-5) number A placeholder to separate the shelf number form the slot position y slot position (1-16) z port number (1-20) ALL all modules or ports to which the command applies

26 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

TL1 Command and Response Conventions

Chapter 2 TL1 Reference

Specify multiple aids using the ampersand (&) Use a single ampersand (&) to indicate aid1 and aid2 Use a double ampersand (&&) to indicate a range from aid1 to aid2 The y or z part of the aid also uses the ampersand (&)

 ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code

that is received with the command and returned in the response, for correlation of message and response within the operating system. The ctag can be any combination of six alpha-numeric characters randomly generated by the user.

 gb (General Block) is an field that is not used by the SSU-2000e but that you

must indicate by a double colon, that is, by preceding any parameters following the ctag field with double colons (::).

 other is a field that is used for commands that require other information. The

format for this field is specified in the individual command descriptions.

In-Process Acknowledgment Response Message Conventions

Each command received by the SSU-2000e with a valid tid generates a response when the terminating semicolon is received, followed by an output response message or the output response.

The SSU-2000e sends the in-process acknowledgment (IP) only if it is unable to respond to the command within two seconds. The requested response is then sent in full when the SSU-2000e data is available.

The in-process acknowledgment response always begins with a carriage return and two line feed characters, and ends with the header line containing the source identifier (sid), defined below, and the date^time stamp.

The format for the IP acknowledgment message is:

<cr lf lf> ^^^sid^date^time <cr lf> IP^ctag <cr lf> <

where:

 sid (Source Identifier) is the returned ID, and is the same as the tid in the input

command message to which the IP acknowledgment is responding.

 date is the current year, month, and day in the SSU-2000e in the format:

YY-MM-DD.

 time is the current hours, minutes, and seconds timestamp information in the

SSU-2000e in the 24-hour format: HH:MM:SS.

 IP is the in-process response message that the SSU-2000e sends in response to

a command only if the SSU is unable to respond to the command within two seconds. The SSU sends the requested response in full when the data is available.

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 27

Chapter 2 TL1 Reference TL1 Command and Response Conventions

 ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code

that is received with the command and returned in the response, for correlation of message and response within the operating system.

 The IP acknowledgment response always terminates with the less-than

character (<). The semicolon appears after the requested output response message is sent.

Output Response Message Conventions

The output response indicates whether the SSU-2000e complied with (COMPLD) or denied (DENY) the input command.

COMPLD Output Response Message Conventions – If the message is received correctly and can be processed by the SSU-2000e within two seconds, the complied message is sent with data that was requested in the input command message. The requested data is included in the response message lines and is always enclosed in quotation marks.

The format for a complied (COMPLD) output response message is:

<cr lf lf> ^^^sid^date^time <cr lf> M^^ctag^COMPLD <cr lf> [^^^"response message" <cr lf>] [...] ;

where:

 sid (Source Identifier) is the returned ID, and is the same as the tid in the input

command message to which the IP acknowledgment is responding

 date is the current year, month, and day in the SSU-2000e in the format:

YY-MM-DD

 time is the current hours, minutes, and seconds timestamp information in the

SSU-2000e in the 24-hour format: HH:MM:SS

 ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code

that is received with the command and returned in the response, for correlation of message and response within the operating system

 COMPLD is the complied message  "response message" is the response message. The response message line for

complied messages always begins with 3 spaces (^^^) followed by the response message enclosed in quotation marks, and terminated by <cr lf>. Multiple lines of response messages are allowed. Each command response is terminated by a semicolon following the last <cr lf>.

DENY Output Response Message Conventions – The DENY response contains a four-character error code (ercd) that describes the reason for the denied response. For example, the error code ICNV indicates Input Command Not Valid. The error codes are listed in Table 2-1.

28 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

TL1 Command and Response Conventions

Chapter 2 TL1 Reference

The SSU-2000e sends the DENY response when:

 the cmd is not valid  the aid is not valid  the ctag is not valid, indicated by a response containing the ctag set to a single

zero character (0)

 the unit is unable to comply with the request for the reason indicated by the ercd

The format for a denied (DENY) output response message is:

where:

 sid (Source Identifier) is the returned ID, and is the same as the tid in the input

command message

 date is the current year, month, and day in the SSU-2000e in the format:

YY-MM-DD.

 time is the current hours, minutes, and seconds timestamp information in the

SSU-2000e in the 24-hour format: HH:MM:SS

 ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code

that is received with the command and returned in the response, for correlation of message and response within the operating system

 DENY is the deny message  ercd (Error Code) is a four-character error code that explains the reason for the

deny, and is one of the following defined codes (other error codes may be defined and used, if required).

Table 2-1. Denied Response Error Codes

Error Code Definition

ICNV Command Not Valid IIAC Invalid aid Code IICT Invalid ctag IITA Invalid Target Identifier IPEX Extra Parameter IPMS Parame ter Missing IPNV Parameter Not Valid SDNR Data Not Ready

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 29

Chapter 2 TL1 Reference TL1 Command and Response Conventions

Autonomous Report Conventions

The SSU-2000e sends autonomous reports in response to a detected alarm condition or status change. You can select one of two formats for autonomous messages: GR-831 or GR-833. Use the RTRV-PRMTR-TL1FORMAT command to select which format is generated. These reports are similar to the RTRV-ALARM command responses, but contain an alarm code rather than the complied line.

The GR-831 format for an autonomous alarm report is:

<cr lf lf> ^^^sid^date^time <cr lf> alrmcde^atag^REPT^ALM^[AIDTYPE]<cr lf> ^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr"<cr lf>

The GR-831 format for an autonomous event report is:

<cr lf lf> ^^^sid^date^time <cr lf> alrmcde^atag^REPT^EVT<cr lf> ^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr"<cr lf>

where:

 sid is the source ID, and is the assigned name of the unit sending the message  date is the current date in the format: YY-MM-DD  time is the current timestamp information in the 24-hour format HH:MM:SS  alrmcde (Alarm Code) indicates the severity level of the reported alarm or event.

The alarm code is one of these four two-character codes: *C= critical alarm

** = major alarm *^ = minor alarm A^= non-alarm event

 atag (Alarm Correlation Tag) is a six-digit correlation tag that is incremented

each time a message is sent

 REPT (Report) indicates an autonomous report  AIDTYPE indicates the cause for the report, such as input signal fault (INP or T1)

or module hardware faults (EQPT)

 "response message" is the response message. The format for the response

message line is:

^^^"[aid]:ntfcncde,condtype,srveff,ocrdat,ocrtm[:condscr]" <cr lf>

where:

ntfcncde (Notification Code) is an optional field that further describes the

–

alarm or event in an output response or autonomous report, if required. The notification code is one of these two-character codes:

30 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

TL1 Command and Response Conventions

CR Critical alarm; MJ Major alarm; MN Minor alarm: CL Cleared alarm; NA Event (not an alarm)

condtype (Condition Type) indicates the type of alarm or event that the

–

Chapter 2 TL1 Reference

message is reporting

srveff (Service Affecting or Not Service Affecting) indicates whether the

–

response message affects service: SA (Service Affecting response) or NSA (Not Service Affecting response)

ocrdat (Occurrence Date) indicates the date of occurrence in the format

–

YY-MM-DD (year, month, day)

ocrtm (Occurrence Time) indicates the time of the occurrence in the

–

format HH:MM:SS (hours, minutes, seconds)

condscr (Condition Description) is an optional text string which is sent

–

with the alarm or event and which indicates the alarm or event condition

The GR-833 format for an autonomous alarm report is:

<cr lf lf> ^^^sid^date^time <cr lf> alrmcde^atag^REPT^ALM^[AIDTYPE]<cr lf> ^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr"<cr lf>

where the terms are identified in this section. The GR-833 format for an autonomous event report is:

<cr lf lf> ^^^sid^date^time <cr lf> alrmcde^atag^REPT^EVT<cr lf> ^^^"aid:condtype,condeff,ocrdat,ocrtm,,,,:condscr"<cr lf>

where:

 condeff defines the effect of the event on the system, as follows:

– CL indicates that a standing condition has been cleared – SC indicates that a standing condition is raised – TC indicates a transition of a condition.

If any alarm listed in Chapter 6, Alarms and Events, is set to Not Alarmed (NA), then

condeff is set to SC when the alarm becomes active and CL

when the alarm is cleared.

 Other terms are identified in this section

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 31

Chapter 2 TL1 Reference System Security

System Security

The operating software of the SSU-2000e includes a subset of GR-815 security requirements, including user lockout, password aging, an d login failure attempts. N ew commands allow an Administrator-level user to query the security log, set the login failed attempts threshold, set user lockout timer, and set the password-aging timer. New commands also allow you to back up and restore the configuration in the shelf.

In order to use the security features, the hardware and firmware in the SSU-2000e must be as shown in the following table.

Module

Communications module

Clock modules

Note:

The hardware revision is on a label locate d on the front panel. You can disp lay the hard ware

revision by issuing the TL1 command RTRV-INV, or the ICS command CONFIG.

Module Part

Number

23413012-00x-0 A.00 or higher 14313012-000-5 Rev. M.00

23413015-00x-0 23413016-000-0

Hardware Revision

Required

A.00 or higher A.00 or higher

Firmware Code Part

Number

14313015-000-5 Rev. M.00

The SSU-2000e system software allows you to set up a list of users with one of five access levels; each level has an increasing level of access to system functions and commands. Each incremental access level incorporates all of the options from the lower numbered access levels and additional options at that level. For instance, a User-level user does not have as many options available as a Technician-level user.

An Administrator-level user assigns the access level to each user when the user id and password is created. Table 2-2 summarizes each access level, ID number, and the operator privileges for each level.

Table 2-2. User Access Levels

Level ID Description

Idle 0 Access level 0 is available when no user is logged in. This level allows

Idle-level users to view a list of available commands (HELP), syntax, sof tware version number, unit id, or to login.

User 1 Users at the User level can execute level 0 commands and view information

about the current configuration and operation, and change communication settings such as line termination and echo. Changes made by a User-level user remain in effect only until the user logs out.

T e chnician 2 Users at the Te chnician level (CRAFT persons) can perform levels 0 through 1

functions, and can read or set all installation functions.

32 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

System Security

Table 2-2. User Access Levels (Continued)

Level ID Description

Supervisor 3 Supervisor-level users can execute all commands at levels 0 through 2, and

can read or set all functions.

Administrator 4 Administrator-level users can execute all levels of commands; they can view

and set software configurations; they can also add, delete, or modify the user table, or log off any user from any port.

TL1 Retrieve Commands and Responses

This section contains an alphabetical listing of TL1 retrieve commands, a description of the command which provides the valid aid codes to use in the command, and an example and description of the components of message lines.

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 33

Chapter 2 TL1 Reference Retrieve 2048 kHz Clock Output Parameters

Retrieve 2048 kHz Clock Output Parameters

This command returns the settings for the 2048 kHz Output module or port designated by the aid.

Syntax

RTRV-PRMTR-CLKOUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all 2048 kHz Output

SxAy[-z] Retrieves parameters from the specifie d 2048 kHz Output

Response Format

When the aid specifies a port, the response is:

^^^"aid:mode,level,bypass,fltmode,pstate,squelch" <cr lf>

modules in the shelf.

module [or port].

where:

 aid = port access identifier  mode = CLK  level = minimum clock level to enable outputs on the module [ACQ | LOCK]  bypass = allow Clock C selection: [ON | OFF]  fltmode = determines if outputs are set to Fault [OFF | ON | AUTO] when signal

levels drop below the threshold output level

 pstate = port state [1 | 0] (where 1 = ON and 0 = OFF)  squelch = threshold value [0 | 1 – 16] (where 0 = disabled). If the reference clock

PQL exceeds this value, then the output is turned off

When the aid specifies a module, the response is:

^^^"aid:mode,level,bypass,fltmode" <cr lf> ^^^"aid:pstate1,pstate2,…,pstate20" <cr lf> ^^^"aid:squelch1,squelch2,…,squelch20" <cr lf>

Line 1 contains:

 aid = module access identifier  mode = CLK  level = minimum clock level to enable outputs on the module [ACQ | LOCK]  bypass = [ON | OFF] for allowing Clock C selection

34 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve 2048 kHz Clock Output Parameters

 fltmode = determines if outputs are set to Fault [OFF | ON | AUTO] when signal

Chapter 2 TL1 Reference

levels drop below the threshold output level

Line 2 contains:

 aid = module access identifier  pstate# = port state [1 | 0] (where 1 = ON and 0 = OFF), and # = port number

[1 – 20]

Line 3 contains:

 aid = module access identifier  squelch# = squelch value [0 | 1 – 16] and # = port number [1 – 20]

Related Commands

Set 2048 kHz Output Parameters, on page 116

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 35

Chapter 2 TL1 Reference Retrieve Alarm Cutoff

Retrieve Alarm Cutoff

This command indicates whether the Alarm Cutoff (ACO) function is active in the SSU-2000e. The command creates a momentary change of state (pulse) on the alarm relay, which allows a specially-built alarm panel to squelch the audio alarm. Alarm panels that do not have this capability ignore the pulse. Contact your Symmetricom representative for further details on this alarm panel.

Syntax

RTRV-ACO:[tid]::ctag;

Response Format

"aco"<cr><lf>

where aco is [ACTIVE | INACTIVE]

Related Commands

Set Alarm Cutoff, on page 118

36 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Alarm Elevation Time

This command returns the time for alarm elevation, from 60 seconds to 500 000 seconds, for the specified module. A setting of 0 (zero) means the alarm does not automatically elevate to the next level. When an alarm has been at MINOR or MAJOR level continuously for level.

Syntax

RTRV-PRMTR-ELTIME:[tid]:[aid]:ctag;

Parameter Value Description

[aid] SxAy Retrieves the elevtime parameter from the specified

Response Format

^^^"aid:elevtime" <cr lf>

elevtime seconds, then it is elevated to the next

module.

where:

 aid = module access identifier  elevtime = alarm elevation time for the specified module

Related Commands

Set Alarm Level Parameters, on page 120

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 37

Chapter 2 TL1 Reference Retrieve Module Alarms

Retrieve Module Alarms

This command returns only alarm information from the specified modules from the stored event data. An aid or aid range may be used to limit the report to specified modules. The aid code is optional. With an aid of ALL or null, all alarm data between start and stop time is returned.

Syntax

RTRV-EVENT-ALARM:[tid]:[aid]:ctag::[count],[start],[stop];

Parameter Value Description

[aid] ALL or null Retrieves alarm data between the specified start and stop

[count] 1 – 500 Specifies the number of alarms to retrieve. The default

time from all modules.

SxAy Retrieves alarm data between the specified start and stop

time from the specified module.

count is 1.

[start] MM-DD,

HH:MM

Specifies the start date and time for data. If the date is null but followed by a time, the command default s to the current date. If the start time is null, but preceded by a date, the command defaults to the current time. If the start date and time are null, the command defaults to the st art of the dat a. The comma must be present to indicate a null start time.

[stop] MM-DD,

HH:MM

Response Format

One line containing the time stamp and event message is returned for each alarm in the log.

^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr" <cr lf>

where:

 aid = module access identifier  ntfcncde = Notification Code [CR | MJ | MN | CL]  condtype = Condition Type (event number)  srveff = service affecting flag [SA | NSA]: SA = service affecting, NSA =

non-service affecting

 ocrdat occurrence date  ocrtm = occurrence time  condstr = condition description string

38 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Example

SSU_2000 06-05-30 14:54:54

M 100 COMPLD

"S1A01:CL,1,NSA,06-05-30,13:47:14:\"Input Ref, Ok\"" "S2A07:CL,4,NSA,06-05-30,13:47:13:\"Clk-C, Ok\"" "S3A09:CL,4,NSA,06-05-30,13:47:13:\"Clk-C, Ok\"" "S3A05:CL,4,NSA,06-05-30,13:47:13:\"Clk-C, Ok\"" "S3A03:CL,4,NSA,06-05-30,13:47;13:\"Clk-C, Ok\""

;

Related Commands

Retrieve Events, on page 56 Retrieve Reports, on page 94

Chapter 2 TL1 Reference

Retrieve Module Alarms

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 39

Chapter 2 TL1 Reference Retrieve Alarm Parameters

Retrieve Alarm Parameters

This command returns the alarm settings for the specified module, or ALL alarms if no aid is specified.

Syntax

RTRV-PRMTR-ALARM:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves all the alarm parameters from the shelf.

Response Format

^^^"aid:almnum,level,startdelay,cleardelay"<cr lf>

where:

SxAy[-z] Retrieves alarm parameters from the specified module [o r

port].

 aid = module or port access identifier  almnum = alarm number  level = Ignore, Report, Minor, Major, or Critical: [IGN|RPT|MIN|MAJ|CRT]  startdelay = delay time or errored seconds count for start of the alarm  cleardelay = cleared seconds count for clearing of the alarm. Delay numbers

are reported only if they are settable for the alarm; otherwise they are reporte d as IMMED (immediate).

Related Commands

Retrieve All Alarms, on page 42

40 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Alarm Status

This command returns the current status of alarms from a specified module.

Syntax

RTRV-STATUS-ALARM:[tid]:[aid]:ctag;

Parameter Value Description

[aid] SxAy Retrieves the Alarm parameters from the specified

module.

Response Format

^^^"aid:almnum,stat" <cr lf>

where:

 aid = module or port access identifier  almnum = alarm number for that aid  status = current state of each alarm condition [OK | BAD]

Related Commands

Retrieve Alarm St atus , on page 41

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 41

Chapter 2 TL1 Reference Retrieve All Alarms

Retrieve All Alarms

This command reports all active alarms from the SSU-2000e or designated modules or ports with an aid indicating which module or port is generating the alarm. The response is the complied message followed by the alarm report message(s).

There may be no lines or there may be multiple lines in the report, one for each active alarm. There is no report message for modules or ports that have no alarm condition.

Syntax

RTRV-ALARM:[tid]:[aid]:ctag;

RTRV-ALM:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves information for all alarms that are currently

active in the entire shelf.

SxAy[-z] Retrieves information for all alarms that are currently

active in the specified module [or port].

Response Format

sid date time<cr><lf>

M ctag COMPLD<cr><lf>

"<aid>,aidtype:ntfcncde,condtype,srveff,\"condscr\"<cr><lf> "<aid>,aidtype:ntfcncde,condtype,srveff,\"condscr\"<cr><lf>

. .

"<aid>,aidtype:ntfcncde,condtype,srveff,\"condscr\"<cr><lf>

;

where:

 aid = module or port access identifier  ntfcncde = notification code (CR, MJ, MN, CL)  condtype = condition type (event number)  srveff = service affecting flag (SA, NSA)  condstr = condition description string

Related Commands

Retrieve Events, on page 56 Retrieve Module Alarms, on page 38 Retrieve Alarm Parameters, on page 40

42 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve CC Input Parameters

This command returns the settings for the Composite Clock Input module or port designated by the aid.

Syntax

RTRV-PRMTR-CCINP:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all CC Input modules in the

shelf.

S1Ay[-z] Retrieves parameters fr om t he specified CC Input module

[or port].

Response Format

^^^"aid:pstate,pri,pql,mode,zs" <cr lf>

where:

 aid = module or port access identifier  pstate = port enabled state [ON | OFF]  pri = priority 1 (highest) through 10 (lowest) or MON for monitor  pql = provisioned priority quality level [1 – 16]  mode = CC, indicating Composite Clock  zs = zero suppression [NA]

Related Commands

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 43

Chapter 2 TL1 Reference Retrieve CC Output Parameters

Retrieve CC Output Parameters

This command returns the settings for the Composite Clock Output module and port designated by the aid.

Syntax

RTRV-PRMTR-CCOUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all CC Output modules in

Response Format

When the aid specifies a port, the format for each response message line is:

^^^"aid:mode,level,bypass,pstate,duty,pcomp"<cr lf>

the shelf.

SxAy[-z] Retrieves parameters from the specified CC Output

module [or port].

where:

 aid = port access identifier  mode = CC (composite clock)  level = minimum clock level to enable outputs on the module [WARM | ACQ |

LOCK]

 bypass = allow Clock C selection: [ON | OFF]  pstate = port state [ON | OFF]  duty = duty cycle of the modules outputs [1 | 0] where 1 = 5/8 and 0 = 50/50  pcomp = phase compensation [1 – 7] where 7 = no compensation and 0 = 2200 ft.

The resolution is 275 ft.

When the aid specifies a module, then the response is four lines as follows:

^^^"aid: mode,level,bypass"<cr lf> ^^^"aid:pstate1,pstate2,pstate3,…pstate20"<cr lf> ^^^"aid:duty1,duty2,duty3,…duty20"<cr lf> ^^^"aid:pcomp1,pcomp2,pcomp3,…,pcomp20"<cr lf>

Line 1 contains:

 aid = module access identifier  mode = CC  level = minimum clock level to enable outputs on the module [WARM | ACQ |

LOCK]

 bypass = allow Clock C selection: [ON | OFF]

44 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve CC Output Parameters

Line 2 contains:

 aid = module access identifier  pstate# port state [1| 0] where (1 = ON, 0 = OFF), and # = port number

1 through 20

Line 3 contains:

 aid = module access identifier  duty# = duty cycle of the module outputs [1|0], where 1 = 5/8, 0 = 50/50

Line 4 contains:

 aid = module access identifier  pcomp# = phase compensation [1 – 7] and # = port number 1 through 20

Related Commands

Set CC Output Parameters, on page 122

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 45

Chapter 2 TL1 Reference Retrieve Clock Parameters

Retrieve Clock Parameters

This command returns the settings for the Clock module designated by the aid.

Syntax

RTRV-PRMTR-CLK:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves parameters from all Clock modules in the shelf.

S1A1 |

Retrieves parameters from the specified Clock module.

S1A12

Response Format

^^^"aid:warmup,mintau,maxtau,clkar,inpswt,inpsel,mintaulimit,maxtau limit" <cr lf>

where:

 aid = Clock module access identifier  warmup = warmup delay time in s  mintau = starting time constant in s  maxtau = final time constant value in s  clkar = current setting for the Clock Auto-Return mode [ON | OFF]  inpswt = input switch {AR|AS|OFF} for Auto-Return (revertive), Auto-Switch (but

not revertive), or no auto switch

 inpsel = {PRI|PQL} for priority or sync message (PQL) selection of inputs  mintaulimit = minimum tau limit  maxtaulimit = maximum tau limit

Related Commands

Set Clock Parameters, on page 123

46 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Clock Status

This command returns the clock status, loop mode, current time const ant value and current priority quality level (pql).

Syntax

RTRV-STATUS-CLK:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from both Clock modules.

S1A1 S1A12

Retrieves the parameters from the designated Clock module.

Response Format

Two message lines are returned if aid = ALL, one for each clock module (if both modules are installed). One message line is returned for the specified Clock module. The format for each response line is:

^^^"aid:mstat,mode,tau,pql,(offset),(sigma)" <cr lf>

where:

 aid = the access identifier of the Clock module whose status is being displayed  mstat = module status [OK | SEL | DIS | FLT]  clock mode = [WARM | ACQ | LOCK | HOLD]  tau = current time constant in seconds for the clock control loop  pql = Stratum Level of the clock  offset = clock frequency offset  sigma = clock frequency sigma value

Example

SSU_2000 06-06-13 10:45:11

M 100 COMPLD

"S1A01:SEL,LOCK,9000,2,(3.27E-10),(6.75E-10)" "S1A12:OK,LOCK,1200,2,(1.01E-08),(3.98E-10)"

;

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 47

Chapter 2 TL1 Reference Retrieve Communication Parameters

Retrieve Communication Parameters

This command returns the current serial communications protocol settings for the SSU-2000e.

Syntax

RTRV-PRMTR-COMM:[tid]:[aid]: ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all communication

ports in the shelf.

COML | COMA | COMB

Retrieves parameters from the specified serial port.

TELNET | TL1 Retrieves parameters from the specified telnet por t.

Response Format

When the aid specifies a port, the format for the response message line is:

^^^"aid:baud,echo,eol,mode,tout"<cr lf>

where:

 aid = communication port access identifier  baud = communications baud rate [19200 | 9600 | 4800 | 2400 | 1200]  echo = indicates if the port operates in full-duplex or half-duplex [ON | OFF]  eol = indicates the end-of-line character used when the unit transmits ASCII data

[CR | LF | CRLF]

 mode = mode of communication [ASCII | TL1]  tout = inactivity timeout period before the session is logged out [value | NEVER]

When the aid specifies a Telnet port, the format of the response message is:

^^^"aid:,,,,tout"<cr lf>

where:

 aid = communication port [TELNET | TL1]  tout = inactivity timeout period before the session is logged out [value | NEVER]

Related Commands

Set Communication Parameters, on page 126

48 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve Configuration

This command is replaced with the Retrieve Inventory command.

Chapter 2 TL1 Reference

Retrieve Configuration

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 49

Chapter 2 TL1 Reference Retrieve Configuration Date

Retrieve Configuration Date

This command returns the date and time of the last configuration change.

Syntax

RTRV-COND:[tid]::ctag;

Response Format

"LSTCFGC:ocrdat,ocrtm"<cr><lf>

where:

 ocrdat is the date of the last configuration change  ocrtm is the time of the last configuration change

Example

SSU_2000 06-05-30 14:19:22

M 100 COMPLD

"LSTCFGC:06-05-30,14:14:47"

;

Related Commands

50 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve DS1/E1 Input Parameters

Chapter 2 TL1 Reference

Retrieve DS1/E1 Input Parameters

This command returns the settings for the DS1 or E1 Input module or port designated by the aid.

Syntax

RTRV-PRMTR-INPUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all DS1 or E1 Input

modules in the shelf.

SxAy[-z] Retrieves parameters from the specified DS1 or E1 Input

module [or port].

Response Format

^^^"aid:pstate,pri,pql,mode,ssm,zs,crc,gain,csflt,bit" <cr lf>

where:

 aid = module or port access identifier  pstate = port enabled state [ON | OFF]  pri = priority 1 (highest) through 10 (lowest) or MON for monitor  pql = provisioned priority quality level [1 – 16]  mode = framing type or clock frequency in MHz: [ESF | D4 | CCS | CAS | 1 | 1.544

|2.048 | 5 | 10]

 ssm, zs, crc, and gain = [ON | OFF]  csflt = Cesium fault [HI | LO | OFF | NA]  bit = bit number 4 through 8 of the T ime Slot 0 word used fo r the E1 sync st atus

message

Related Commands

Set DS1/E1 Input Parameters, on page 128

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 51

Chapter 2 TL1 Reference Retrieve DS1/E1 Output Parameters

Retrieve DS1/E1 Output Parameters

This command returns the DS1 or E1 Output module or port settings specified by the aid.

Syntax

RTRV-PRMTR-OUTPUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all DS1 or E1 Output

SxAy[-z] Retrieves parameters from the specified DS1 or E1

Response Format

When the aid specifies a port, the response is:

^^^"aid:mode,level,bypass,zs,crc,bit,pstate,len" <cr lf>

modules in the shelf.

Output module [or port].

where:

When the aid specifies a module, the response is:

^^^"aid:mode,level,bypass,zs,crc,bit" <cr lf> ^^^"aid:pstate1,pstate2,…pstate20" <cr lf> ^^^"aid:len1,len2,len3,…,len20" <cr lf>

where: Line 1 contains:

 aid = module access identifier  mode = outputs signal mode: [ESF | D4 | CCS | CAS]  level = minimum clock level to enable outputs on the module [ACQ | LOCK]

52 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve DS1/E1 Output Parameters

 bypass = allow Clock C selection: [ON | OFF]  zs = zero suppression [ON | OFF]  crc = error checking [ON | OFF]  bit = SSM bit [4 – 8] for E1 sync status messages

Chapter 2 TL1 Reference

Line 2 contains:

 aid = module access identifier  pstate# = port enabled state [1 | 0] (1 = ON and 0 = OFF), and # is the port

number [1 – 20]

Line 3 contains:

 aid = module access identifier  len# = line length setting in feet [133 | 266 | 399 | 533 | 655] for all 20 DS1 outpu t

ports, and

# is the port number [1 – 20]

Related Commands

Set DS1/E1 Output Parameters, on page 129

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 53

Chapter 2 TL1 Reference Retrieve E1/2048 kHz Output Parameters

Retrieve E1/2048 kHz Output Parameters

This command returns the settings for the E1/2048 kHz Output module or port designated by the aid.

Syntax

RTRV-PRMTR-OUTE12048:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all E1/2048 kHz Output

SxAy[-z] Retrieves parameters from the specified E1/2048 kHz

Response Format

When the aid specifies a port, the format for each line is:

^^^"aid:mode,bypass,zs,signal,pstate,squelch,crc,ssm,bit"<cr lf>

modules in the shelf.

Output module [or port].

where:

 aid = port access identifier  mode = multiframe selection [CAS | CCS]  bypass = allow Clock C selection: [ON | OFF]  zs = zero suppression [ON | OFF]  signal = port signal type [E1 | 2048]  pstate = port state [ON | OFF]  squelch = threshold value [0 | 1 – 16] (where 0 = disabled). If the reference clock

PQL exceeds this value, then the output is turned off.

 crc = error checking [ON | OFF]  ssm = Sync Status Messaging enabled [ON | OFF]  bit = bit number [4 – 8] of the Time Slot 0 word used for the E1 sync status

message

When the aid specfies a module, then the response is four lines as follows:

^^^"aid: mode,bypass,zs,crc,ssm,bit"<cr lf> ^^^"aid:signal1,signal2,signal3,…signal20"<cr lf> ^^^"aid:pstate1,pstate2,pstate3,…pstate20"<cr lf> ^^^"aid:squelch1,squelch2,squelch3,…squelch20"<cr lf>

54 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve E1/2048 kHz Output Parameters

Chapter 2 TL1 Reference

where: Line 1 contains:

 aid = module access identifier  mode = multiframe selection [CAS | CCS]  bypass = allow Clock C selection [ON | OFF]  zs = zero suppression [ON | OFF]  crc = error checking [ON | OFF]  ssm = Sync Status Messaging enabled [ON | OFF]  bit = bit number 4 through 8 of the T ime Slot 0 word used fo r the E1 sync st atus

message

Line 2 contains:

 aid = module access identifier  signal# = port signal type [ E1 | 2048], and # = port number [1 – 20]

Line 3 contains:

 aid = module access identifier  pstate# = port state [ON | OFF], and # = port number [1 – 20]

Line 4 contains:

 aid = module access identifier  squelch# = threshold value [0 | 1 – 16] (where 0 = disabled). If the reference

clock PQL exceeds this value, then the output is turned off. # = port number [1 – 20]

Related Commands

Set E1/2048 kHz Output Parameters, on page 130

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 55

Chapter 2 TL1 Reference Retrieve Events

Retrieve Events

This command returns stored event data from any or all modules. An aid or aid range may be used to limit the report to specified modules. The aid code is optional. With an aid of ALL or null, all event data between start and stop time is returned.

Syntax

RTRV-EVENT:[tid]:[aid]:ctag::[count],[start],[stop];

Parameter Value Description

[aid] ALL Retrieves event data between the specified start and stop

[count] 1 – 500 Specifies the number of events to retrieve. The default

time from all modules.

SxAy Retrieves event data between the specified start and stop

time from the specified module.

count is 1.

[start] MM-DD,

HH:MM

[stop] MM-DD,

HH:MM

Response Format

One line containing the time stamp and event message is returned for each event in the log.

^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr" <cr lf>

where:

 aid = module access identifier  ntfcncde = notification code [CR | MJ | MN | CL]  condtype = condition type (event number)  srveff = service affecting flag [SA | NSA]: SA = service affecting, NSA =

non-service affecting

 ocrdat = occurrence date  ocrtm = occurrence time  condstr = condition description string

56 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Example

SSU_2000 06-05-30 14:53:56

M 100 COMPLD

"S1A01:NA,147,NSA,06-05-30,14:14:57:\"Output Pql, 2\"" "S1A01:NA,146,NSA,06-05-30,14:14:49:\"Inp Select, 1A05-01\"" "S1A05:NA,193,NSA,06-05-30,14:14:46:\"Priority, 1, TELA\"" "S1A02:NA,158,NSA,06-05-30,14:11:15:\"NTP Mode, CLIENT\""

;

Related Commands

Retrieve Module Alarms, on page 38 Retrieve Reports, on page 94

Retrieve Events

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 57

Chapter 2 TL1 Reference Retrieve Frequency Data

Retrieve Frequency Data

This command returns the current frequency measurements for the specified input(s) on the DS1, E1, Sine, and GPS Input modules.

Syntax

RTRV-DATA-FREQ:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the current frequency measurements from all

Response Format

^^^"aid:(freqa),(freqb)"<cr lf>

where:

modules that are currently active in the entire shelf.

S1Ay[-z] Retrieves the current frequency measurements from the

specified module [or port].

 aid = module or port access identifier  freqa = frequency of the port versus clock A  freqb = frequency of the port versus clock B

Example

SSU_2000 06-06-26 13:38:57

M 100 COMPLD

"S1A03-01:(0),(0)" "S1A03-02:(0),(0)" "S1A03-03:(0),(0)" "S1A04-01:(-3),(-31)" "S1A05-01:(5),(-23)" "S1A06-01:(0),(0)" "S1A06-02:(0),(0)" "S1A06-03:(0),(0)"

;

Related Commands

58 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Frequency Parameters

This command returns the MTIE threshold settings for the specified port on a DS1, E1, Sine, or GPS Input module.

Syntax

RTRV-PRMTR-FREQ:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the MTIE threshold parameters from all Input

modules in the shelf.

S1Ay-z Retrieves the MTIE threshold parameters from the

specified input port.

Response Format

^^^"aid:freq,fae,fac,fbe,fbc,fatau,fbtau" <cr lf>

where:

 aid = access identifier of the port  fae = frequency error threshold for A  fac = clear threshold for A  fbe = error threshold for B  fbc = clear threshold for C  fatau = frequency error for A  fbtau = frequency error for B

Related Commands

Retrieve MTIE Data, on page 76 Retrieve MTIE History, on page 78 Set MTIE Parameters, on page 139

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 59

Chapter 2 TL1 Reference Retrieve GPS Available Data

Retrieve GPS Available Data

This command returns the current tracking data for the specified GPS Input module. If the input specified is not a GPS Input module, a DENY response is returned.

Syntax

RTRV-DATA-GPS-AVAIL:[tid]:[aid]:ctag;

Parameter Value Description

[aid]

S1A3|S1A5

Retrieves satellite data from the specified GPS Input module.

Response Format

A valid response message contains up to 12 lines. Each line displays information for one of the satellites currently being tracked. The format is:

^^^"aid:chan,pn,health,azimuth,elevation"<cr lf>

where:

 aid = module access identifier  chan = channel number for tracking the satellite  pn = satellite PN code  health = current health of the satellite: H (healthy) or U (unhealthy)  azimuth and elevation = calculated orientation of the satellite

Example

SSU_2000 06-05-30 14:40:40

M 100 COMPLD

"S1A05:1,1,H,272,41" "S1A05:2,5,H,76,13" "S1A05:3,14,H,344,62" "S1A05:4,15,H,164,33" "S1A05:5,18,H,98,29" "S1A05:6,19,H,268,11" "S1A05:7,22,H,56,62" "S1A05:8,30,H,110,16"

;

Related Commands

Retrieve GPS Data, on page 61

60 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve GPS Data

This command returns the current tracking data for the specified GPS input. If the input specified is not a GPS Input module, the DENY response is returned.

Syntax

RTRV-DATA-GPS:[tid]:[aid]:ctag;

Parameter Value Description

[aid]

S1A3|S1A5

Retrieves GPS data from the specified GPS Input module.

Response Format

A valid response message contains up to eight lines. Each line displays information for one of the satellites currently being tracked. The format is:

^^^"aid:chan,sv#,snr,status"<cr lf>

...

^^^"aid:PPSSIGMA:pps_sigma"<cr lf> ^^^"aid:T3SIGMA:t3sigma_threshold"<cr lf>

where:

 aid = module access identifier  chan indicates the channel number used to track the corresponding sv  sv# = satellite vehicle number  snr = signal-to-noise ratio or signal strength  status = the current tracking status [SRC | COD | FRQ | TIM | EPH | OK]

where: SRC = searching, COD = code locking, FRQ = frequency locking, TIM = setting time, EPH = retrieving Ephemeris data, OK = satellite being used in the timing solution

 pps_sigma = current 1PPS sigma value  t3sigma_threshold = the current 3-sigma threshold

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 61

Chapter 2 TL1 Reference Retrieve GPS Data

Example

SSU_2000 06-05-30 14:38:03 M 100 COMPLD "S1A03: 1,20,093,OK" "S1A03: 2,07,083,OK" "S1A03: 3,13,104,OK" "S1A03: 4,27,066,OK" "S1A03: 5,16,104,OK" "S1A03: 6,23,066,OK" "S1A03: 7,01,104,OK" "S1A03: 8,31,052,OK" "S1A03: 9,19,066,OK" "S1A03:10,25,083,OK" "S1A03:11,,,EMPTY" "S1A03:12,,,EMPTY" "S1A03:PPSSIGMA: 3.60E-17" "S1A03:T3SIGMA: 2.03E-15" ;

Related Commands

Retrieve GPS Available Data, on page 60

62 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve GPS Input Parameters

This command returns the settings for the GPS Input module desig nated by the aid.

Syntax

RTRV-PRMTR-GPS:[tid]:[aid]:ctag;

Parameter Value Description

[aid] S1A3

S1A5

Retrieves the parameters from the specified GPS Input module.

Response Format

^^^"aid:pri,pql,sigma,posel,timel,pdop" <cr lf>

where:

 aid = module access identifier  pri = priority setting of [0 – 10] with 0 = MON  pql = provisioned priority quality level [1 – 16]  sigma = this field is obsolete  posel = minimum satellite elevation for positioning purposes  timel = minimum satellite elevation for timing purposes  pdop = current pdop mask

Related Commands

Set GPS Input Parameters, on page 132

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 63

Chapter 2 TL1 Reference Retrieve GPS Position

Retrieve GPS Position

This command returns the settings for the GPS Input module desig nated by the aid.

Syntax

RTRV-GPS-POS:[tid]:[aid]:ctag;

Parameter Value Description

[aid] S1A3|S1A5 Retrieves the GPS data from the specified GPS Input

Response Format

If the GPS engine has not yet established a position, the response includes the “No Valid Position Information” message. Otherwise, the format is:

^^^"aid:lat,lon,hgt,pdop,mode,avg,posel,timel" <cr lf>

where:

module.

 aid = module access identifier  lat = current latitude of the receiver in the format (DD)-MM-SS:SS  lon = current longitude of the receiver in the format (DD)-MM-SS.SS  hgt = current height of the receiver in meters  pdop = current Position Dilution of Precision or pdop mask [1 through 10]. Pdop

is a measurement that indicates the geometry of the GPS satellites that the SSU-2000e is tracking. Lower values indicate better geometry.

 mode = GPS positioning mode is user-specified or calculated: [User|Calc]. If the

positioning mode is set to User, the configuration setting is sent to the GPS engine and the mode is set to a fixed position. When the positioning mode is set to Calc, the elevation mask setting for positioning is sent to the engine, the engine is set to positioning mode, and 10 positions are averaged and compared to the configuration setting. If there is a greater than 300 meter error, the unit recalculates the position based on the averaging count. If there is no such error, the unit uses the stored position. The SSU-2000e generates an event when the GPS module calculates a new position, and stores the new position in NVRAM as the current position and changes the engine mode to fixed position.

 avg = current GPS position averaging count. Setting the averaging count

generates an event and starts a new position fix automatically.

 posel = minimum satellite elevation to use for positioning  timel = the minimum satellite elevation to use for timing

Example

SSU_2000 05-03-08 15:37:53 M 1 COMPLD

"S1A03:(+30:28:08.03),(-097:40:34.05),(254.23),(3.9),CALC,300,5,10" ;

64 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Header

This command allows you to verify that the SSU-2000e is connected to the computer or network. It may also be used to retrieve the unit name (sid) and date and time. The only action taken by the SSU-2000e is to respond with the complied message.

Syntax

RTRV-HDR:[tid]::ctag;

Example

SSU_2000 06-05-30 14:56:57 M 100 COMPLD ;

Related Commands

Retrieve Name, on page 80 Retrieve Network Element Type, on page 81

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 65

Chapter 2 TL1 Reference Retrieve Input Data

Retrieve Input Data

This command returns the current LOS, AIS, OOF, BPV, CRC Error and Clear counts for the specified inputs on DS1, E1, or CC Input modules.

Syntax

RTRV-DATA-INPUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the current input data from all modules that are

Response Format

When the aid specifies a module [or port], the format for each response message line is:

currently active in the entire shelf.

S1Ay[-z] Retrieves the current input data from the specified module

[or port].

^^^"aid:loserr,losclr,aiserr,aisclr,ooferr,oofclr,bpverr,bpvclr, crcerr,crcclr"<cr lf>

where:

 aid = module or port access identifier  ???err is the erred second count for each of the signal faults as listed above  ???clr is cleared second count for each of the signal faults as listed above

When the aid specifies ALL, the format of the response message is:

^^^"aid:LOS,loserr,losclr"<cr lf> ^^^"aid:AIS,aiserr,aisclr"<cr lf> ^^^"aid:OOD,ooferr,oofclr"<cr lf> ^^^"aid:BPV,bpverr,bpvclr"<cr lf>> ^^^"aid:CRC,crcerr,crcclr"<cr lf>

where:

 ???err is the erred second count for each of the signal faults as listed above  ???clr is cleared second count for each of the signal faults as listed above

Related Commands

Retrieve Signal Fault Alarm Parameters, on page 102 Set Signal Fault Alarm Parameters, on page 150

66 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Input Reference

This command returns the current input reference, reference switch mode, and reference selection mode.

Syntax

RTRV-INPUT-REF:[tid]::ctag;

Response Format

^^^"port,swtmode,selmode"<cr lf>

where:

 swtmode = auto return (revertive) selection, auto switch (but not revertive), or no

auto switching [AR | AS | OFF]

 selmode = reference selection: [PRI | PQL] for priority quality level or status

message selection of inputs

If the input port is not a valid reference, the DENY response is returned.

Example

SSU_2000 06-05-30 14:42:54 M 100 COMPLD

"S1A05-01,AR,PRI" ;

Related Commands

Set Input Reference, on page 134

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 67

Chapter 2 TL1 Reference Retrieve Input Status

Retrieve Input Status

This command returns the condition (current operating mode and readings) of the input ports.

Syntax

RTRV-STATUS-INPUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all Input modules in the

Response Format

One line is returned for each module [or port] designated by the aid.

^^^"aid:mstat,pstate,(pha),(phb),pql" <cr lf>

shelf.

S1Ay[-z] Retrieves parameters from the specified Input module [or

port].

where:

 aid = module or port access identifier  mstat = module status {OK | DIS | FLT}  pstate = the port state {OK | DIS | FLT}  pha and phb = current 1-second phase values in nanoseconds, or NA if not

available

 pql = current pql level (read or provisioned) being reported by the port, if

available. If pql = 0 , then the pql is not applicable for that port.

Example

SSU_2000 06-03-08 20:28:19 M 100 COMPLD

"S1A03-01:OK,OK,(-29),(-8),2"

"S1A04-01:OK,OK,(-20),(-72),4"

"S1A05-01:OK,DIS,NA,NA,4" ;

68 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Inventory

This command returns the inventory management information for the SSU-2000e

Syntax

RTRV-INV:[tid]::ctag;

RTRV-INVENTORY:[tid]::ctag;

Response Format

The response is the complied message followed by the response message(s). A summary for each module and shelf are returned in the following format:

^^^"aid:desc,hwpart,hwrev,hwserial,swpart,swrev,adapterp art" <cr lf>

where:

 aid is the module or shelf access identifier. See the table below for details.  desc is the text name of the module. See the table below for details.  hwpart is the hardware part number. See the table below for details.  hwrev is the hardware revision level  hwserial is the hardware serial number  sw_art field is the software part number (i.e. 141xxxxx-xxx-x)  swrev field is the software revision level  adapterpart is the Input adapter part number. If empty, then the input adapter

identification is not available for the module. For detailed information about adapter identification, refer to Specification, SSU-2000e Input Adapter/

Identification, part number 12613021-001-2. The aid reported is the shelf address. The

aid, desc and hwpart are per the following table:

aid desc hwpart

S1 SSU-2000 25413120-000-0 S2 – S5 SDU-2000 25413023-000-0 S1 SSU-2000e 25413140-000-0

254131140-001-0 (DT)

S2 – S5 SDU-2000e 25413141-000-0

25413141-001-0 (DT)

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 69

Chapter 2 TL1 Reference Retrieve Inventory

Example

SSU_2000 05-12-13 18:53:57

M 100 COMPLD

"1:SSU_2000,25413020-000-0" "S1A01:Clock Stratum 2E,23413016-000-0,A,1234567890,14313015-000-5,M.00" "S1A02:Communications,23413012-000-0,E.,1234567890,14313012-000-5,L.00" "S1A03:Input GPS,23413019-000-0,2,1234567890005,14313019-000-5,A.09" "S1A05:Input DS1 3Port,23413013-002-0,B.O8,L84407,14313013-000-5,D.04" "S1A06:Input Sine,23413305-000-0,REV 1.00,L84408,14313305-000-5,A.00" "S1A09:Output 2048 kHz,23413159-000-0,A., L84409,14313159-000-5,C.00" "S1A12:Clock Stratum 3E,23413015-000-0,A.06, J10919,14313015-000-5,M.00" "2:SDU-2000,25413023-000-0" "S2A01:Output E1,23413018-000-0,1,1234567890,14313017-000-5,C.b00.41" "S2A02:Output DS1,23413017-000-0,B,990705398000613453,14313017-000-5,B.01" "S2A04:Output 2048 kHz,23413159-000-0,A.01,1234567890,14313159-000-5,C.00" "S2A05:Output RS422,23413287-000-0,3.0,1234567890,14313287-000-5,A.00" "S2A09:Output E1,23413018-000-0,A,1234567890,14313017-000-5,C.b00.41" "S2A10:Output Sine,23413304-000-0,REV 2.00,J10840,14313304-000-5,A.00" "S2A13:Output 2048 kHz,23413159-000-0,C.0,1234567890,14313159-000-5,C.00" "S2A15:Buffer Card,23413122-000-0,B.,990705398000737838,,A.0 " "S2A16:Buffer Card,23413122-000-0,B.,990705398000737708,,A.0 " "3:SDU-2000,25413023-000-0" "S3A05:Output 2048 kHz,23413159-000-0,C.00,1234567890,14313159-000-5,C.00" "S3A06:Output 2048 kHz,23413159-000-0,1,1234567890,14313159-000-5,C.00" "S3A08:Output 2048 kHz,23413159-000-0,1,1234567890,14313159-000-5,C.00" "S3A10:Composite Clock,23413158-000-0,2,123456789000,14313158-000-5,B.01" "S3A11:Output E1,23413018-000-0,D,990705398000650816,14313017-000-5,B.01" "S3A12:Output E1,23413018-000-0,A,1234567890,14313017-000-5,B.b02.5" "S3A15:Buffer Card,23413122-000-0,B.,990705398000737821,,A.0 " "S3A16:Buffer Card,23413122-000-0,B.,990705398000737845,,A.0 "

;

70 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve IP Parameters

This command returns the current Internet Protocol settings for the unit.

Syntax

RTRV-PRMTR-IP:[tid]::ctag;

Response Format

^^^"aaa.aaa.aaa.aaa,mmm.mmm.mmm.mmm,ggg.ggg.ggg.ggg"<cr lf>

where:

 aaa.aaa.aaa.aaa = IP address of the unit  mmm.mmm.mmm.mmm = IP mask of the unit  ggg.ggg.ggg.ggg = IP gateway of the unit

Related Commands

Set IP Parameters, on page 135

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 71

Chapter 2 TL1 Reference Retrieve Keep-alive Parameters

Retrieve Keep-alive Parameters

The Keep-alive function causes autonomous messages to be transmitted at a user selectable interval. This command returns the current TL1 and SNMP keep-alive settings for the unit.

Syntax

RTRV-PRMTR-KEEPALIVE:[tid]::ctag;

Response Format

^^^"tl1time,snmptime"<cr lf>

where:

 tl1time = TL1 session timer in minutes  snmptime = SNMP session timer in minutes.  Times set to zero indicate keep-alive is disabled

Related Commands

Set Keep-alive Parameter, on page 136

72 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve LED

This command returns the status of the LEDs in the specified module. The LEDs are reported in order from top to bottom.

Syntax

RTRV-LED:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves all LED data from the shelf.

SxAy Retrieves LED data from the specified module.

Refer to the SSU-2000e User’s Guide for a detailed description of each module’s LED indicators.

Response Format

If the module does not support this command, the DENY response is returned.

^^^"aid:hwpart,num,led1,...,ledn" <cr lf>

where:

 aid = module access identifier  hwpart = the hardware part number for the module  num = total number of LEDs in the specified module  ledn = LED status [OFF | GRN | AMB | RED | BLK], where OFF = LED is off,

GRN = LED is green, AMB = LED is amber, RED = LED is red, BLK = LED is

blinking

Example

SSU_2000 05-01-13 19:26:34

M 100 COMPLD

"S1A01:23413016-000-0,7,GRN,GRN,GRN,OFF,OFF,GRN,OFF" "S1A02:23413012-000-0,8,GRN,GRN,GRN,GRN,AMB,AMB,OFF,GRN" "S1A03:23413019-000-0,4,GRN,GRN,GRN,GRN" "S1A04:23413014-002-0,8,GRN,GRN,OFF,OFF,OFF,OFF,OFF,OFF" "S1A06:23413305-000-0,8,GRN,GRN,OFF,AMB,OFF,AMB,OFF,AMB" "S1A07:23413305-000-0,8,GRN,GRN,OFF,GRN,OFF,GRN,OFF,AMB" "S1A10:23413306-000-0,7,GRN,GRN,GRN,OFF,OFF,OFF,OFF" "S1A12:23413015-000-0,7,GRN,GRN,OFF,OFF,OFF,GRN,OFF"

;

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 73

Chapter 2 TL1 Reference Retrieve Local Time Offset

Retrieve Local Time Offset

This command returns the local offset time (t he current local time is included in TL1 responses).

The local time offset is the dif ference between local a nd UTC times. If the local t ime zone is ahead of UTC, the value of Offset is positive. If the local time zo ne is behind UTC, the value of Offset is negative.

Syntax

RTRV-DAT:[tid]::ctag;

Response Format

"OFFSET:(+/-hh.mm)"<cr><lf>

where:

 ocrdat is the date of the last configuration change  ocrtm is the time of the last configuration change

Example

SSU_2000 06-0-28 13:31:37

M 100 COMPLD

"OFFSET:(-6:00)"

;

Related Commands

74 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Login Events

This command displays whether login and logout events are recorded in the event log. Login and logout events always appear in the system console.

Syntax

RTRV-PRMTR-EVTLOGIN:[tid]::ctag;

Response Format

^^^"aid:evtlogin"<cr lf>

where:

 aid = shelf access identifier  evtlogin = [ENABLE | DISABLE].

Related Commands

Set Login Events

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 75

Chapter 2 TL1 Reference Retrieve MTIE Data

Retrieve MTIE Data

This command returns the MTIE data for a specified port on a DS1, E1, Sine, or GPS Input module. The command requires an aid to identify the input port to report data from. You can specify a Clock module identifier and the start and stop times for the measurement. If you do not specify a clock [CLK-A | CLK-B], the current output clock is used.

Only the values available in the interval between the start and stop times are output. For the first three hours of operation after an input is enabled, the values are displayed on a 1-minute boundary . Af ter the first three hours of operation, the d ata is displayed on a 1-hour boundary. The returned MTIE values have a timestamp that corresponds to the nearest minute or hour boundaries.

Syntax

RTRV-DATA-MTIE:[tid]:aid:ctag[::[clksrc][,start][,stop];

Parameter Value Description

[aid] S1Ay-z Retrieves current MTIE data from the specified Input port. [clksrc] [CLK-A |

Specifies which clock supplies the MTIE data.

CLK-B]

[start] {MM-DD},

{HH:MM}

Specified the start date and time. If the date is null but followed by a time, the command defaults to the current date. If the start time is null, but preceded by a date, the command defaults to the current time. If the start date and time are null, the command defaults to the st art of the dat a. The comma must be present to indicate a null start time.

[stop] {MM-DD},

{HH:MM}

Response Format

The response is the complied message followed by the requested dat a in the forma t:

^^^"aid:ocrdat,ocrtm,MTIE,clksrc,temper,monval"<cr lf>

where:

 aid = port access identifier  ocrdat and ocrtm = the beginning date and time the data was collected  clksrc = clock A or B used for the measurements  tmper = time period for the measurement data, given in seconds. The maximum

tmper values for MTIE are 0.05, 0.1, 1, 10, 100, 1000, 10000, and 100000

 monval = data value for the time period, in nanoseconds

76 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Example

SSU_2000 06-05-30 14:49:34

M 100 COMPLD

"S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,0.05,30" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,0.10,30" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,1.00,30" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,10.00,30" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,100.00,31" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,1000.00,39" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,10000.00,51" "S1A04-01:06-05-29,14:59:58,MTIE,CLK-A,100000.00,51"

;

Related Commands

Retrieve MTIE History, on page 78 Set MTIE Parameters, on page 139

Chapter 2 TL1 Reference

Retrieve MTIE Data

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 77

Chapter 2 TL1 Reference Retrieve MTIE History

Retrieve MTIE History

This command returns the historical MTIE data for a port on a DS1, E1, Sine, or GPS Input module. The Historical MTIE data is the 24-hou r MTIE data stored every day at midnight. There are 99 historical MTIE records stored. The command requires an aid to identify the input port to report data from. The optional p arameters are the clock identifier and the number of day(s) of MTIE history to be retrieved from the current day (day 0). If you do not specify a clock source [CLK-A | CLK-B], the current output clock is used.

Syntax

RTRV-DATA-MTIE-HIST:[tid]:aid:ctag[::[clksrc][,count];

Parameter Value Description

[aid] S1Ay-z Retrieves the current MTIE history data from the specified

Input port.

[clksrc] CLK-A |

CLK-B

[count] 1 - 99 Specifies the number of days of MTIE history to retrieve.

Specifies which clock supplies the MTIE history data.

Response Format

The response is the complied message followed by the requested data.

^^^"aid:ocrdat,ocrtm,MTIE,clksrc,monval1,monval2,.., monval8"<cr lf>

where:

 aid = port access identifier  ocrdat and ocrtm = beginning date and time the data was collected  clksrc = CLK-A or CLK-B used for the measurements  monval? = the data value for the time period, given in nanoseconds. There are

eight monvals in sequence, and the time periods in sequence are 0.05, 0.1, 1,

10, 100, 1000, 10000, and 100000

Example

SSU_2000 06-06-26 12:51:44

M 100 COMPLD

"S1A05-01:06-06-21,00:01:00,MTIE,CLK-A,21,21,21,49,57,61,73,79" "S1A05-01:06-06-22,00:01:00,MTIE,CLK-A,11,11,11,20,24,33,40,79" "S1A05-01:06-06-23,00:01:00,MTIE,CLK-A,11,11,11,19,27,30,39,54" "S1A05-01:06-06-24,00:01:00,MTIE,CLK-A,12,12,12,20,26,29,41,54" "S1A05-01:06-06-25,00:01:00,MTIE,CLK-A,9,9,9,19,24,30,40,53"

;

Related Commands

Retrieve MTIE Data, on page 76

78 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve MTIE Parameters

This command returns the MTIE threshold settings for the DS1, E1, Sine, or GPS Input module or port designated by the aid.

Syntax

RTRV-PRMTR-MTIE:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the MTIE parameters from all Input modules in

the shelf.

S1Ay-z Retrieves MTIE parameters from the specified Input port.

Response Format

There are always four lines returned for each input port, one for each limit.

^^^"aid:MTIE,EL1,t10,t100,t1000,t10000,t100000" <cr lf> ^^^"aid:MTIE,EL2,t10,t100,t1000,t10000,t100000" <cr lf> ^^^"aid:MTIE,CL1,t10,t100,t1000,t10000,t100000" <cr lf> ^^^"aid:MTIE,CL2,t10,t100,t1000,t10000,t100000" <cr lf>

where: The first line contains the module or port aid and the error thre shold settings for EL1.

The second line contains the module or port aid and the error threshold settings for EL2. The third line contains the module or port aidand the clear threshold settings for CL1. The fourth line contains the module or port aid and the clear threshold settings for CL2.

Example

SSU_2000 06-06-26 15:06:38

M 100 COMPLD

"S1A05-01:MTIE,EL1,260,440,810,880,1600" "S1A05-01:MTIE,EL2,325,550,1010,1100,2000" "S1A05-01:MTIE,CL1,230,400,730,790,1440" "S1A05-01:MTIE,CL2,290,490,910,990,1800"

;

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 79

Chapter 2 TL1 Reference Retrieve Name

Retrieve Name

This command returns the name assigned to the shelf or to Input or Output ports, excluding the Line Retiming Module. One name of up to 20 characters is returned for each port designated by the aid.

Syntax

RTRV-NAME:[tid]:[aid]:ctag;

Parameter Value Description

[aid] S1A2 Retrieves the name from the unit.

Response Format

When the aid is S1A2, the name of the unit is returned. When the aid is an I/O module or port, the assigned port name is returned. If no name is assigned to a port, then a null field is returned.

SxAy[-z] Retrieves the name from the specified module [or port]..

^^^"aid:name" <cr lf>

Related Commands

Retrieve Header , on page 65 Set Name, on page 140

80 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Network Element Type

This command serves the same purpose as RTRV-HDR with an element type message added.

Syntax

RTRV-NETYPE:[tid]::ctag;

Response Format

^^^"SSU2000" <cr lf>

Related Commands

Retrieve Header , on page 65 Retrieve Name, on page 80

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 81

Chapter 2 TL1 Reference Retrieve NTP Parameters

Retrieve NTP Parameters

This command returns the current Network Timing Protocol settings for the shelf.

Syntax

RTRV-PRMTR-NTP:[tid]::ctag;

Response Format

^^^"ip1,mode,interval"<cr lf> ^^^"ip2,mode,interval"<cr lf> ^^^"ip3,mode,interval"<cr lf> ^^^"PREFER:todSource"<cr lf>

where:

 ip = the server ip used by the client or broadcast client or broadcast server.  mode = the operating mode for the given ip [CLIENT | BCLIENT | BROADCAST].

In CLIENT mode, the SSU automatically requests the time from the server. In

BCLIENT mode, the server designated by the ip is a broadcast server. In

BROADCAST mode, the SSU is set up as a broadcast server.

 interval = broadcast interval [32 | 64 | 128 | 512 | 1024] seconds; used when

the SSU is set up as a broadcast server. The SSU is automatically configu red as

an NTP server with the address specified in the SET-PRMTR-IP command. Up to

three NTP ips may be listed.

 todSource = the preferred TOD source [GPS | CLIENT]

Example

SSU_2000 06-06-26 15:08:18

M 100 COMPLD

"172.16.21.19,CLIENT" "172.16.21.42,CLIENT" "PREFER:CLIENT"

;

Related Commands

Set NTP Parameters, on page 141

82 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve NTP Status

This command returns the current Network Timing Protocol (NTP) status of the SSU-2000e.

Syntax

RTRV-STATUS-NTP:[tid]::ctag;

Response Format

Up to three NTP IP addresses may be listed.

^^^ip1,offset,delay,dispersion,stratum,smode"<cr lf> ^^^ip2,offset,delay,dispersion,stratum,smode"<cr lf> ^^^ip3,offset,delay,dispersion,stratum,smode"<cr lf> ^^^SYS:mode,sysIp,sysOffset"<cr lf>

where:

 ip = the server IP address used by the client or broadcast client or broadcast

server

 offset = the number of seconds (partial seconds) that the local time was

adjusted by

 delay = the calculated delay in the communication path  dispersion = a value that indicates the accuracy of the offset/delay settings  stratum = stratum number of the peer  smode = source mode [SERVER | BROADCAST]. Up to three NTP entries may

be listed

 mode = operational mode [GPS | CLIENT | LOCAL]  sysIp = the system peer’s IP address  sysOffset = system peer offset

Example

SSU_2000 06-05-30 14:16:58

M 100 COMPLD

"172.16.21.19,(0.002249),(0.004485),(0.125549),1,SERVER" "172.16.21.42,(0.001745),(0.006743),(0.125640),1,SERVER" "SYS:CLIENT,172.16.21.19,(0.001997)"

;

Related Commands

Retrieve NTP Parameters, on page 82 Set NTP Parameters, on page 141

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 83

Chapter 2 TL1 Reference Retrieve Operating Mode

Retrieve Operating Mode

This command returns the Operating Mode setting for the system.

Syntax

RTRV-PRMTR-OPERMODE:[tid]::ctag;

Response Format

^^^"mode" <cr lf>

where:

mode = the signal operating mode for the shelf [NORMAL | SUBTENDING]

 The NORMAL mode means that the SSU is in normal master mode. In this

mode, the unit selects an input reference from any available input sources.

 The SUBTENDING mode means that SSU is in ANSI subtending mode. In this

mode, the unit chooses an available Composite Clock Input as an input

reference. All other inputs shall not be selected as input reference.

Related Commands

84 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Output PQL

This command returns the current value for the PQL Override function for the specified DS1, E1, or E1/2048 kHz Output module.

Syntax

RTRV-OUT-PQL:[tid]:[aid]:ctag;

Parameter Value Description

aid ALL Retrieves the current PQL override level from all modules.

SxAy Retrieves the current PQL override level from the

specified module.

Response Format

^^^"aid:pql" <cr lf>

where:

 aid = module access identifier  pql = the Priority Quality Level [0, 1-16]. If the value is 0, the PQL override

function is disabled and the output SSM is provided by the SSU-2000e’s PQL. Note: the PQL Override function is not persistent.

Related Commands

Set Output PQL, on page 143

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 85

Chapter 2 TL1 Reference Retrieve Output Status

Retrieve Output Status

This command returns the condition (current operating mode and status) of any Output module or port. This command is not valid for a Line Re-Timing Module.

Syntax

RTRV-STATUS-OUTPUT:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the status parameters from all Output modu les

Response Format

When the aid specifies a port, the response is:

^^^"aid:mstat,red,clksrc,pql,pstate" <cr lf>

in the shelf.

SxAy[-z] Retrieves the status parameters from the specified

Output module [or port].

where:

 aid = port access identifier  mstat = module status [OK | DIS | FLT]: where OK indicates normal operation,

and DIS or FLT indicate all outputs are turned off

 red = redundant [NA | SxAy]: where NA = non-redundant, and the aid = the

redundant module access identifier

 clksrc = clock which is generating the output: [CLK-A | CLK-B | CLK-C | CLK-D]  pql = possible Priority Quality Level (SSM) being generated [0 | 1 – 16], where 0

= not applicable and 1 – 16 are valid values

 pstate = port status [1 | 0 | F], where 1 = enabled, 0 = disabled, and F= faulted

When the aid specifies a module, the response is:

^^^"aid:mstat,red,clksrc,pql" <cr lf> ^^^"aid:p1,p2,p3,…p20" <cr lf>

where: The first line contains:

 aid = module access identifier  mstat = module status is [OK | DIS | FLT], where OK = normal operation, and

DIS or FLT = all outputs are turned off



red

= [NA | SxAy], where: NA = non-red undant, and SxAy = redundant module

access identifier

 clksrc = clock generating the output [CLK-A | CLK-B | CLK-C | CLK-D]

86 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Output Status

 pql = Priority Quality Level (SSM) being generated [0 | 1 – 16], where 0 = not

applicable and 1 – 16 are valid values The second line contains:

 aid = module identifier  pstate = port status [1 | 0 | F | S], where 1 = enabled, 0 = disabled, F = faulted or

S = squelched for all 20 outputs

Related Commands

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 87

Chapter 2 TL1 Reference Retrieve Password Status

Retrieve Password Status

This command is designed for application software (i.e. SynCraft) to see whether a new password is required after login. This command shall return the current status of a specified user. It is mainly used for required password changes.

Syntax

RTRV-PWD-STATE:[tid]::ctag;

Response Format

^^^"state" <cr lf>

where:

 state = [OK | EXPIRED] returns the current status of a specified user and tell the

requestor what to do next (for example, this user must change his password

since password is aged out)

Note: A "PASSWORD EXPIRED AND NEED A NEW PASSWORD" message appears on the screen in the TL1 comment field after a successful login. The user shall issue the SET-USER with PWD password command followed by the SET-PWD-CONFIRM command to confirm the changed password. If the user fails to perform this sequence, his account status will be unchanged.

Example

When a user login (ACT-USER) is successful, the application software (such as SunCraft) shall issue the RTRV-PWD-STATE command to find out if the password is aged out.

If it returns EXPIRED, the application software shall issue the following two TL1 commands back-to-back to change the password. If the application software fails to do so, the TL1 shall stay in this loop until the completion of password change.

SET-USER:[tid]::ctag::PWD,username,password;

SET-PWD-CONFIRM:[tid]::ctag::password;

88 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve Phase Build-Out Parameters

Chapter 2 TL1 Reference

Retrieve Phase Build-Out Parameters

This command returns the Phase Build-Out (PBO) settings for the SSU-2000e. All Input modules use this setting.

Syntax

RTRV-PRMTR-PBO:[tid]::ctag;

Response Format

^^^"aid:mode" <cr lf>

where:

 aid = ALL  mode = [DIS | EVT | REP | NONE]

where:

DIS indicates the PBO function has been disabled.

EVT indicates the PBO function is enabled. PBO events are displayed and stored

in the COMM module event buffer.

REP indicates the PBO function is enabled.

PBO events are displayed, but the event is not stored in the COMM module event

buffer.

NONE indicates the PBO function is enabled. The PBO event is neither displayed

nor stored in the COMM module event buffer.

Related Commands

Set Phase Build-Out Parameter, on page 147

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 89

Chapter 2 TL1 Reference Retrieve Phase Data

Retrieve Phase Data

This command returns phase data from the phase history buffers from any input port. The command requires an aid to identify the input to report data from.

Syntax

RTRV-DATA-PHASE:[tid]:aid:ctag[::tmper[,clksrc[,start][,stop]]];

Parameter Value Description

[aid] S1Ay-z Retrieves the current phase data from the specified Input

port.

[tmper] 100 |

1000 | 10000

[clksrc] CLK-A |

CLK-B

[start] {MM-DD},

{HH:MM}

[stop] {MM-DD},

{HH:MM}

Specifies the averaging time period for data to be returned: with the default of 100 if not specified

Specifies which clock supplies the phase data.

Specifies the stop date and time for data. If the date is null but followed by a time, the command default s to the current date. If the stop time is null but preceded by a date, the command defaults to the current time. If the stop date and time is null, the command defaults to the end of the data. There is one line for each data point in the specified time between start and stop times. Only the number of values currently available is returned. The maximum stored points for 100-second time period is 7000; the maximum stored points for 1000-second time period is 700; the maximum stored points for 10000-second time period is 70. If a start and stop time is not specified, the default is current value.

Response Format

^^^"aid:ocrdat,ocrtm,PHA,clksrc,tmper,(monval)" <cr lf>

where:

 aid = port access identifier  ocrdat and ocrtm are the actual date and time the data was collected  clksrc = CLK-A or CLK-B used for the measurements  tmper = time period of the measurement data, given as xSEC where x = t ime in s  monval = +/- phase values versus clock for the specified input given in

nanoseconds enclosed in parentheses

90 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Phase Data

There is one line for each data point in the specified time between start and stop times. Only the number of values currently available are returned.

Example:

SSU_2000 06-05-30 14:50:52

M 100 COMPLD

"S1A04-01:06-05-30,14-48-20,PHA,CLK-A,100,(-23)"

;

Related Commands

Set Phase Zero, on page 144 Set Phase Build-Out Parameter, on page 147

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 91

Chapter 2 TL1 Reference Retrieve Ping

Retrieve Ping

This command allows you to ping a remote host via TCP/IP. Use this command to verify that the SSU-2000e is communicating over a network.

Syntax

RTRV-PING:::ctag::ip;

Parameter Value Description

ip Specifies the host address, given in the ###.###.###.###

Response Format

The response message is COMPLD if the ping was successful or DENY (SDNR) if unsuccessful.

Related Commands

Retrieve Header , on page 65 Retrieve Name, on page 80

format, where ### is a number between 0 and 255.

92 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Reference Parameters

This command returns the current input reference port and output clock source.

Syntax

RTRV-REF:[tid]::ctag;

Response Format

^^^"port,clksrc,clockCsrc" <cr lf>

where:

 port = input reference port designated by the aid  clksrc = selected clock source [CLK-A | CLK-B | NA] for outputs  clockCsrc = an input port designated as the bypass Clock C source

Related Commands

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 93

Chapter 2 TL1 Reference Retrieve Reports

Retrieve Reports

This command returns only reports (non-alarm) information from the stored event data. An aid or aid range may be used to limit the report to specified modules. The aid code is optional. With an aid of ALL or null, all report data between start and stop time is returned.

Syntax

RTRV-EVENT-REPORT:[tid]:[aid]:ctag::[count],[start],[stop];

Parameter Value Description

[aid] ALL Retrieves all report data between the specified start and

[count] 1 – 500 Specifies the number of reports to retrieve. The default

stop time from all modules.

SxAy Retrieves report data between the specifie d sta rt and stop

time from the specified module.

count is 1.

[start] MM-DD,

HH:MM

[stop] MM-DD,

HH:MM

Response Format

One line containing the time stamp and event message is returned for each report in the log.

^^^"aid:ntfcncde,condtype,srveff,ocrdat,ocrtm:condscr" <cr lf>

where:

 aid = module access identifier  ntfcncde = Notification Code (NA)  condtype = Condition Type (event number)  srveff = service affecting flag [SA | NSA]: SA = service affecting, NSA =

non-service affecting

 ocrdat occurrence date  ocrtm = occurrence time  condstr = condition description string

94 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Example

SSU_2000 06-05-30 14:55:48

M 100 COMPLD

;

Related Commands

Retrieve Events, on page 56 Retrieve Module Alarms, on page 38

Retrieve Reports

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 95

Chapter 2 TL1 Reference Retrieve RS-422 Output Parameters

Retrieve RS-422 Output Parameters

This command returns the settings for the RS-422 Output module or port specified by the aid.

Syntax

RTRV-PRMTR-OUT422:[tid]:[aid]:ctag;

Parameter Value Description

[aid] ALL Retrieves the parameters from all RS-422 Output modules

SxAy[-z] Retrieves parameters from the specified RS-422 Output

Response Format

When the aid specifies a port, the response is:

^^^"aid:mode,bypass,fltmode,pstate,frequency"<cr lf>

in the shelf.

module [or port].

where:

 aid = port access identifier  mode = 422  bypass = allow Clock C selection: [ON | OFF]  fltmode = [ON | OFF | AUTO] if output is set to Fault if signal levels fall below th e

threshold output level

 pstate = port enabled state [ON | OFF]  frequency = [0 | 1 |...| 512] where 0 (Reserved) = 4 kHz, 1 = 8 kHz, 2 = 16 kHz ...

512 = 4096 kHz. The resolution of frequency values is 8 kHz. When the aid specifies a module, the response is:

^^^"aid:mode,bypass,fltmode"<cr lf> ^^^"aid:pstate1,pstate2,...pstate20"<cr lf> ^^^"aid:freq1,freq2,...freq20" <cr lf>

where: Line 1 contains:

 aid = module access identifier  mode = 422  bypass = [ON|OFF] for allowing Clock C selection  fltmode = [ON | OFF | AUTO] if output is set to Fault if signal levels fall below th e

threshold output level

96 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Retrieve RS-422 Output Parameters

Chapter 2 TL1 Reference

Line 2 contains:

 aid = module access identifier  pstate# = port enabled state [0 | 1] (0 is Off, 1 is On), and # is the port number

1 through 20 Line 3 contains:

 aid = module access identifier  freq# = is the output frequency [0 | 1 |...| 512] where 0 (Reserved) = 4 kHz, 1 =

8 kHz, 2 = 16 kHz...512 = 4096 kHz, and

# is the port number 1 through 20

Related Commands

Set RS-422 Output Parameters, on page 145

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 97

Chapter 2 TL1 Reference Retrieve Security Log

Retrieve Security Log

This command retrieves the max number of the last latest security log. If there is no count specified, it shall display the last latest one. The count is up to the max resource of the COMM Module in the NVRAM. If it is too big, this command automatically adjusts the number to its own maximum. The current max limit is set to 300. Note: the actual max number is limited on the NVRAM resource.

Syntax

RTRV-SECU-LOG:[tid]::ctag::[count];

Parameter Value Description

[count] [1 - 300] Retrieves the specified number of log events

Response Format

^^^"condType,ocrdat,ocrtm:condstr" <cr lf>

[null] Retrieves the most recent log event

where:

 condType = the Security Log identification number  ocrdat = occurrence date  ocrtm = occurrence time  condstr = condition description string

Example

SSU_2000 05-10-05 15:49:08

M 1 COMPLD "1,05-10-04,18-00-47:\"LOGIN,COML,ICS,ADMIN\""

"2,05-10-04,18:01:40:\"LOGIN_FAIL,COML,ICS,ADMIIN\"" "1,05-10-04,18:01:56:\"LOGIN,COML,ICS,ADMIN\"" "4,05-10-04,18:12:11:\"AUTO_LOGOUT,COML,ICS,ADMIN\"" "1,05-10-05,15:41:29:\"LOGIN,ENET,TL1,ADMIN\"" "1,05-10-05,15:48:55:\"LOGIN,COML,ICS,ADMIN\""

;

98 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Chapter 2 TL1 Reference

Retrieve Security Parameters

This command returns the settings for the security parameters.

Syntax

RTRV-PRMTR-SECU:[tid]::ctag;

Response Format

^^^"faillogin,lockout,aging" <cr lf>

where:

 faillogin = the failed login attempt threshold. If zero, user lockout function is

disabled

 lockout = the user lockout recovery timer in seconds  aging = the password aging setting in days. If zero, the aging function is disabled

Related Commands

12713140-003-2 Revision E.01 – January 2007 SSU-2000e Technical Reference 99

Chapter 2 TL1 Reference Retrieve Setup Parameters

Retrieve Setup Parameters

This command returns the current, user , or factory setting of the module specified in the command.

Syntax

RTRV-PRMTR-SETUP:[tid]:aid:ctag::which;

Parameter Value Description

which current Retur ns the cu rr en t set tin gs in th e spe cif ied mo du le.

aid SxAy[-z] Specifies the module [or port].

Response Format

The response format varies for each module.

user Returns the User settings stored in the specified module. factory Returns the Factory settings for the specified module.

For the Comms module:

^^^"PROMPT: name"<cr lf> ^^^"COML: mode,echo,eol,tout"<cr lf> ^^^"COMA: mode,echo,eol,tout"<cr lf> ^^^"COMB: mode,echo,eol,tout"<cr lf> ^^^"TELNET_TIMEOUT: tout"<cr lf> ^^^"TL1_TIMEOUT: tout"<cr lf> ^^^"TL1_KEEPALIVE: keepalive"<cr lf> ^^^"TL1_FORMAT:tl1 format"<cr lf> ^^^"PBO:pbo"<cr lf> ^^^"LOGIN_EVT_DIS:login_evt_dis"<cr lf> ^^^"ELEVATION:elevation"<cr lf> ^^^"TODSOURCE:todsource"<cr lf> ^^^"SNMP:snmp_ena"<cr lf> ^^^" SNMP_KEEPALIVE: keepalive "<cr lf> ^^^" SNMP_TRAP: trap "<cr lf>

where:

name is the Unit's name mode indicates the mode of communication {ASCII | TL1} echo indicates if the port operates in full-duplex or half-duplex {ON |

OFF} mode

eol indicates the end-of-line character to be used when the unit

transmits ASCII data {CR | LF | CRLF}

tout indicates the inactivity timeout period before the session is

logged out {value | NEVER}. Some data fields shall be left blank for Telnet parameters

keepalive is the TL1 or SNMP session timer in minutes. If timer is set to

zero indicate keep alive function is disabled for that session

100 SSU-2000e Technical Reference 12713140-003-2 Revision E.01 – January 2007

Symmetricom SSU-2000e, SDU-2000e Technical Reference

Specifications and Main Features

Frequently Asked Questions

User Manual

How to Use This Guide

Chapter 1 Overview

SSU-2000e Control Languages

Chapter 2 TL1 Reference

TL1 Command Interface

TL1 Command and Response Conventions

System Security

TL1 Retrieve Commands and Responses

Retrieve 2048 kHz Clock Output Parameters

Retrieve Alarm Cutoff

Retrieve Alarm Elevation Time

Retrieve Module Alarms

Retrieve Alarm Parameters

Retrieve Alarm Status

Retrieve All Alarms

Retrieve CC Input Parameters

Retrieve CC Output Parameters

Retrieve Clock Parameters

Retrieve Clock Status

Retrieve Communication Parameters

Retrieve Configuration

Retrieve Configuration Date

Retrieve DS1/E1 Input Parameters

Retrieve DS1/E1 Output Parameters

Retrieve E1/2048 kHz Output Parameters

Retrieve Events

Retrieve Frequency Data

Retrieve Frequency Parameters

Retrieve GPS Available Data

Retrieve GPS Data

Retrieve GPS Input Parameters

Retrieve GPS Position

Retrieve Header

Retrieve Input Data

Retrieve Input Reference

Retrieve Input Status

Retrieve Inventory

Retrieve IP Parameters

Retrieve Keep-alive Parameters

Retrieve LED

Retrieve Local Time Offset

Retrieve Login Events

Retrieve MTIE Data

Retrieve MTIE History

Retrieve MTIE Parameters

Retrieve Name

Retrieve Network Element Type

Retrieve NTP Parameters

Retrieve NTP Status

Retrieve Operating Mode

Retrieve Output PQL

Retrieve Output Status

Retrieve Password Status

Retrieve Phase Build-Out Parameters

Retrieve Phase Data

Retrieve Ping

Retrieve Reference Parameters

Retrieve Reports

Retrieve RS-422 Output Parameters

Retrieve Security Log

Retrieve Security Parameters

Retrieve Setup Parameters